Conference

1 {
2   "verb": "conference",
3   "name": "test",
4   "beep": true,
5   "startConferenceOnEnter": false,
6   "waitHook": "/confWait",
7   "enterHook": "/confEnter"   
8 },

Parameters

name

stringRequired

name of the conference

actionHook

string

A webhook to call when the conference ends

beep

boolean

if true, play a beep tone to the conference when caller enters (default: false)

endConferenceOnExit

boolean

if true, end the conference when this caller hangs up (default: false)

enterHook

string

A webhook to retrieve something to play or say to the caller just before they are put into a conference after waiting for it to start

joinMuted

boolean

if true, this caller will join the conference with their audio muted

maxParticipants

number

maximum number of participants that will be allowed in the conference

memberTag

string

a way to classify participants for the “coach” feature; see related speakOnlyTo attribute below (0.9.1 and above)

speakOnlyTo

string

a tag value that will cause this member’s audio to be heard only by members that were assigned that tag; see this article for details

startConferenceOnEnter

boolean

if true, start the conference only when this caller enters. This also designates this caller as a moderator of the conference (default: true)

statusHook

string

A webhook to call with conference status events

statusEvents

array

An array of events for which the statusHook should be called. See below for details.

waitHook

string

A webhook to retrieve commands to play or say while the caller is waiting for the conference to start

Conference Status Events

‘start’: the conference has started
‘end’: the conference has ended
‘join’: a participant has joined the conference
‘leave’: a participant has left the conference
‘start-talking’: a participant started speaking
‘end-talking’: a participant stopped talking

Conference Status Webhook Parameters

Conference status webhooks will contain the following additional parameters:

conferenceSid: a unique identifier for the conference
friendlyName: the name of the conference as specified in the application
event: the conference event being reported (e.g. “join”)
time: the time of the event in ISO format (e.g. “2020-04-27T13:44:17.336Z”)
members: the current number of members in the conference
duration: the current length of the conference in seconds