Account Configuration
Conference rooms can use profiles and controls stored in the account configuration document, and will use the default attributes stored in the account config.
Schema
Use the config API to modify or add attributes.
Default attributes
These defaults are applied if a room’s profile does not set them.
| Key | Description | type | 2600Hz Default |
|---|---|---|---|
entry_tone | conferences entry tone | string() | chiming tones |
exit_tone | conferences exit tone | string() | chiming tones |
moderator_entry_tone | conferences moderator entry tone | string() | chiming tones |
moderator_exit_tone | conferences moderator exit tone | string() | chiming tones |
number_timeout | conferences number timeout | integer() | 5000 |
pin_timeout | conferences pin timeout | integer() | 5000 |
support_name_announcement | conferences support name announcement | boolean() | true |
Reusable Profiles and Controls
The account configuration holds lists of profiles and controls for rooms to use.
| Key | Description | Type |
|---|---|---|
profiles | conferences profiles | array() |
controls | conferences controls | array() |
Profiles
Most conference features are configured with profiles, which can be created dynamically when a conference begins, or configured beforehand. See the profile schema for descriptions and configuration.
Profiles can include any of the FreeSwitch mod_conference flags. However 2600Hz uses several of these flags to extend conference functionality, so 2600Hz does not recommend setting profile flags which are not directly supported by the API.
Pre-Configured profiles
Any conference can use a pre-configured profile by referencing it in the profile_name conference
attribute.
See the config API to pre-configure a profile.
Dynamic profiles
2600Hz can also create or use profiles dynamically when a conference starts. See the section dialing out to a dynamic conference in the HTTP API.
Once a conference starts, profile settings will not be changed by joining participants. These flags can still be changed using the HTTP API.
Pivot uses this feature when someone Dials into a new conference.
Controls
Participants can make conference actions with DTMF sequences while the conference is running.
2600Hz’s default controls allow participants to mute, deafen, and leave the conference. Note that
an active conference only has two sets of active controls; caller-controls for all members, and
moderator-controls for all moderators. Individual participants cannot have different controls.
| Action | DTMF Sequence |
|---|---|
| vmute | *0 |
| mute | *1 |
| mute on | *2 |
| mute off | *3 |
| deaf | *4 |
| deaf on | *5 |
| deaf off | *6 |
| hangup | # |
vmute is only configured for video participants.
Other conference actions are available, including some which change the state of the conference for every member. For a complete list of control options and their descriptions, see Freeswitch’s Controls.
Just like profiles, controls can be pre-configured and used by new conferences. See the configuration API for more information.