line_options

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

Overview

Name	line_options
Type	Resource
Id	ovh.telephony.line_options

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
tone_on_call_waiting_sound_id	integer	Sound ID of on-call-waiting tone (wire: toneOnCallWaitingSoundId)
tone_on_hold_sound_id	integer	Sound ID of on-hold tone (wire: toneOnHoldSoundId)
tone_ringback_sound_id	integer	Sound ID of ringback tone (wire: toneRingbackSoundId)
absent_subscriber	boolean	(wire: absentSubscriber)
anonymous_call_rejection	boolean	Reject anonymous calls (wire: anonymousCallRejection)
call_restriction_incoming	boolean	Whether or not the line has restriction on incoming calls (wire: callRestrictionIncoming)
call_restriction_outgoing	boolean	Whether or not the line has restriction on outgoing calls (wire: callRestrictionOutgoing)
call_waiting	boolean	If the line receives a new call and the line is already in communication, this new call is dispatched once the current call is completed (wire: callWaiting)
codecs	string	Codecs preferences
default_voicemail	string (phone-number)	The default voicemail of the line. It can be the voicemail of any line of your account. (wire: defaultVoicemail)
display_number	string (phone-number)	Phone number (wire: displayNumber)
do_not_disturb	boolean	(wire: doNotDisturb)
domain	string	The domain to configure in your SIP client.
forward_backup	boolean	Enable calls forward when the line is unavailable (wire: forwardBackup)
forward_backup_nature	string	Nature of the forward when the line is unavailable (fax, number, voicemail) (wire: forwardBackupNature)
forward_backup_number	string (phone-number)	Destination of the forward when the line is unavailable (wire: forwardBackupNumber)
forward_busy	boolean	Enable calls forward when the line is busy (wire: forwardBusy)
forward_busy_nature	string	Nature of the forward when the line is busy (fax, number, voicemail) (wire: forwardBusyNature)
forward_busy_number	string (phone-number)	Destination of the forward when the line is busy (wire: forwardBusyNumber)
forward_no_reply	boolean	Enable calls forward on no-reply (wire: forwardNoReply)
forward_no_reply_delay	integer	Delay before forward on no-reply (wire: forwardNoReplyDelay)
forward_no_reply_nature	string	Nature of the forward on no-reply (fax, number, voicemail) (wire: forwardNoReplyNature)
forward_no_reply_number	string (phone-number)	Destination of the forward on no-reply (wire: forwardNoReplyNumber)
forward_unconditional	boolean	Enable unconditional calls forward (wire: forwardUnconditional)
forward_unconditional_nature	string	Nature of the unconditional forward (fax, number, voicemail) (wire: forwardUnconditionalNature)
forward_unconditional_number	string (phone-number)	Destination of the unconditional forward (wire: forwardUnconditionalNumber)
identification_restriction	boolean	Do not display your number (wire: identificationRestriction)
intercom	string	Intercom mode: takes automatically the call with the loudspeaker (no, prefixed, yes)
ip_restrictions	array	The ip restrictions of your line (wire: ipRestrictions)
language	string	Language of the line (Dutch, English (UK), French, French (BE), German, Italian, Spanish)
lock_out_call	boolean	Disallow outgoing calls (wire: lockOutCall)
lock_out_call_password	string	Disallow outgoing calls password (wire: lockOutCallPassword)
proxy	string	The outbound proxy to configure in your SIP client.
record_outgoing_calls_beta	boolean	Enable or disable record of outgoing calls (wire: recordOutgoingCallsBeta)
voicemail_external_number	string (phone-number)	Voicemail number to dial from any other line (wire: voicemailExternalNumber)
voicemail_internal_number	string	Voicemail short number to dial from the line (wire: voicemailInternalNumber)

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 line options
update	update	billing_account, service_name		Update the line options

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)
service_name	string	(wire: serviceName)

SELECT examples

get

Get the line options

SELECT
tone_on_call_waiting_sound_id,
tone_on_hold_sound_id,
tone_ringback_sound_id,
absent_subscriber,
anonymous_call_rejection,
call_restriction_incoming,
call_restriction_outgoing,
call_waiting,
codecs,
default_voicemail,
display_number,
do_not_disturb,
domain,
forward_backup,
forward_backup_nature,
forward_backup_number,
forward_busy,
forward_busy_nature,
forward_busy_number,
forward_no_reply,
forward_no_reply_delay,
forward_no_reply_nature,
forward_no_reply_number,
forward_unconditional,
forward_unconditional_nature,
forward_unconditional_number,
identification_restriction,
intercom,
ip_restrictions,
language,
lock_out_call,
lock_out_call_password,
proxy,
record_outgoing_calls_beta,
voicemail_external_number,
voicemail_internal_number
FROM ovh.telephony.line_options
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;

UPDATE examples

update

Update the line options

UPDATE ovh.telephony.line_options
SET 
absent_subscriber = {{ absent_subscriber }},
anonymous_call_rejection = {{ anonymous_call_rejection }},
call_restriction_incoming = {{ call_restriction_incoming }},
call_restriction_outgoing = {{ call_restriction_outgoing }},
call_waiting = {{ call_waiting }},
codecs = '{{ codecs }}',
default_voicemail = '{{ default_voicemail }}',
display_number = '{{ display_number }}',
do_not_disturb = {{ do_not_disturb }},
domain = '{{ domain }}',
forward_backup = {{ forward_backup }},
forward_backup_nature = '{{ forward_backup_nature }}',
forward_backup_number = '{{ forward_backup_number }}',
forward_busy = {{ forward_busy }},
forward_busy_nature = '{{ forward_busy_nature }}',
forward_busy_number = '{{ forward_busy_number }}',
forward_no_reply = {{ forward_no_reply }},
forward_no_reply_delay = {{ forward_no_reply_delay }},
forward_no_reply_nature = '{{ forward_no_reply_nature }}',
forward_no_reply_number = '{{ forward_no_reply_number }}',
forward_unconditional = {{ forward_unconditional }},
forward_unconditional_nature = '{{ forward_unconditional_nature }}',
forward_unconditional_number = '{{ forward_unconditional_number }}',
identification_restriction = {{ identification_restriction }},
intercom = '{{ intercom }}',
ip_restrictions = '{{ ip_restrictions }}',
language = '{{ language }}',
lock_out_call = {{ lock_out_call }},
lock_out_call_password = '{{ lock_out_call_password }}',
record_outgoing_calls_beta = {{ record_outgoing_calls_beta }},
tone_on_call_waiting_sound_id = {{ tone_on_call_waiting_sound_id }},
tone_on_hold_sound_id = {{ tone_on_hold_sound_id }},
tone_ringback_sound_id = {{ tone_ringback_sound_id }}
WHERE 
billing_account = '{{ billing_account }}' --required
AND service_name = '{{ service_name }}' --required;