<Conference>
<Dial> a <Conference> bridge.
Join our Discord community - we're here to help.
Description
Connect the caller to a conference call. Eg, Connect a call to the conference "Room 5000":
Example
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Dial>
<Conference>Room 5000</Conference>
</Dial>
</Response>
Attributes
The content of the <Conference> noun is used for the conference name. The conference is namespaced
to the Cloudonix domain, such that any caller connecting to the conference named "Room 5000" is
connected to the same conference, while callers connecting to the same named conference in a different
Cloudonix domain will get a different conference.
If the name of the conference is not specified, the Cloudonix Platform assumes the name is "default".
The following standard Attributes are supported for conferences:
| Attribute Name | Allowed Values | Default Value |
|---|---|---|
beep | true, false, onEnter, onExit | true |
dtmf | block, pass | block |
holdMusic | true, false | true |
muted | true, false | false |
prompts | true, false | false |
startConferenceOnEnter | true, false, required | true |
endConferenceOnExit | true, false | false |
maxParticipants | positive integer (Max: 250) | 250 |
record | do-not-record or record-from-start | do-not-record |
recordingStatusCallback | relative or absolute URL | None |
recordingStatusCallbackMethod | GET, POST | POST |
recordingStatusCallbackEvent | in-progress, completed, absent | completed |
statusCallbackEvent | start, end, join, leave, mute, hold, dtmf, speaker, None | None |
statusCallback | relative or absolute URL | None |
statusCallbackMethod | GET, POST | POST |
talkDetection | normal, quick, lazy | normal |
trim | do-no-trim, trim-silence | trim-silence |
Attributes Descriptions
Attribute: beep
If set to true or onEnter, an audible notification will be played to participants
when a new participants enters the conference, after the conference has started.
If set to true or onExit, an audible notification will be played to participants when
an existing participants leaves the conference before it has ended.
Attribute: dtmf
Whether to send DTMF audio (possibly simulating DTMF audio for clients that send RFC 2833 SIP events)
to the conference. The default value of block means that DTMF signals are not propagated into the
conference (the hangupOn event would still work though), while the value of pass means that DTMF
send by the caller will be heard in the conference.
Attribute: holdMusic
When set to true (which is the default if not set), whenever there is only 1 member in the conference, the conference
will play "on hold" music to the conference. Set to false for the conference to be silent when it includes only 1 member.
Attribute: muted
If set to true, the caller is entered into the conference call muted, and cannot be
heard in the conference even after the conference starts.
Attribute: prompts
If set to true, a voice prompt will be played to participants in some situations. Currently supported are:
- Prompt for the first person in a conference call to tell them there are no other participants yet.
- Prompt for each participants entering or leaving the conference.
Attribute: startConferenceOnEnter
A conference starts (i.e. the "start" status event is sent, hold music is terminated and
all unmuted participants can talk) when at least two participants are in the conference
and at least one of them has the startConferencOnEnter set to either true of required.
If there are multiple participants in a conference where all have the startConferencOnEnter
attribute set to false, then the conference will not start (i.e. hold music will continue
and other participants are not heard).
When participants leave the conference - and assuming none of them have the endConferenceOnExit
attribute set to true - music on hold will restart if only 1 participant remains, or if
the participant leaving has the startConferenceOnEnter attribute set to required.
Attribute: endConferenceOnExit
A conference ends when either the last participant leaves, or a participant which has the
endConferenceOnExit flag set to true leaves.
If there are any other participants in the conference when a participant with the
endConferenceOnExit flag set to true leaves, then all other participants are
disconnected from the conference and their <Conference> CXML elements completes. If
there are multiple participants with the endConferenceOnExit flag set to true, then
the conference ends when the first one of them leaves the conference.
Attribute: maxParticipants
Sets the maximum number of participants allowed in the named conference.
If another participant is attempting to join the conference when it already has the maximum
number of participants, the new participant will not be entered into the conference, their
<Conference> CXML element will fail and trigger the <Dial>'s action URL.
The maxParticipants attribute is checked separately for each caller - if a caller's
<Conference> CXML element denotes a lower maxParticipants value then previous
conference participants, their call will still be rejected if the conference capacity is over
the new lower limit, even if a later participant (specifying a higher limit) will not be
rejected.
Attribute: record
Set if need to record the conference when it started or no need to record it.
Attribute: statusCallbackEvent
Specify which type of conference events to send to the URL specified by the statusCallback attribute.
If this attribute is not specified, no event reports will be sent.
The following event types are supported:
| Event Type | Events | Description |
|---|---|---|
start | conference-start | The conference has started |
end | conference-end | The conference has ended |
join | participant-join | The member has joined the conference |
leave | participant-leave | The member has left the conference |
mute | participant-mute | The member has been muted |
participant-unmute | The member has been unmuted | |
dtmf | participant-dtmf | The member has sent a DTMF signal |
speaker | participant-speech-start | The member has started talking |
participant-speech-stop | The member has stopped talking |
Attribute: statusCallback
A URL to which event reports for conference events should be sent. If this attribute is not specified (or empty), events specified will be sent to the application's document URL (if available).
Whenever a event report is sent to the statusCallback URL, the following parameters will be sent
in the URL query string (in the case of GET type requests) or in the request body's JSON object
properties (in the case of POST type requests):
| Parameter Name | Description |
|---|---|
ConferenceSid | The conference unique identifier |
FriendlyName | The conference name as specified in the CXML application |
AccountSid | The Cloudonix domain where the conference application runs |
SequenceNumber | The event sequence number that is unique to the event in the conference |
Timestamp | RFC-822 time stamp for when the event was generated |
EndConferenceOnExit | The value of the endConferenceOnExit attribute for the member |
StartConferenceOnEnter | The value of the startConferenceOnEnter` attribute for the member |
CallSid | The unique call ID for the member that originated the event |
Muted | Whether the current member is muted or not |
CallSidEndingConference | For conference-end event, the unique call ID of the member that enede the conference |
ParticipantLabelEndingConference | For conference-end event, the particiapnt label of the member that enede the conference |
ReasonConferenceEnded | For conference-end event, a code that specifies the reason the conference has ended. One of last-participant-left or participant-with-end-conference-on-exit-left |
Reason | For conference-end event, a reason text that specifies the reason the conference has ended. |
ParticipantCallStatus | For participant-leave event, a code that specifies the status of the call that has left the conference. One of completed or cancelled |
ReasonParticipantLeft | For participant-leave event, a reason text that specifies why the member left |
DTMF | For participant-dtmf event, the DTMF that was received, one of 0 to 0, # or * |
Attribute: statusCallbackMethod
The HTTP method that will be used to send event reports for conference events.
Attribute: talkDetection
Sets the sensitivity of the talking detection algorithm that is in charge of sending speaker events. The following
values are supported:
| Senseitivity | Description |
|---|---|
normal(default) | A good balance between sensitivity to talking and issuing events quickly: talking should be detectable accurately under good audio conditions while short noise bursts would be ignored. Speaker stopping would be detected when the speaker pauses for more than a second. |
quick | Will send events for speaker starting and stopping more quickly when shorter noisy or silent gaps are detected. |
lazy | will use the same noise threashold as normal, but will require silence of 2 seconds or more from the speaker to send a "stop" event. |
Attribute: trim
When recording the conference, whether to trim silence from the beginning and end of the recording. By default, the recording will be trimmed to remove silence.