Conference
The <Conference> noun allows you to connect to a named conference room and talk to the other participants who have joined the same room. The name of the room is up to you and is namespaced to your account.

Conference Attributes

Name
Allowed Values
Default Value
name
String
none
muted
true, false
false
beep
true, false
true
startConferenceOnEnter
true, false
true
endConferenceOnExit
true, false
false
waitUrl
RCML url, empty string
default calls.teleapi hold music
waitMethod
GET or POST
POST
maxParticipants
positive integer ⇐ 40
40
Name. The 'name' attribute allows you to inform the conference name for a video call. This attribute should be used only when <Video> noun is nested, otherwise the conference name should be informed as value of the tag <Conference>.
Conference name without <Video> noun nesting:
1
<Conference>1112</Conference>
Copied!
Conference name with <Video> noun nesting:
1
<Conference name="alice"><Video enable=”true”></Conference>
Copied!
Muted. The 'muted' attribute lets you specify whether a participant can speak in the conference room . If this attribute is set to 'true', the participant will only be able to listen to people in the room.
Beep. The 'beep' attribute lets you specify whether a notification beep is played in the conference room when a participant joins or leaves the room.
startConferenceOnEnter. This attribute tells the conference to start when this participant joins the conference, if it is not already started. If this is false and the participant joins a conference that has not started, they are muted and hear background music until a participant joins where startConferenceOnEnter is true. This is useful for implementing moderated conferences.
endConferenceOnExit. If a participant has this attribute set to 'true', when that participant leaves, the conference ends and all other participants drop out. This is useful for implementing moderated conferences that bridge two calls and allow either call leg to continue executing RCML if the other hangs up.
waitUrl. The 'waitUrl' attribute lets you specify a URL for music that plays before the conference has started. The URL may be a WAV or a RCML document that uses <Play> or <Say> for content. This attribute defaults to a selection of Creative Commons licensed background music, but you can replace it with your own music and messages. If the 'waitUrl' responds with RCML, calls.teleapi will only process <Play>, <Say>, and <Redirect> verbs. If you do not wish to play any music while waiting for the conference to start, specify an empty string (“”).
waitMethod. This attribute indicates which HTTP method to use when requesting 'waitUrl'. It defaults to 'POST'. Be sure to use 'GET' if you are directly requesting static audio files such as WAV files so that calls.teleapi properly caches the files.
maxParticipants. This attribute indicates the maximum number of participants you want to allow within a named conference room. The default maximum number of participants is 40. The value must be a positive integer less than or equal to 100.

Example

1
<Response>
2
<Dial>
3
<Conference>1234</Conference>
4
</Dial>
5
</Response>
Copied!

Music on hold for conference

By default calls.teleapi will play music on hold for the first participant while waiting for the others to join. This feature can be disabled if needed.
The following table provides a description on how this feature works.
#
First Participant
Music
Second Participant
Music
4
moderator
play music on hold
moderator
stop music on hold
1
not a moderator
play music on hold
not a moderator
continue playing music on hold
2
not a moderator
play music on hold
moderator
stop music on hold
3
moderator
play music on hold
not a moderator
stop music on hold
Moderator participant is the call with startConferenceOnEnter=true
Participant (not a moderator) is the call with startConferenceOnEnter=false
Last modified 1yr ago