redirects

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

Overview

Name	redirects
Type	Resource
Id	ovh.telephony.redirects

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
service_name	string	(wire: serviceName)
description	string
destination	string (phone-number)	Phone number
feature_type	string	All existing types of line or alias (aiAgent, carrierSip, cloudHunting, cloudIvr, conference, contactCenterSolution, contactCenterSolutionExpert, ddi, easyHunting, empty, fax, freefax, mgcp, oldConference, plugAndFax, redirect, sip, svi, voicefax, voicemail, vxml) (wire: featureType)
service_type	string	All existing types (alias, line) (wire: serviceType)

list

Redirect service

Name	Datatype	Description
service_name	string	(wire: serviceName)
description	string
destination	string (phone-number)	Phone number
feature_type	string	All existing types of line or alias (aiAgent, carrierSip, cloudHunting, cloudIvr, conference, contactCenterSolution, contactCenterSolutionExpert, ddi, easyHunting, empty, fax, freefax, mgcp, oldConference, plugAndFax, redirect, sip, svi, voicefax, voicemail, vxml) (wire: featureType)
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 redirect number
list	select	billing_account	x_pagination_mode	List redirect numbers
update	update	billing_account, service_name		Update a redirect number
change_destination	exec	billingAccount, serviceName, destination		Change the redirect destination

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

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

list

List redirect numbers

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

UPDATE examples

update

Update a redirect number

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

Lifecycle Methods

EXEC variables use wire (API) names.

change_destination

Change the redirect destination

EXEC ovh.telephony.redirects.change_destination 
@billingAccount='{{ billingAccount }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"destination": "{{ destination }}"
}'
;