The Conference Element

The Conference element is used for starting a conference and callers can then join in to talk to others connected to that room. The user can choose the name of the room. The room names are mapped to a user account, which means that two accounts with same room name will be dialing into different conferences. Maximum number of members in a single conference room is 100.

Attributes

muted boolean

To mute a member who joins a conference, set this attribute to true; the member will be able to listen to the people in the conference.

Allowed values - true, false. Defaults to false.

enterSound string

Used to play a sound when a member enters the conference. A single beep is played with beep:1 value and a double beep is played with a beep:2 value.

If a URL is specified, the URL is fetched with an HTTP POST request; the application at the URL must return an XML with Play, Speak and/or Wait elements only. All other elements are ignored.

Allowed values - "", beep:1, beep:2 or a valid URL. Defaults to "" (empty string).

exitSound string

Used to play a sound when a member exits the conference. A single beep is played with beep:1 value and a double beep is played with a beep:2 value.

If a URL is specified, the URL is fetched with an HTTP POST request; the application at the URL must return an XML with Play, Speak and/or Wait elements only. All other elements are ignored.

Allowed values - "", beep:1, beep:2 or a valid URL. Defaults to "" (empty string).

startConferenceOnEnter boolean

When a member joins the conference with this attribute set to true, the conference is started (if not already in progress).

If a member joins a conference that has not yet started, with this attribute value set to false, the member is muted and hears background music until another member joins the conference. This attribute is handy when organizing moderated conferences.

Allowed values - true, false. Defaults to true.

endConferenceOnExit boolean

If a member with this attribute set to true leaves the conference, the conference ends and all other members are automatically removed from the conference. This attribute is handy when organizing moderated conferences.

Allowed values - true, false. Defaults to false.

stayAlone boolean

If a conference has this attribute set to false, the conference will end if a member is alone in it. The default value for this attribute is true.

If a member joins the conference with the stayAlone attribute set to false, the conference will end if any member is alone in it. This attribute can change from true to false if a member joins the conference with this attribute set to false.

Once this attribute changed to false, it will not be updated to true if another member joins with the value for this attribute set to true.

Allowed values - true and false.

waitSound string

Is a remote URL fetched with HTTP POST request. The URL must return an XML document with Play, Speak and/or Wait elements only. All other elements are ignored.

The sound instructed by the XML response is played to the member while alone in the conference.

Allowed values - absolute URL. Default behaviour is that no music is played.

maxMembers integer

Indicates the maximum number of members that are to be allowed within a named conference room. This value can be any positive integer greater than 0.

When maxMembers is reached, the conference is skipped. If the next element in the XML response is the action_url this is also skipped and the call proceeds to the next element after the Conference element.

Allowed values - Any integer > 0 and <=20. Defaults to 20.

record boolean

Indicate whether the conference should be recorded.

Allowed values - true, false. Defaults to false.

recordFileFormat string

The file format for the recording.

Allowed values - mp3, wav. Defaults to mp3.

timeLimit integer

Used to set the maximum duration of the conference in seconds.

For example, a time limit of 600 seconds will automatically end the conference after ten minutes. Defaults to 0, which indicates that no time limit is set.

Allowed values - Any integer >= 0. Defaults to 0 (which indicates that no time limit is set).

hangupOnStar boolean

If set to true, this attribute lets the member exit from the conference by pressing the * key on their phone, without having to hang up. The Plivo API will continue on to the next element in the current XML document, after exit.

Allowed values - true, false. Defaults to false.

action string

Should be an absolute URL to which the API can send back parameters. See the action Request Parameters table below for more information.

Allowed values - a fully qualified URL. No default value.

method string

Method used to send HTTP request to the action URL.

Allowed values - GET, POST. Defaults to POST.

callbackUrl string

If specified, information is sent back to this URL. See the callbackUrl Request Parameters table below for more information.

Allowed values - a fully qualified URL. No default value.

callbackMethod string

Method used to send HTTP request to the callbackUrl.

Allowed values - GET, POST. Defaults to POST.

digitsMatch string

A list of digits that are sent to the callbackUrl when the digits pressed by the user match the digitsMatch parameter.

Allowed values - List of digits patterns separated by comma. No default value.

floorEvent boolean

If this attribute is set to ‘true’, send notification to callbackUrl when member is the floor holder.

Allowed values - true, false. Defaults to false.

redirect boolean

If false, do not redirect to action URL, only request the URL and continue to next element.

Allowed values - true, false. Defaults to true.

relayDTMF boolean

Transmit all digits except digitsMatch to all members of conference.

Allowed values - true, false. Defaults to true.

Note: The default number of members per conference is 100 if maxMembers is not set while starting the conference. maxMembers once set by the first member cannot be changed by other members.

Parameters sent to the action URL

ConferenceName

The conference room name.

ConferenceUUID

Unique ID of the conference.

ConferenceMemberID

Member ID in the conference

RecordUrl

URL of the recorded file. Only available if record is set to true.

RecordingID

ID of the recorded file. Only available if record is set to true.

Parameters sent to the callbackUrl

ConferenceAction
  • enter when user enters the conference
  • exit when user leaves the conference
  • digits when user presses matching digits
  • floor if user is the floor holder in the conference
  • record if conference has been recorded using record attribute.
ConferenceName

The conference room name.

ConferenceUUID

Unique ID of the conference.

ConferenceMemberID

ID of call in the conference.

Not present if ConferenceAction is record.

CallUUID

Unique identifier for this call.

Not present if ConferenceAction is record.

ConferenceDigitsMatch

The digits pattern matching when call has pressed digits.

Sent if ConferenceAction is `digits.

RecordUrl

The URL of the recorded file.

Sent if ConferenceAction is set to record attribute.

RecordingID

The ID of the recorded file.

Sent if ConferenceAction is set to record attribute.

RecordingDuration

Duration of recording in seconds.

Sent if ConferenceAction is set to record attribute. If recordSession or startOnDialAnswer is true, the duration is always -1.

RecordingDurationMs

Duration of recording in milliseconds.

Sent if ConferenceAction is set to record attribute.

RecordingStartMs

When the recording started (epoch time UTC) in milliseconds.

Sent if ConferenceAction is set to record attribute.

RecordingEndMs

When the recording ended (epoch time UTC) in milliseconds.

Sent if ConferenceAction is set to record attribute.