line_softphone_devices

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

Overview

Name	line_softphone_devices
Type	Resource
Id	ovh.telephony.line_softphone_devices

Fields

The following fields are returned by SELECT queries:

list

List of softphone devices

Name	Datatype	Description
id	string	Device ID
name	string	Device name
os	string	Device operating system
update_time	string (date-time)	Last device register date (wire: updateTime)
user_agent	string	Device user agent (wire: userAgent)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	billing_account, service_name		Returns the softphone devices registered on the line: name, operating system, user agent and last registration date.
delete	delete	billing_account, device_id, service_name		Deletes a softphone device registered on the line.
disconnect	exec	billingAccount, serviceName		Disconnects every softphone device registered on 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"}})
billingAccount	string	The name of your billingAccount
billing_account	string	The name of your billingAccount (wire: billingAccount)
device_id	string	Device ID (wire: deviceId)
serviceName	string
service_name	string	(wire: serviceName)

SELECT examples

list

Returns the softphone devices registered on the line: name, operating system, user agent and last registration date.

SELECT
id,
name,
os,
update_time,
user_agent
FROM ovh.telephony.line_softphone_devices
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;

DELETE examples

delete

Deletes a softphone device registered on the line.

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

Lifecycle Methods

EXEC variables use wire (API) names.

disconnect

Disconnects every softphone device registered on the line.

EXEC ovh.telephony.line_softphone_devices.disconnect 
@billingAccount='{{ billingAccount }}' --required, 
@serviceName='{{ serviceName }}' --required
;