Skip to main content

line_softphone_themes

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

Overview​

Nameline_softphone_themes
TypeResource
Idovh.telephony.line_softphone_themes

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
theme_idintegerTheme ID (wire: themeId)
colorstringTheme main color code

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectbilling_account, service_nameReturns the softphone theme of the line and its main color code.
updateupdatebilling_account, service_name, theme_idSets the softphone theme of the line from a theme identifier.
deletedeletebilling_account, service_nameDeletes the softphone theme of the line.

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.

NameDatatypeDescription
api_hoststringThe 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_accountstringThe name of your billingAccount (wire: billingAccount)
service_namestring (wire: serviceName)

SELECT examples​

Returns the softphone theme of the line and its main color code.

SELECT
theme_id,
color
FROM ovh.telephony.line_softphone_themes
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;

UPDATE examples​

Sets the softphone theme of the line from a theme identifier.

UPDATE ovh.telephony.line_softphone_themes
SET
theme_id = {{ theme_id }}
WHERE
billing_account = '{{ billing_account }}' --required
AND service_name = '{{ service_name }}' --required
AND theme_id = '{{ theme_id }}' --required
RETURNING
theme_id,
color;

DELETE examples​

Deletes the softphone theme of the line.

DELETE FROM ovh.telephony.line_softphone_themes
WHERE billing_account = '{{ billing_account }}' --required
AND service_name = '{{ service_name }}' --required
;