trunk_external_displayed_numbers

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

Overview

Name	trunk_external_displayed_numbers
Type	Resource
Id	ovh.telephony.trunk_external_displayed_numbers

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
created_at	string (date-time)	Creation date (wire: createdAt)
number	string (phone-number)	External displayed number linked to a trunk
status	string	Validation status (enabled, refused, toDelete, waitingValidation)
validated_at	string (date-time)	Validation date (wire: validatedAt)

list

External displayed number linked to a trunk

Name	Datatype	Description
created_at	string (date-time)	Creation date (wire: createdAt)
number	string (phone-number)	External displayed number linked to a trunk
status	string	Validation status (enabled, refused, toDelete, waitingValidation)
validated_at	string (date-time)	Validation date (wire: validatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, number, service_name		Get an external displayed number
list	select	billing_account, service_name	x_pagination_mode	List external displayed numbers
create	insert	billing_account, service_name, number		Create an external displayed number
delete	delete	billing_account, number, service_name		Delete an external displayed number
validate	exec	billingAccount, number, serviceName		Validate an external displayed number

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)
number	string (phone-number)	External displayed number linked to a trunk
serviceName	string	Name of the service
service_name	string	Name of the service (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 an external displayed number

SELECT
created_at,
number,
status,
validated_at
FROM ovh.telephony.trunk_external_displayed_numbers
WHERE billing_account = '{{ billing_account }}' -- required
AND number = '{{ number }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List external displayed numbers

SELECT
created_at,
number,
status,
validated_at
FROM ovh.telephony.trunk_external_displayed_numbers
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create an external displayed number

INSERT INTO ovh.telephony.trunk_external_displayed_numbers (
auto_validation,
number,
billing_account,
service_name
)
SELECT 
{{ auto_validation }},
'{{ number }}' /* required */,
'{{ billing_account }}',
'{{ service_name }}'
RETURNING
created_at,
number,
status,
validated_at
;

Manifest

# Description fields are for documentation purposes
- name: trunk_external_displayed_numbers
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the trunk_external_displayed_numbers resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the trunk_external_displayed_numbers resource.
  - name: auto_validation
    value: {{ auto_validation }}
    description: |
      External displayed number auto-validation. Only available for partner. Must be owner of the number.
  - name: number
    value: "{{ number }}"
    description: |
      Phone number

DELETE examples

delete

Delete an external displayed number

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

Lifecycle Methods

EXEC variables use wire (API) names.

validate

Validate an external displayed number

EXEC ovh.telephony.trunk_external_displayed_numbers.validate 
@billingAccount='{{ billingAccount }}' --required, 
@number='{{ number }}' --required, 
@serviceName='{{ serviceName }}' --required
;