Conference

Conference

The <Conference> noun lets you connect to a conference room and talk to the other participants who have joined the same room.

Customizations

The name of the room is up to you and is namespaced to your account. This means that every caller who attempt to join your conference room (e.g. 1234) via your account will end up in the same room as you. Callers trying to join from a different account would not be connected.

The following list of conference rooms features can be enabled or disabled based on your preference. By default, they are all enabled.

  • A conference won’t start until at least two participants join the room.

  • While waiting, customizable background music is played.

  • When participants join and leave the room, notification sounds are played to inform the rest of the participants.

Conference Attributes

Name Allowed Values Default Value

muted

true, false

false

beep

true, false

true

beepUrl

The wav file’s relative or absolute URL

Default beep sound will be played on entry and exit.

startConferenceOnEnter

true, false

true

endConferenceOnExit

true, false

false

waitUrl

RCML URL, empty string

Default CPaaS music on hold.

waitMethod

GET or POST

POST

maxParticipants

positive integer ⇐ 40

40

  • muted. The muted attribute lets you specify whether a participant can speak in the conference. 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 when a participant joins or leaves the room.

  • beepUrl. The beepUrl attribute lets you specify a wav file which will be played as a notification beep in the conference when a participant joins or leaves the room. If no 'beepUrl' attribute is specified then default beep tone will be played. There is a restrition for this functionality: RCML file for all participants of the same conference must contain same or no 'beepUrl' value.

  • startConferenceOnEnter. This attribute tells a 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', then 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> verbs for content. This 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, CPaaS will only process <Play>, <Say>, and <Redirect> verbs. If you do not wish anything to play while waiting for the conference to start, specify the empty string (set 'waitUrl' to '').

  • 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 CPaaS 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.

Examples

or an example of how to use the <Conference> noun see below.

<Response>
    <Dial>
    <Conference>1234</Conference>
    </Dial>
</Response>

Music on hold for conference

By default CPaaS 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.

Conference Music On Hold

# First Participant Music Second Participant Music

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

4

moderator

play music on hold

moderator

stop music on hold

  • Moderator participant is the call with startConferenceOnEnter=true

  • Not a moderator participant is the call with startConferenceOnEnter=false