conference_rooms_participants

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

Overview

Name	conference_rooms_participants
Type	Resource
Id	ovh.telephony.conference_rooms_participants

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	The id of the participant
caller_name	string	The caller name of the participant (wire: callerName)
arrival_date_time	string (date-time)	The arrival datetime of the participant in the conference. (wire: arrivalDateTime)
caller_number	string	The caller number of the participant (wire: callerNumber)
energy	integer	The current level of the participant audio transmission
floor	boolean	Whether the participant is active in the room
hear	boolean	Whether the participant can hear the conference
speak	boolean	Whether the participant can talk in the conference
talking	boolean	Whether the participant is talking

list

Conference service

Name	Datatype	Description
id	integer	The id of the participant
caller_name	string	The caller name of the participant (wire: callerName)
arrival_date_time	string (date-time)	The arrival datetime of the participant in the conference. (wire: arrivalDateTime)
caller_number	string	The caller number of the participant (wire: callerNumber)
energy	integer	The current level of the participant audio transmission
floor	boolean	Whether the participant is active in the room
hear	boolean	Whether the participant can hear the conference
speak	boolean	Whether the participant can talk in the conference
talking	boolean	Whether the participant is talking

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, id, room_number, service_name		Get a participant
list	select	billing_account, room_number, service_name	x_pagination_mode	List participants
deaf	exec	billingAccount, id, roomNumber, serviceName		Deafen a participant
energy	exec	billingAccount, id, roomNumber, serviceName, value		Change a participant audio level
kick	exec	billingAccount, id, roomNumber, serviceName		Eject a participant
mute	exec	billingAccount, id, roomNumber, serviceName		Mute a participant
undeaf	exec	billingAccount, id, roomNumber, serviceName		Undeafen a participant
unmute	exec	billingAccount, id, roomNumber, serviceName		Unmute a participant

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)
id	integer	Id of the object
roomNumber	integer	The conference room number
room_number	integer	The conference room number (wire: roomNumber)
serviceName	string
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 participant

SELECT
id,
caller_name,
arrival_date_time,
caller_number,
energy,
floor,
hear,
speak,
talking
FROM ovh.telephony.conference_rooms_participants
WHERE billing_account = '{{ billing_account }}' -- required
AND id = '{{ id }}' -- required
AND room_number = '{{ room_number }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List participants

SELECT
id,
caller_name,
arrival_date_time,
caller_number,
energy,
floor,
hear,
speak,
talking
FROM ovh.telephony.conference_rooms_participants
WHERE billing_account = '{{ billing_account }}' -- required
AND room_number = '{{ room_number }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

deaf

Deafen a participant

EXEC ovh.telephony.conference_rooms_participants.deaf 
@billingAccount='{{ billingAccount }}' --required, 
@id='{{ id }}' --required, 
@roomNumber='{{ roomNumber }}' --required, 
@serviceName='{{ serviceName }}' --required
;

energy

Change a participant audio level

EXEC ovh.telephony.conference_rooms_participants.energy 
@billingAccount='{{ billingAccount }}' --required, 
@id='{{ id }}' --required, 
@roomNumber='{{ roomNumber }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"value": {{ value }}
}'
;

kick

Eject a participant

EXEC ovh.telephony.conference_rooms_participants.kick 
@billingAccount='{{ billingAccount }}' --required, 
@id='{{ id }}' --required, 
@roomNumber='{{ roomNumber }}' --required, 
@serviceName='{{ serviceName }}' --required
;

mute

Mute a participant

EXEC ovh.telephony.conference_rooms_participants.mute 
@billingAccount='{{ billingAccount }}' --required, 
@id='{{ id }}' --required, 
@roomNumber='{{ roomNumber }}' --required, 
@serviceName='{{ serviceName }}' --required
;

undeaf

Undeafen a participant

EXEC ovh.telephony.conference_rooms_participants.undeaf 
@billingAccount='{{ billingAccount }}' --required, 
@id='{{ id }}' --required, 
@roomNumber='{{ roomNumber }}' --required, 
@serviceName='{{ serviceName }}' --required
;

unmute

Unmute a participant

EXEC ovh.telephony.conference_rooms_participants.unmute 
@billingAccount='{{ billingAccount }}' --required, 
@id='{{ id }}' --required, 
@roomNumber='{{ roomNumber }}' --required, 
@serviceName='{{ serviceName }}' --required
;