ovh_pabx_dialplan_extension_condition_screen_lists

Creates, updates, deletes, gets or lists an ovh_pabx_dialplan_extension_condition_screen_lists resource.

Overview

Name	ovh_pabx_dialplan_extension_condition_screen_lists
Type	Resource
Id	ovh.telephony.ovh_pabx_dialplan_extension_condition_screen_lists

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
condition_id	integer	(wire: conditionId)
caller_id_number	string	Screenlist based on the presented caller number (wire: callerIdNumber)
destination_number	string	Screenlist based on the destination number (wire: destinationNumber)
screen_list_type	string	Type of screenlist (destinationBlackList, destinationWhiteList, incomingBlackList, incomingWhiteList) (wire: screenListType)

list

Screenlist condition

Name	Datatype	Description
condition_id	integer	(wire: conditionId)
caller_id_number	string	Screenlist based on the presented caller number (wire: callerIdNumber)
destination_number	string	Screenlist based on the destination number (wire: destinationNumber)
screen_list_type	string	Type of screenlist (destinationBlackList, destinationWhiteList, incomingBlackList, incomingWhiteList) (wire: screenListType)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, condition_id, dialplan_id, extension_id, service_name		Get a filtering condition
list	select	billing_account, dialplan_id, extension_id, service_name	x_pagination_mode	List filtering conditions
create	insert	billing_account, dialplan_id, extension_id, service_name		Create a filtering condition
delete	delete	billing_account, condition_id, dialplan_id, extension_id, service_name		Delete a filtering condition

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)
condition_id	integer	(wire: conditionId)
dialplan_id	integer	(wire: dialplanId)
extension_id	integer	(wire: extensionId)
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 condition

SELECT
condition_id,
caller_id_number,
destination_number,
screen_list_type
FROM ovh.telephony.ovh_pabx_dialplan_extension_condition_screen_lists
WHERE billing_account = '{{ billing_account }}' -- required
AND condition_id = '{{ condition_id }}' -- required
AND dialplan_id = '{{ dialplan_id }}' -- required
AND extension_id = '{{ extension_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List filtering conditions

SELECT
condition_id,
caller_id_number,
destination_number,
screen_list_type
FROM ovh.telephony.ovh_pabx_dialplan_extension_condition_screen_lists
WHERE billing_account = '{{ billing_account }}' -- required
AND dialplan_id = '{{ dialplan_id }}' -- required
AND extension_id = '{{ extension_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a filtering condition

INSERT INTO ovh.telephony.ovh_pabx_dialplan_extension_condition_screen_lists (
caller_id_number,
destination_number,
screen_list_type,
billing_account,
dialplan_id,
extension_id,
service_name
)
SELECT 
'{{ caller_id_number }}',
'{{ destination_number }}',
'{{ screen_list_type }}',
'{{ billing_account }}',
'{{ dialplan_id }}',
'{{ extension_id }}',
'{{ service_name }}'
RETURNING
condition_id,
caller_id_number,
destination_number,
screen_list_type
;

Manifest

# Description fields are for documentation purposes
- name: ovh_pabx_dialplan_extension_condition_screen_lists
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the ovh_pabx_dialplan_extension_condition_screen_lists resource.
  - name: dialplan_id
    value: {{ dialplan_id }}
    description: Required parameter for the ovh_pabx_dialplan_extension_condition_screen_lists resource.
  - name: extension_id
    value: {{ extension_id }}
    description: Required parameter for the ovh_pabx_dialplan_extension_condition_screen_lists resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the ovh_pabx_dialplan_extension_condition_screen_lists resource.
  - name: caller_id_number
    value: "{{ caller_id_number }}"
    description: |
      Add a screenlist based on the presented caller number
  - name: destination_number
    value: "{{ destination_number }}"
    description: |
      Add a screenlist based on the destination number
  - name: screen_list_type
    value: "{{ screen_list_type }}"
    description: |
      Screenlist condition type
    valid_values: ['destinationBlackList', 'destinationWhiteList', 'incomingBlackList', 'incomingWhiteList']

DELETE examples

delete

Delete a filtering condition

DELETE FROM ovh.telephony.ovh_pabx_dialplan_extension_condition_screen_lists
WHERE billing_account = '{{ billing_account }}' --required
AND condition_id = '{{ condition_id }}' --required
AND dialplan_id = '{{ dialplan_id }}' --required
AND extension_id = '{{ extension_id }}' --required
AND service_name = '{{ service_name }}' --required
;