Conference

The conference verb places a call into a conference.

{
  "verb": "conference",
  "name": "test",
  "beep": true,
  "startConferenceOnEnter": false,
  "waitHook": "/confWait",
  "enterHook": "/confEnter"
}

You can use the following attributes with the conference command:

Option	Description	Required
`actionHook`	A webhook to call when the conference ends.	No
`beep`	If `true`, play a beep tone to the conference when a caller enters (default: `false`).	No
`endConferenceOnExit`	If `true`, end the conference when this caller hangs up (default: `false`).	No
`enterHook`	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.	No
`joinMuted`	If `true`, this caller will join the conference with their audio muted.	No
`maxParticipants`	Maximum number of participants that will be allowed in the conference.	No
`memberTag`	A way to classify participants for the “coach” feature; see related `speakOnlyTo` attribute below (0.9.1 and above).	No
`name`	Name of the conference.	Yes
`speakOnlyTo`	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.	No
`startConferenceOnEnter`	If `true`, start the conference only when this caller enters. This also designates this caller as a moderator of the conference (default: `true`).	No
`statusHook`	A webhook to call with conference status events.	No
`statusEvents`	An array of events for which the `statusHook` should be called. See below for details.	No
`waitHook`	A webhook to retrieve commands to play or say while the caller is waiting for the conference to start.	No

—

Conference Status Events

The statusEvents attribute can include the following values:

'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 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.

Ready To Get Started?

Sign Up Today