Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

Room nameThe text content of the <Conference> element is the room name. All callers placed into the same room name are bridged together. Room names are case-sensitive.

​
Attributes

AttributeDescription
muted
boolean		If true, the participant joins the conference muted and cannot be heard by others until unmuted.
Default: false
beep
boolean		If true, a beep plays to all participants when someone joins or leaves the conference.
Default: true
startConferenceOnEnter
boolean		If true, the conference starts and hold music stops when this participant enters. Set to false for participants who should wait in hold until the moderator arrives.
Default: true
endConferenceOnExit
boolean		If true, the conference ends and all other participants are disconnected when this participant leaves. Useful for moderator-controlled conferences.
Default: false
maxParticipants
integer		Maximum number of participants allowed in the conference. Callers beyond this limit are rejected.
Allowed values: positive integer
Default: 200
waitSound
string		URL of audio to play to the participant while they wait for the conference to start (i.e. while startConferenceOnEnter is false for them). Vobiz fetches this URL via POST and expects XML with <Play>, <Speak>, or <Wait> elements.
Allowed values: a fully qualified URL
waitMethod
string		HTTP method used to fetch waitSound.
Allowed values: GET, POST
Default: POST
callbackUrl
string		URL notified on conference lifecycle events: participant enter, participant exit, conference start, and conference end. See Conference Callbacks for the full parameter list.
Allowed values: a fully qualified URL
callbackMethod
string		HTTP method used to notify callbackUrl.
Allowed values: GET, POST
Default: POST
record
boolean		If true, the entire conference is recorded. The recording URL is included in the conference-end callback.
Default: false
timeLimit
integer		Maximum duration of the conference in seconds. The conference ends automatically when this limit is reached.
Allowed values: positive integer
Default: 14400 (4 hours)

​
Examples

​
Basic conference room

Minimal conference — all defaults
<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Conference>SalesTeamRoom</Conference>
</Response>

​
Moderator-controlled conference

The moderator (endConferenceOnExit="true") holds all participants in music until they arrive, then ends the call for everyone when they leave.
Moderator joins last; ends conference on exit
<?xml version="1.0" encoding="UTF-8"?>

<!-- Participant XML (plays hold music until moderator arrives) -->
<Response>
    <Speak>Please hold while we connect you to the conference.</Speak>
    <Conference
        startConferenceOnEnter="false"
        waitSound="https://yourapp.com/hold-music">
        WeeklyStandup
    </Conference>
</Response>

<!-- Moderator XML (starts the conference; ends it when they leave) -->
<Response>
    <Conference
        startConferenceOnEnter="true"
        endConferenceOnExit="true"
        beep="true">
        WeeklyStandup
    </Conference>
</Response>

​
Recorded conference with participant limit

Record the session and cap at 10 participants
<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Conference
        maxParticipants="10"
        record="true"
        callbackUrl="https://yourapp.com/conference-events"
        callbackMethod="POST">
        BoardMeeting
    </Conference>
</Response>

​
Muted listener (broadcast mode)

Caller joins as a silent listener
<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Speak>You are now listening to the all-hands broadcast.</Speak>
    <Conference
        muted="true"
        startConferenceOnEnter="false">
        AllHandsBroadcast
    </Conference>
</Response>