screens

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

Overview

Name	screens
Type	Resource
Id	ovh.telephony.screens

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
service_name	string	(wire: serviceName)
incoming_screen_list	string	Type of screen list (blacklist, disabled, whitelist) (wire: incomingScreenList)
outgoing_screen_list	string	Type of screen list (blacklist, disabled, whitelist) (wire: outgoingScreenList)

list

ScreenList capable services

Name	Datatype	Description
service_name	string	(wire: serviceName)
incoming_screen_list	string	Type of screen list (blacklist, disabled, whitelist) (wire: incomingScreenList)
outgoing_screen_list	string	Type of screen list (blacklist, disabled, whitelist) (wire: outgoingScreenList)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, service_name		Get call filtering settings
list	select	billing_account	x_pagination_mode	List call filtering services
update	update	billing_account, service_name		Update call filtering settings

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)
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 call filtering settings

SELECT
service_name,
incoming_screen_list,
outgoing_screen_list
FROM ovh.telephony.screens
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List call filtering services

SELECT
service_name,
incoming_screen_list,
outgoing_screen_list
FROM ovh.telephony.screens
WHERE billing_account = '{{ billing_account }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Update call filtering settings

UPDATE ovh.telephony.screens
SET 
incoming_screen_list = '{{ incoming_screen_list }}',
outgoing_screen_list = '{{ outgoing_screen_list }}'
WHERE 
billing_account = '{{ billing_account }}' --required
AND service_name = '{{ service_name }}' --required;