line_records

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

Overview

Name	line_records
Type	Resource
Id	ovh.telephony.line_records

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
caller_id_name	string	The caller name of the recorded call (wire: callerIdName)
agent	string	The agent number of the recorded call
call_end	string (date-time)	The end date of the recorded call (wire: callEnd)
call_start	string (date-time)	The begin date of the recorded call (wire: callStart)
caller_id_number	string	The caller number of the recorded call (wire: callerIdNumber)
destination_number	string	The destination number of the recorded call (wire: destinationNumber)
duration	integer	The duration in seconds of the recorded call
file_url	string	The record sound url (wire: fileUrl)

list

The PABX records

Name	Datatype	Description
id	integer
caller_id_name	string	The caller name of the recorded call (wire: callerIdName)
agent	string	The agent number of the recorded call
call_end	string (date-time)	The end date of the recorded call (wire: callEnd)
call_start	string (date-time)	The begin date of the recorded call (wire: callStart)
caller_id_number	string	The caller number of the recorded call (wire: callerIdNumber)
destination_number	string	The destination number of the recorded call (wire: destinationNumber)
duration	integer	The duration in seconds of the recorded call
file_url	string	The record sound url (wire: fileUrl)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, id, service_name		Get a call recording
list	select	billing_account, service_name	x_pagination_mode	List call recordings
delete	delete	billing_account, id, service_name		Delete a call recording

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)
id	integer	Id of the object
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 call recording

SELECT
id,
caller_id_name,
agent,
call_end,
call_start,
caller_id_number,
destination_number,
duration,
file_url
FROM ovh.telephony.line_records
WHERE billing_account = '{{ billing_account }}' -- required
AND id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List call recordings

SELECT
id,
caller_id_name,
agent,
call_end,
call_start,
caller_id_number,
destination_number,
duration,
file_url
FROM ovh.telephony.line_records
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

DELETE examples

delete

Delete a call recording

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