conference_histories

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

Overview

Name	conference_histories
Type	Resource
Id	ovh.telephony.conference_histories

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	The id of the conference history
count_connections	integer	The count of connections to the conference (wire: countConnections)
count_participants	integer	The count of unique participants of the conference (wire: countParticipants)
date_begin	string (date-time)	The date the conference began (wire: dateBegin)
date_end	string (date-time)	The date the conference end (wire: dateEnd)
duration	integer	The duration of the conference in seconds
events	array	The events of the conference (participants joining/left)
record_url	string	The audio record url if you set recording (wire: recordUrl)

list

List past conferences on your number

Name	Datatype	Description
id	integer	The id of the conference history
count_connections	integer	The count of connections to the conference (wire: countConnections)
count_participants	integer	The count of unique participants of the conference (wire: countParticipants)
date_begin	string (date-time)	The date the conference began (wire: dateBegin)
date_end	string (date-time)	The date the conference end (wire: dateEnd)
duration	integer	The duration of the conference in seconds
events	array	The events of the conference (participants joining/left)
record_url	string	The audio record url if you set recording (wire: recordUrl)

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 past conference
list	select	billing_account, service_name	date_begin.from, date_begin.to, x_pagination_mode	List past conferences

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)
date_begin.from	string (date-time)	Filter the value of dateBegin property (>=) (wire: dateBegin.from)
date_begin.to	string (date-time)	Filter the value of dateBegin property (<=) (wire: dateBegin.to)
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 past conference

SELECT
id,
count_connections,
count_participants,
date_begin,
date_end,
duration,
events,
record_url
FROM ovh.telephony.conference_histories
WHERE billing_account = '{{ billing_account }}' -- required
AND id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List past conferences

SELECT
id,
count_connections,
count_participants,
date_begin,
date_end,
duration,
events,
record_url
FROM ovh.telephony.conference_histories
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND date_begin.from = '{{ date_begin.from }}'
AND date_begin.to = '{{ date_begin.to }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;