Conference Attributes

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

Attribute	Description
`muted` boolean	If `true`, the participant joins the conference muted and cannot be heard by others until unmuted. Default: `false`
`beep` boolean	Configures join and leave tones. Vobiz accepts this value, but audible tones are not currently guaranteed. 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	Requests a participant limit for the room. The account-level conference limit remains authoritative, so enforce lower limits in your application. Allowed values: positive integer
`waitSound` string	URL that returns XML for a waiting participant while `startConferenceOnEnter` is `false`. Vobiz requests this URL with `POST`; `<Speak>` and `<Wait>` are supported in the response. Allowed values: a fully qualified URL
`waitMethod` string	HTTP method used to fetch `waitSound`. Use `POST` for the documented wait-audio flow. Default: `POST`
`callbackUrl` string	URL notified when a participant enters or exits. Separate conference start and end callbacks are not currently available. See Conference Callbacks for event-specific parameters. Allowed values: a fully qualified URL
`callbackMethod` string	HTTP method used to notify `callbackUrl`. Allowed values: `GET`, `POST` Default: `POST`
`record` boolean	If `true`, Vobiz records the conference audio. Use `recordFileFormat` to select MP3 or WAV. Recording details are included in the final `action` request when `action` is configured. Default: `false`
`recordFileFormat` string	Audio format for XML-triggered conference recording. Allowed values: `mp3`, `wav` Default: `mp3`
`timeLimit` integer	Maximum conference duration in seconds. When the limit expires, Vobiz ends the conference and disconnects its members. Allowed values: positive integer Default: `14400` (4 hours)
`action` string	Fully qualified URL that Vobiz requests when this call leg exits the conference. The response can contain additional Vobiz XML, which continues call control after `<Conference>`. When recording is enabled, the request includes recording identity and location fields.
`method` string	HTTP method used to request `action`. Use `POST` for the documented action flow. Default: `POST`

Conference action callback

The action request is separate from the participant events sent to callbackUrl. Vobiz invokes action after the call leg exits <Conference>, then executes the Vobiz XML returned by your endpoint. The request includes call, conference, and member identifiers. When record="true", it can also include:

Parameter	Description
`RecordingID`	Identifier for the completed conference recording
`RecordUrl`	URL associated with the recording
`RecordFile`	Recording file name or path

Return valid Vobiz XML from the action endpoint when the call should continue:

Action response

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Speak>The conference has ended.</Speak>
</Response>

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

The account-level room limit remains authoritative. Enforce any lower participant limit in your application.

Record the session and cap at 10 participants

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Conference
        maxParticipants="10"
        record="true"
        recordFileFormat="wav"
        action="https://yourapp.example/conference-complete"
        method="POST"
        callbackUrl="https://yourapp.example/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>

​Attributes

​Conference action callback

​Examples

​Basic conference room

​Moderator-controlled conference

​Recorded conference with participant limit

​Muted listener (broadcast mode)

Attributes

Conference action callback

Examples

Basic conference room

Moderator-controlled conference

Recorded conference with participant limit

Muted listener (broadcast mode)