rsvas

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

Overview

Name	rsvas
Type	Resource
Id	ovh.telephony.rsvas

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
service_name	string	(wire: serviceName)
typology	string	Special number category (access, announced, conferencing, contentsAuto, contentsManual, directory, games, linking, m2m, relationship)

list

French value added services subject to the RSVA reform (Référentiel des numéros SVA)

Name	Datatype	Description
service_name	string	(wire: serviceName)
typology	string	Special number category (access, announced, conferencing, contentsAuto, contentsManual, directory, games, linking, m2m, relationship)

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 premium rate number
list	select	billing_account	x_pagination_mode	List premium rate numbers
update	update	billing_account, service_name		Update a premium rate number
cancel_scheduled_rate_code	exec	billingAccount, serviceName		Cancel the scheduled rate code
schedule_rate_code	exec	billingAccount, serviceName, rateCode		Schedule a rate code

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 premium rate number

SELECT
service_name,
typology
FROM ovh.telephony.rsvas
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List premium rate numbers

SELECT
service_name,
typology
FROM ovh.telephony.rsvas
WHERE billing_account = '{{ billing_account }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Update a premium rate number

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

Lifecycle Methods

EXEC variables use wire (API) names.

cancel_scheduled_rate_code

Cancel the scheduled rate code

EXEC ovh.telephony.rsvas.cancel_scheduled_rate_code 
@billingAccount='{{ billingAccount }}' --required, 
@serviceName='{{ serviceName }}' --required
;

schedule_rate_code

Schedule a rate code

EXEC ovh.telephony.rsvas.schedule_rate_code 
@billingAccount='{{ billingAccount }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"rateCode": "{{ rateCode }}"
}'
;