Conference - 2600Hz Docs

ConferenceCopied

About ConferenceCopied

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

Key	Description	Type	Default	Required	Support Level
`config`	Build an ad-hoc conference using the conferences JSON schema	`object()`		`false`
`id`	ID of the conference	`string(32)`		`false`
`moderator`	Is the caller entering the conference as a moderator	`boolean()`		`false`
`play_entry_tone`	Should the Entry Tone be played	`boolean()	string()`		`false`
`play_exit_tone`	Should the Exit Tone be played	`boolean()	string()`		`false`
`skip_module`	When set to true this callflow action is skipped, advancing to the wildcard branch (if any)	`boolean()`		`false`
`welcome_prompt.media_id`	Media to play, either media ID or URL	`string()`		`false`
`welcome_prompt.play`	Should the Welcome Prompt be played	`boolean()`	`true`	`false`
`welcome_prompt`	Describes how the caller is greeted on entering a conference	`object()`		`false`

conferencesCopied

Schema for conferences

Key	Description	Type	Default	Required	Support Level
`allow_shareable_link`	Indicates if the conference is reachable using a public link	`boolean()`	`false`	`false`
`auto_record`	Automatically start recording when the number of participants meets the configured required minimum participants for recording (default minimum of two participants)	`boolean()`	`false`	`false`
`base_profile_name`	name of base profile	`string()`		`false`
`bridge_password`	the password used for a conference bridge	`string()`		`false`
`bridge_username`	the username used for a conference bridge	`string()`		`false`
`caller_controls`	caller controls (config settings)	`string()`		`false`
`conference_numbers.[]`		`string()`		`false`
`conference_numbers`	Defines conference numbers that can be used by members or moderators	`array(string())`	`[]`	`false`
`controls`	controls	`object()`		`false`
`domain`	domain	`string()`		`false`
`endconf_grace_time`	Defines how much time all members have before the conference is terminated when the last member with endconf leaves in seconds	`integer(0..)`		`false`
`flags.[]`		`string()`		`false`	`supported`
`flags`	Flags set by external applications	`array(string())`		`false`	`supported`
`focus`	This is a read-only property indicating the media server hosting the conference	`string()`		`false`
`language`	Prompt language to play in the conference	`string()`		`false`
`max_members_media`	Media to play when the conference is full	`string()`		`false`
`max_participants`	The maximum number of participants that can join	`integer()`		`false`
`member.join_deaf`	Determines if a member will join deaf	`boolean()`	`false`	`false`	`supported`
`member.join_muted`	Determines if a member will join muted	`boolean()`	`true`	`false`	`supported`
`member.numbers.[]`		`string()`		`false`
`member.numbers`	Defines the conference (call in) number(s) for members	`array(string())`	`[]`	`false`
`member.pins.[]`		`string()`		`false`
`member.pins`	Defines the pin number(s) for members	`array(string())`	`[]`	`false`
`member.play_entry_prompt`	Whether to play the entry prompt on member join	`boolean()`		`false`
`member`	Defines the discovery (call in) properties for a member	`object()`	`{}`	`false`
`moderator.join_deaf`	Determines if a moderator will join deaf	`boolean()`	`false`	`false`
`moderator.join_muted`	Determines if a moderator will join muted	`boolean()`	`false`	`false`
`moderator.numbers.[]`		`string()`		`false`
`moderator.numbers`	Defines the conference (call in) number(s) for moderators	`array(string())`	`[]`	`false`
`moderator.pins.[]`		`string()`		`false`
`moderator.pins`	Defines the pin number(s) for moderators	`array(string())`	`[]`	`false`
`moderator`	Defines the discovery (call in) properties for a moderator	`object()`	`{}`	`false`
`moderator_controls`	profile on the switch for controlling the conference as a moderator	`string()`		`false`
`name`	A friendly name for the conference	`string(1..128)`		`true`	`supported`
`owner_id`	The user ID who manages this conference	`string(32)`		`false`	`supported`
`play_entry_tone`	Whether to play an entry tone, or the entry tone to play	`boolean()	string()`		`false`
`play_exit_tone`	Whether to play an exit tone, or the exit tone to play	`boolean()	string()`		`false`
`play_name`	Do we need to announce new conference members?	`boolean()`	`false`	`false`
`play_welcome`	Whether to play the welcome prompt	`boolean()`		`false`
`profile`	Profile configuration	`object()`		`false`
`profile_name`	conference profile name	`string()`		`false`
`require_moderator`	does the conference require a moderator	`boolean()`		`false`
`video`	If false, video participants will join with video muted	`boolean()`		`false`
`wait_for_moderator`	should members wait for a moderator before joining the conference	`boolean()`		`false`

conferences.profileCopied

Schema for conference profiles

Key	Description	Type	Required
`alone-sound`	Audio that plays while you are alone in the conference	`string()`	`false`
`announce-count`	Play member count to conference when above this threshold	`integer()`	`false`
`caller-controls`	Name of the caller control group	`string()`	`false`
`comfort-noise`	The volume level of background white noise	`integer(0..10000)`	`false`
`energy-level`	Energy level required for audio to be sent to other users	`integer(0..1800)`	`false`
`enter-sound`	Audio to play when entering a conference	`string()`	`false`
`exit-sound`	Audio to play when exiting a conference	`string()`	`false`
`interval`	Milliseconds per frame	`integer(10..120)`	`false`
`locked-sound`	Audio to play when the conference is locked	`string()`	`false`
`max-members`	Set the maximum number of members in the conference	`integer(2..)`	`false`
`max-members-sound`	If max-members has been reached, audio to play to caller instead of joining the conference	`string()`	`false`
`moderator-controls`	Name of the moderator control group to use	`string()`	`false`
`moh-sound`	Audio to play, on a loop, while participant count is 1	`string()`	`false`
`muted-sound`	Audio to play when muted	`string()`	`false`
`rate`	Audio sample rate	`integer()`	`false`
`unmuted-sound`	Audio to play when unmuted	`string()`	`false`

ExamplesCopied

Connecting to a Pre-Configured ConferenceCopied

{
    "module": "conference",
    "data": {
        "id": "conference_id"
    }
}

Creating or Connecting to an Ad-Hoc ConferenceCopied

{
    "module": "conference",
    "data": {
        "config": {
            "name": "My Ad-hoc Conference"
        }
    }
}

This will create a minimalist conference bridge, named “My Ad-hoc Conference”. Use the same name to ensure callers end up in the same conference together. The config object will be validated against the conference JSON schema.

Conference Per Area CodeCopied

$caller_id = $_REQUEST['Caller-ID-Number'];

$areacode = ($caller_id, 0, 3);
?>
{
    "module": "tts",
    "data": {
        "text": "Welcome to the <?= $areacode ?> conference!"
    },
    "children": {
        "_": {
            "module": "conference",
            "data": {
                "config": {
                    "name": "Areacode <?= $areacode ?>"
                }
            },
            "children": {}
        }
    }
}

Obviously this doesn’t handle hidden or missing caller ID.