line_tones

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

Overview

Name	line_tones
Type	Resource
Id	ovh.telephony.line_tones

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
call_waiting	string	Tone played when caller is waiting in queue (Custom sound, None) (wire: callWaiting)
end_call	string	Tone played when callee is ending call (Custom sound, None) (wire: endCall)
on_hold	string	Tone played when caller is put on hold (Custom sound, None, Predefined 1, Predefined 2) (wire: onHold)
ringback	string	Ringback tone (Custom sound, None)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, service_name		Get the tones
update	update	billing_account, service_name		Update the tones
tone_upload	exec	billingAccount, serviceName, type		Upload a tone

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)

SELECT examples

get

Get the tones

SELECT
call_waiting,
end_call,
on_hold,
ringback
FROM ovh.telephony.line_tones
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;

UPDATE examples

update

Update the tones

UPDATE ovh.telephony.line_tones
SET 
call_waiting = '{{ call_waiting }}',
end_call = '{{ end_call }}',
on_hold = '{{ on_hold }}',
ringback = '{{ ringback }}'
WHERE 
billing_account = '{{ billing_account }}' --required
AND service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

tone_upload

Upload a tone

EXEC ovh.telephony.line_tones.tone_upload 
@billingAccount='{{ billingAccount }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"documentId": "{{ documentId }}", 
"type": "{{ type }}", 
"url": "{{ url }}"
}'
;