<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.
Attributes
Body
The name of the conference must be in the body of the term, otherwise the conference request will fail.
Parameters
| Name | Values Description | Default value |
|---|---|---|
id | string | autogenerated |
profileName | string | account default |
startConferenceOnEnter | true | false | true |
beep | true | false | onEnter | onExit | true |
maxParticipants | integer between 3 and 250 | 250 |
deaf | true | false | false |
muted | true | false | false |
id
Conferences are uniquely identified by the conference name and id. id defaults to a hash of
the conference name.
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 registered
with 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.
startConferenceOnEnter
Start the conference when this participant enters the conference room and identify them as a moderator. By default, all participants are moderators.
beep
Play a beep when this participant enters or exits the conference. The first participant to join the conference can override the profile beep settings.
maxParticipants
The maximum number of conference participants, further join requests will be rejected. Minimum of 3
maximum of 250.
Defaults to 250
deaf
If set to true, this participant will join deafened.
muted
If set to true, this participant will join muted.