Conference

About Conference

Put the caller into a conference room (new or existing).

You can optionally include the conference config to create dynamic, ad-hoc conferences in lieu of the id

Schema

Validator for the Conference callflow element

KeyDescriptionTypeDefaultRequiredSupport Level
configBuild an ad-hoc conference using the conferences JSON schemaobject()false
idKazoo ID of the conferencestring(32)false
moderatorIs the caller entering the conference as a moderatorboolean()false
play_entry_toneShould the Entry Tone be played`boolean()string()`false
play_exit_toneShould the Exit Tone be played`boolean()string()`false
skip_moduleWhen set to true this callflow action is skipped, advancing to the wildcard branch (if any)boolean()false
welcome_prompt.media_idMedia to play, either Kazoo media ID or URLstring()false
welcome_prompt.playShould the Welcome Prompt be playedboolean()truefalse
welcome_promptDescribes how the caller is greeted on entering a conferenceobject()false

conferences

Schema for conferences

KeyDescriptionTypeDefaultRequiredSupport Level
allow_shareable_linkIndicates if the conference is reachable using a public linkboolean()falsefalse
base_profile_namename of base profilestring()false
bridge_passwordthe password used for a conference bridgestring()false
bridge_usernamethe username used for a conference bridgestring()false
caller_controlscaller controls (config settings)string()false
conference_numbers.[]string()false
conference_numbersDefines conference numbers that can be used by members or moderatorsarray(string())[]false
controlscontrolsobject()false
domaindomainstring()false
flags.[]string()falsesupported
flagsFlags set by external applicationsarray(string())falsesupported
focusThis is a read-only property indicating the media server hosting the conferencestring()false
languagePrompt language to play in the conferencestring()false
max_members_mediaMedia to play when the conference is fullstring()false
max_participantsThe maximum number of participants that can joininteger()false
member.join_deafDetermines if a member will join deafboolean()falsefalsesupported
member.join_mutedDetermines if a member will join mutedboolean()truefalsesupported
member.numbers.[]string()false
member.numbersDefines the conference (call in) number(s) for membersarray(string())[]false
member.pins.[]string()false
member.pinsDefines the pin number(s) for membersarray(string())[]false
member.play_entry_promptWhether to play the entry prompt on member joinboolean()false
memberDefines the discovery (call in) properties for a memberobject(){}false
moderator.join_deafDetermines if a moderator will join deafboolean()falsefalse
moderator.join_mutedDetermines if a moderator will join mutedboolean()falsefalse
moderator.numbers.[]string()false
moderator.numbersDefines the conference (call in) number(s) for moderatorsarray(string())[]false
moderator.pins.[]string()false
moderator.pinsDefines the pin number(s) for moderatorsarray(string())[]false
moderatorDefines the discovery (call in) properties for a moderatorobject(){}false
moderator_controlsprofile on the switch for controlling the conference as a moderatorstring()false
nameA friendly name for the conferencestring(1..128)truesupported
owner_idThe user ID who manages this conferencestring(32)falsesupported
play_entry_toneWhether to play an entry tone, or the entry tone to play`boolean()string()`false
play_exit_toneWhether to play an exit tone, or the exit tone to play`boolean()string()`false
play_nameDo we need to announce new conference members?boolean()falsefalse
play_welcomeWhether to play the welcome promptboolean()false
profileProfile configurationobject()false
profile_nameconference profile namestring()false
require_moderatordoes the conference require a moderatorboolean()false
videoIf false, video participants will join with video mutedboolean()false
wait_for_moderatorshould members wait for a moderator before joining the conferenceboolean()false

conferences.profile

Schema for conference profiles

KeyDescriptionTypeDefaultRequiredSupport Level
alone-soundAudio that plays while you are alone in the conferencestring()false
announce-countPlay member count to conference when above this thresholdinteger()false
caller-controlsName of the caller control groupstring()false
comfort-noiseThe volume level of background white noiseinteger(0..10000)false
energy-levelEnergy level required for audio to be sent to other usersinteger(0..1800)false
enter-soundAudio to play when entering a conferencestring()false
exit-soundAudio to play when exiting a conferencestring()false
intervalMilliseconds per frameinteger(10..120)false
locked-soundAudio to play when the conference is lockedstring()false
max-membersSet the maximum number of members in the conferenceinteger(2..)false
max-members-soundIf max-members has been reached, audio to play to caller instead of joining the conferencestring()false
moderator-controlsName of the moderator control group to usestring()false
moh-soundAudio to play, on a loop, while participant count is 1string()false
muted-soundAudio to play when mutedstring()false
rateAudio sample rateinteger()false
unmuted-soundAudio to play when unmutedstring()false

On this page