carrier_sip_vno_ranges

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

Overview

Name	carrier_sip_vno_ranges
Type	Resource
Id	ovh.telephony.carrier_sip_vno_ranges

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
description	string	The carrier SIP trunk description.
prefix	string	The phone range prefix.

list

Carrier SIP VNO range

Name	Datatype	Description
description	string	The carrier SIP trunk description.
prefix	string	The phone range prefix.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, contract_reference, prefix, service_name		Get a number range
list	select	billing_account, contract_reference, service_name	x_pagination_mode	List mandate number ranges
update	update	billing_account, contract_reference, prefix, service_name		Update a number range

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)
contract_reference	string	The reference written on your VNO contract. (wire: contractReference)
prefix	string	The phone range prefix.
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 number range

SELECT
description,
prefix
FROM ovh.telephony.carrier_sip_vno_ranges
WHERE billing_account = '{{ billing_account }}' -- required
AND contract_reference = '{{ contract_reference }}' -- required
AND prefix = '{{ prefix }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List mandate number ranges

SELECT
description,
prefix
FROM ovh.telephony.carrier_sip_vno_ranges
WHERE billing_account = '{{ billing_account }}' -- required
AND contract_reference = '{{ contract_reference }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Update a number range

UPDATE ovh.telephony.carrier_sip_vno_ranges
SET 
description = '{{ description }}'
WHERE 
billing_account = '{{ billing_account }}' --required
AND contract_reference = '{{ contract_reference }}' --required
AND prefix = '{{ prefix }}' --required
AND service_name = '{{ service_name }}' --required;