<Conference> element connects a caller to a conference room. Multiple callers joining the same conference name are connected together. Maximum participants per conference: 20.
For role-based multi-party calls with coaching, individual hold/mute, and AI agent support, see Multi-party Call.
Basic Usage
Conference Attributes
Basic Settings
| Attribute | Type | Default | Description |
|---|---|---|---|
muted | boolean | false | Join muted (can still hear others) |
enterSound | string | "" | Sound on entry: beep:1, beep:2, or URL |
exitSound | string | "" | Sound on exit: beep:1, beep:2, or URL |
maxMembers | integer | 20 | Maximum participants (1-20) |
timeLimit | integer | 86400 | Max conference duration in seconds |
hangupOnStar | boolean | false | Let member exit by pressing * |
stayAlone | boolean | true | End conference if only one member |
Moderation
| Attribute | Type | Default | Description |
|---|---|---|---|
startConferenceOnEnter | boolean | true | Start conference when this member joins |
endConferenceOnExit | boolean | false | End conference when this member leaves |
waitSound | URL | - | Audio to play while waiting for conference to start |
Recording
| Attribute | Type | Default | Description |
|---|---|---|---|
record | boolean | false | Record the conference |
recordFileFormat | string | mp3 | Recording format (mp3, wav) |
transcriptionType | string | - | Transcription type. Values: auto, hybrid, manual |
transcriptionUrl | URL | - | URL to receive transcription |
transcriptionMethod | string | POST | HTTP method for sending transcription results to transcriptionUrl. Values: GET, POST |
Callbacks
| Attribute | Type | Default | Description |
|---|---|---|---|
action | URL | - | URL called when member leaves |
method | string | POST | HTTP method for action |
callbackUrl | URL | - | URL for conference events |
callbackMethod | string | POST | HTTP method for callback |
redirect | boolean | true | Redirect to action URL |
DTMF
| Attribute | Type | Default | Description |
|---|---|---|---|
digitsMatch | string | - | DTMF patterns to report |
floorEvent | boolean | false | Notify when member becomes floor-holder |
relayDTMF | boolean | true | Transmit DTMF to all members |
Examples
Join Muted
Add participants who can listen but not speak:Entry/Exit Sounds
Play beeps when participants join or leave:Play, Speak, or Wait elements.
Moderated Conference
Create a “waiting room” where participants wait for the moderator: Participant XML:Record Conference
With Transcription
Exit with Action URL
Bridge Two Callers
Use conferences to connect two incoming callers: First Caller:Callback Parameters
Conference Action URL Parameters
Sent when a member leaves the conference:| Parameter | Description |
|---|---|
ConferenceName | Name of the conference |
ConferenceUUID | Unique conference identifier |
ConferenceMemberID | Member’s ID in the conference |
RecordUrl | Recording URL (if recorded) |
RecordingID | Recording identifier |
Conference Callback URL Parameters
Sent for conference events:| Parameter | Description |
|---|---|
ConferenceAction | enter, exit, digits, floor, record |
ConferenceName | Conference name |
ConferenceUUID | Conference identifier |
ConferenceMemberID | Member ID |
CallUUID | Call identifier |
ConferenceDigitsMatch | Matched digits (when ConferenceAction=digits) |
RecordUrl | Recording URL (when ConferenceAction=record) |
RecordingID | Recording ID |
RecordingDuration | Duration in seconds |
RecordingDurationMs | Duration in milliseconds |
RecordingStartMs | Start time (epoch ms) |
RecordingEndMs | End time (epoch ms) |
Transcription URL Parameters
| Parameter | Description |
|---|---|
transcription | Transcribed text |
transcription_charge | Cost of transcription |
transcription_rate | Rate per minute |
duration | Recording duration |
call_uuid | Call identifier |
recording_id | Recording identifier |
error | Error message (if any) |
Related
- Multi-party Call — Role-based calls with coaching, AI agents, and advanced controls
- Recording — Record calls
- Call Routing — Dial, Redirect, Hangup