softphone_themes

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

Overview

Name	softphone_themes
Type	Resource
Id	ovh.telephony.softphone_themes

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
theme_id	integer	Theme ID (wire: themeId)
color	string	Theme main color code

get_by_billing_account

successful operation

Name	Datatype	Description
theme_id	integer	Theme ID (wire: themeId)
color	string	Theme main color code

list

Softphone theme information

Name	Datatype	Description
theme_id	integer	Theme ID (wire: themeId)
color	string	Theme main color code

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	theme_id		Returns the softphone theme and its main color code.
get_by_billing_account	select	billing_account		Returns the softphone theme of the billing account and its main color code.
list	select		x_pagination_mode	Returns the identifiers of the available softphone themes.
update	update	billing_account, theme_id		Sets the softphone theme of the billing account from a theme identifier.

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)
theme_id	integer	Theme ID (wire: themeId)
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

Returns the softphone theme and its main color code.

SELECT
theme_id,
color
FROM ovh.telephony.softphone_themes
WHERE theme_id = '{{ theme_id }}' -- required
;

get_by_billing_account

Returns the softphone theme of the billing account and its main color code.

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

list

Returns the identifiers of the available softphone themes.

SELECT
theme_id,
color
FROM ovh.telephony.softphone_themes
WHERE x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Sets the softphone theme of the billing account from a theme identifier.

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