fax_screen_lists

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

Overview

Name	fax_screen_lists
Type	Resource
Id	ovh.telephony.fax_screen_lists

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
service_name	string	(wire: serviceName)
blacklisted_numbers	array	List of numbers not allowed to send a fax (wire: blacklistedNumbers)
blacklisted_tsi	array	List of logins (TSI or ID) not allowed to send a fax (wire: blacklistedTSI)
call_number	string	Number of the fax service (wire: callNumber)
country_code	string	Country code of the fax service (wire: countryCode)
filtering_list	string	Which list is active (blackist, whitelist or none) (, blacklist, no, whitelist) (wire: filteringList)
whitelisted_numbers	array	List of numbers allowed to send a fax (wire: whitelistedNumbers)
whitelisted_tsi	array	List of logins (TSI or ID) allowed to send a fax (wire: whitelistedTSI)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, service_name		Get the screen lists. Returns the numbers and logins (TSI) allowed or blocked from sending faxes to the service, and which list is active.
create	insert	billing_account, service_name		Create the screen lists. Creates the screen lists of the fax service. The active list is whitelist, blacklist or none.
update	update	billing_account, service_name		Update the screen lists. Updates the allowed and blocked numbers and logins (TSI). The active list is chosen when the screen lists are created.
delete	delete	billing_account, service_name		Delete the screen lists. Deletes all screen lists of the fax service: allowed and blocked numbers and logins (TSI).
reset	exec	billingAccount, serviceName		Reset the screen lists. Empties the selected screen lists: allowed or blocked numbers, allowed or blocked logins.

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"}})
billingAccount	string	The name of your billingAccount
billing_account	string	The name of your billingAccount (wire: billingAccount)
serviceName	string
service_name	string	(wire: serviceName)

SELECT examples

get

Get the screen lists. Returns the numbers and logins (TSI) allowed or blocked from sending faxes to the service, and which list is active.

SELECT
service_name,
blacklisted_numbers,
blacklisted_tsi,
call_number,
country_code,
filtering_list,
whitelisted_numbers,
whitelisted_tsi
FROM ovh.telephony.fax_screen_lists
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Create the screen lists. Creates the screen lists of the fax service. The active list is whitelist, blacklist or none.

INSERT INTO ovh.telephony.fax_screen_lists (
blacklisted_numbers,
blacklisted_tsi,
filtering_list,
whitelisted_numbers,
whitelisted_tsi,
billing_account,
service_name
)
SELECT 
'{{ blacklisted_numbers }}',
'{{ blacklisted_tsi }}',
'{{ filtering_list }}',
'{{ whitelisted_numbers }}',
'{{ whitelisted_tsi }}',
'{{ billing_account }}',
'{{ service_name }}'
RETURNING
service_name,
blacklisted_numbers,
blacklisted_tsi,
call_number,
country_code,
filtering_list,
whitelisted_numbers,
whitelisted_tsi
;

Manifest

# Description fields are for documentation purposes
- name: fax_screen_lists
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the fax_screen_lists resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the fax_screen_lists resource.
  - name: blacklisted_numbers
    value:
      - "{{ blacklisted_numbers }}"
    description: |
      List of numbers not allowed to send a fax
  - name: blacklisted_tsi
    value:
      - "{{ blacklisted_tsi }}"
    description: |
      List of logins (TSI or ID) not allowed to send a fax
  - name: filtering_list
    value: "{{ filtering_list }}"
    description: |
      Which list is active (blackist, whitelist or none)
    valid_values: ['', 'blacklist', 'no', 'whitelist']
  - name: whitelisted_numbers
    value:
      - "{{ whitelisted_numbers }}"
    description: |
      List of numbers allowed to send a fax
  - name: whitelisted_tsi
    value:
      - "{{ whitelisted_tsi }}"
    description: |
      List of logins (TSI or ID) allowed to send a fax

UPDATE examples

update

Update the screen lists. Updates the allowed and blocked numbers and logins (TSI). The active list is chosen when the screen lists are created.

UPDATE ovh.telephony.fax_screen_lists
SET 
blacklisted_numbers = '{{ blacklisted_numbers }}',
blacklisted_tsi = '{{ blacklisted_tsi }}',
whitelisted_numbers = '{{ whitelisted_numbers }}',
whitelisted_tsi = '{{ whitelisted_tsi }}'
WHERE 
billing_account = '{{ billing_account }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Delete the screen lists. Deletes all screen lists of the fax service: allowed and blocked numbers and logins (TSI).

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

Lifecycle Methods

EXEC variables use wire (API) names.

reset

Reset the screen lists. Empties the selected screen lists: allowed or blocked numbers, allowed or blocked logins.

EXEC ovh.telephony.fax_screen_lists.reset 
@billingAccount='{{ billingAccount }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"blacklistedNumbers": {{ blacklistedNumbers }}, 
"blacklistedTSI": {{ blacklistedTSI }}, 
"whitelistedNumbers": {{ whitelistedNumbers }}, 
"whitelistedTSI": {{ whitelistedTSI }}
}'
;