line_phone_function_keys

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

Overview

Name	line_phone_function_keys
Type	Resource
Id	ovh.telephony.line_phone_function_keys

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
default	string	The default function used by the key
function	string	The function active on the key
key_num	integer	The number of the function key (wire: keyNum)
label	string	The key label
parameter	string	The function parameter
type	string	The key type

list

Plug & Phone function key

Name	Datatype	Description
default	string	The default function used by the key
function	string	The function active on the key
key_num	integer	The number of the function key (wire: keyNum)
label	string	The key label
parameter	string	The function parameter
type	string	The key type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, key_num, service_name		Get a function key
list	select	billing_account, service_name	x_pagination_mode	List function keys
update	update	billing_account, key_num, service_name		Update a function key

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)
key_num	integer	The number of the function key (wire: keyNum)
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 function key

SELECT
default,
function,
key_num,
label,
parameter,
type
FROM ovh.telephony.line_phone_function_keys
WHERE billing_account = '{{ billing_account }}' -- required
AND key_num = '{{ key_num }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List function keys

SELECT
default,
function,
key_num,
label,
parameter,
type
FROM ovh.telephony.line_phone_function_keys
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Update a function key

UPDATE ovh.telephony.line_phone_function_keys
SET 
function = '{{ function }}',
parameter = '{{ parameter }}'
WHERE 
billing_account = '{{ billing_account }}' --required
AND key_num = '{{ key_num }}' --required
AND service_name = '{{ service_name }}' --required;