<Conference>
<Dial> and connect callers to conferences and conference rooms
Overview
Kazoo conferences use profiles to save and load conference settings. Pivot can create and save profiles dynamically, or use any previously configured conference profile in the Kazoo account. Several additional configuration parameters are available using pre-configured conference profiles.
Attributes
Body
The name of the conference must be in the body of the term, otherwise the conference request will fail.
Participant Join Parameters
These parameters can be configured freely by each participant.
| Name | Values Description | Default value |
|---|---|---|
id | string | autogenerated |
startConferenceOnEnter | true | false | true |
endConferenceOnExit | true | false | false |
endConferenceOnLastMemberExit | true | false | false |
deaf | true | false | false |
muted | true | false | false |
Profile Parameters
These parameters are configurable through a conference Profile. Only the first participant to join a conference can configure these parameters.
| Name | Values Description | Default value |
|---|---|---|
profileName | string | account default |
maxParticipants | integer between 3 and 250 | 250 |
beep | true | false | onEnter | onExit | true |
id
Conferences are uniquely identified by the conference name and id. Conferences with the same name but different IDs will be different conference sessions. Defaults to a hash of the conference name.
startConferenceOnEnter
Start the conference when this participant enters the conference room and identify them as a moderator. By default, all participants are moderators.
endConferenceOnExit
The conference ends when a participant with this attribute leaves the conference.
Defaults to false
endConferenceOnLastMemberExit
The conference ends when all participants with this attribute leave the conference.
If no participants enter with this attribute, it is ignored.
Defaults to false
deaf
If set to true, this participant will join deafened.
Defaults to false
muted
If set to true, this participant will join muted.
Defaults to false
profileName
The pre-set conference profile to use. Pivot can load configurations and settings from any
conference set up in the Kazoo account. If the selected profileName isn’t already in
the account, Kazoo will make a new profile for this conference. 2600Hz encourages developers
to prepare conference profiles in advance using the Conference API or App
for greater flexibility and predictability.
If profileName is unspecified, Pivot will use the account default conference profile.
maxParticipants
The maximum number of conference participants, further join requests will be rejected. Minimum of 3
maximum of 250.
Defaults to 250
beep
Play a beep when participants enter or exit the conference.
Defaults to true