numbers

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

Overview

Name	numbers
Type	Resource
Id	ovh.telephony.numbers

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
service_name	string	Name of the service (wire: serviceName)
description	string	Description of the service
feature_type	string	Feature enabled on the number (aiAgent, carrierSip, cloudHunting, cloudIvr, conference, contactCenterSolution, contactCenterSolutionExpert, ddi, easyHunting, empty, fax, freefax, mgcp, oldConference, plugAndFax, redirect, sip, svi, voicefax, voicemail, vxml) (wire: featureType)
part_of_pool	string	Parent of the service (if it is part of a pool) (wire: partOfPool)
service_type	string	All existing types (alias, line) (wire: serviceType)

list

Additional number

Name	Datatype	Description
service_name	string	Name of the service (wire: serviceName)
description	string	Description of the service
feature_type	string	Feature enabled on the number (aiAgent, carrierSip, cloudHunting, cloudIvr, conference, contactCenterSolution, contactCenterSolutionExpert, ddi, easyHunting, empty, fax, freefax, mgcp, oldConference, plugAndFax, redirect, sip, svi, voicefax, voicemail, vxml) (wire: featureType)
part_of_pool	string	Parent of the service (if it is part of a pool) (wire: partOfPool)
service_type	string	All existing types (alias, line) (wire: serviceType)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, service_name		Get a number
list	select	billing_account	x_pagination_mode	List numbers
update	update	billing_account, service_name		Update a number
cancel_convert_to_line	exec	billingAccount, serviceName		Cancel a scheduled conversion to line
change_feature_type	exec	billingAccount, serviceName, featureType		Change the number feature type
convert_to_line	exec	billingAccount, serviceName, offer		Schedule a conversion to line

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	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 a number

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

list

List numbers

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

UPDATE examples

update

Update a number

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

Lifecycle Methods

EXEC variables use wire (API) names.

cancel_convert_to_line

Cancel a scheduled conversion to line

EXEC ovh.telephony.numbers.cancel_convert_to_line 
@billingAccount='{{ billingAccount }}' --required, 
@serviceName='{{ serviceName }}' --required
;

change_feature_type

Change the number feature type

EXEC ovh.telephony.numbers.change_feature_type 
@billingAccount='{{ billingAccount }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"featureType": "{{ featureType }}"
}'
;

convert_to_line

Schedule a conversion to line

EXEC ovh.telephony.numbers.convert_to_line 
@billingAccount='{{ billingAccount }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"offer": "{{ offer }}"
}'
;