Skip to main content

conference_rooms_stats

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

Overview​

Nameconference_rooms_stats
TypeResource
Idovh.telephony.conference_rooms_stats

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
active_rooms_countintegerThe total numbers of rooms currently active in the conference number (wire: activeRoomsCount)
participants_countintegerThe total number of unique participants in the conference number (aggregated from all rooms) (wire: participantsCount)
rooms_countintegerThe number of rooms available in the conference number (wire: roomsCount)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectbilling_account, service_nameGet live room statistics

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.

NameDatatypeDescription
api_hoststringThe 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_accountstringThe name of your billingAccount (wire: billingAccount)
service_namestring (wire: serviceName)

SELECT examples​

Get live room statistics

SELECT
active_rooms_count,
participants_count,
rooms_count
FROM ovh.telephony.conference_rooms_stats
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;