line_softphone_themes
Creates, updates, deletes, gets or lists a line_softphone_themes resource.
Overview​
| Name | line_softphone_themes |
| Type | Resource |
| Id | ovh.telephony.line_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 |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | billing_account, service_name | Returns the softphone theme of the line and its main color code. | |
update | update | billing_account, service_name, theme_id | Sets the softphone theme of the line from a theme identifier. | |
delete | delete | billing_account, service_name | Deletes 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.
| 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
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​
- update
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​
- delete
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
;