trunks

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

Overview

Name	trunks
Type	Resource
Id	ovh.telephony.trunks

Fields

The following fields are returned by SELECT queries:

get_by_service_name

successful operation

Name	Datatype	Description
service_name	string	Name of the service (wire: serviceName)
description	string	Description of the service
service_type	string	Type of the service (alias, line) (wire: serviceType)

get

successful operation

Name	Datatype	Description
service_name	string	(wire: serviceName)
iam	object	IAM resource metadata

list_by_billing_account

Trunk service

Name	Datatype	Description
service_name	string	Name of the service (wire: serviceName)
description	string	Description of the service
service_type	string	Type of the service (alias, line) (wire: serviceType)

list

Telephony service

Name	Datatype	Description
service_name	string	(wire: serviceName)
iam	object	IAM resource metadata

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_service_name	select	billing_account, service_name		Get a trunk
get	select	service_name		Get a line or trunk
list_by_billing_account	select	billing_account	x_pagination_mode	List trunks
list	select		iam_tags, x_pagination_mode	List trunks
change_contact	exec	serviceName		Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.

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)
serviceName	string	Your trunk number
service_name	string	Your trunk number (wire: serviceName)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
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_by_service_name

Get a trunk

SELECT
service_name,
description,
service_type
FROM ovh.telephony.trunks
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;

get

Get a line or trunk

SELECT
service_name,
iam
FROM ovh.telephony.trunks
WHERE service_name = '{{ service_name }}' -- required
;

list_by_billing_account

List trunks

SELECT
service_name,
description,
service_type
FROM ovh.telephony.trunks
WHERE billing_account = '{{ billing_account }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

list

List trunks

SELECT
service_name,
iam
FROM ovh.telephony.trunks
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_contact

Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.

EXEC ovh.telephony.trunks.change_contact 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"contactAdmin": "{{ contactAdmin }}", 
"contactBilling": "{{ contactBilling }}", 
"contactTech": "{{ contactTech }}"
}'
;