screen_screen_lists

Creates, updates, deletes, gets or lists a screen_screen_lists resource.

Overview

Name	screen_screen_lists
Type	Resource
Id	ovh.telephony.screen_screen_lists

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
call_number	string	(wire: callNumber)
nature	string	Nature of screen list (fax, international, services, special, voicemail)
status	string
type	string	Type of screen list (incomingBlackList, incomingWhiteList, outgoingBlackList, outgoingWhiteList)

list

Screen list

Name	Datatype	Description
id	integer
call_number	string	(wire: callNumber)
nature	string	Nature of screen list (fax, international, services, special, voicemail)
status	string
type	string	Type of screen list (incomingBlackList, incomingWhiteList, outgoingBlackList, outgoingWhiteList)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, id, service_name		Get a filtering rule
list	select	billing_account, service_name	x_pagination_mode	List filtering rules
create	insert	billing_account, service_name, nature, type		Create a filtering rule
delete	delete	billing_account, id, service_name		Delete a filtering rule

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
billing_account	string	The name of your billingAccount (wire: billingAccount)
id	integer	Id of the object
service_name	string	(wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a filtering rule

SELECT
id,
call_number,
nature,
status,
type
FROM ovh.telephony.screen_screen_lists
WHERE billing_account = '{{ billing_account }}' -- required
AND id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List filtering rules

SELECT
id,
call_number,
nature,
status,
type
FROM ovh.telephony.screen_screen_lists
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a filtering rule

INSERT INTO ovh.telephony.screen_screen_lists (
call_number,
nature,
type,
billing_account,
service_name
)
SELECT 
'{{ call_number }}',
'{{ nature }}' /* required */,
'{{ type }}' /* required */,
'{{ billing_account }}',
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: screen_screen_lists
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the screen_screen_lists resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the screen_screen_lists resource.
  - name: call_number
    value: "{{ call_number }}"
    description: |
      The callNumber of the generic screen list
  - name: nature
    value: "{{ nature }}"
    description: |
      The nature of the generic screen list
    valid_values: ['fax', 'international', 'services', 'special', 'voicemail']
  - name: type
    value: "{{ type }}"
    description: |
      The type of the generic screen list
    valid_values: ['incomingBlackList', 'incomingWhiteList', 'outgoingBlackList', 'outgoingWhiteList']

DELETE examples

delete

Delete a filtering rule

DELETE FROM ovh.telephony.screen_screen_lists
WHERE billing_account = '{{ billing_account }}' --required
AND id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required
;