You can test API methods on the interactive API browser page and without writing code
Some of the resources described on the page may not be available by default due to the type of application (see Creating and authorizing applications).
Description of Data Structures
Conference Properties
Name | Type | Mandatory | Default Value | -Description |
|---|---|---|---|---|
announce_caller_name | boolean | no | false | If this option is active, then upon entering the conference, the extension number username will be requested that will be announced to every participant of the conference. |
enter_sound | integer | no | null | The sound file identifier that will be played when entering the conference |
max_members | integer | no | null | Maximum quantity of the conference participants (default: 100) |
pin | string | no | null | PIN code of the conference participant. You cannot enter the conference without knowing the PIN code if the PIN code was set |
moderator_pin | string | no | null | PIN code of the moderator. It cannot be specified without specifying a PIN code for the conference participants (option pin) |
mute_non_moderator | boolean | no | false | When entering the conference, everyone microphone will be muted except the moderator one. Also, the ordinary participants cannot use the microphone turning on command *1 |
music_on_hold_sound | integer | no | null | Melody that is played if there is only 1 participant in the conference (melody for waiting of other participants) |
record_enabled | boolean | no | false | Recording a conference participant from among invited persons (external numbers). Does not apply to additional platforms |
Conference Invitation and Conference Management Using Telephone Terminal
A conference participant that is an extension number (including a moderator) can:
Command | Action |
|---|---|
*8 | Invite an external number to the conference |
*1 | Turn on/off the microphone (if the conference function mute_non_moderator is enabled this command is available for the moderator only) |
A conference participant that is a moderator can:
Command | Action |
|---|---|
*90 | Turn on microphones for all conference participants (except for moderators) |
*91 | Mute microphones for all conference participants (except for moderators) |
*92 | Prohibit new participants to connect to the conference and block the conference. When a new participant tries to connect to the conference, including to the conference moderator, this participant will be declined |
*93 | Action inverse to the command * 92 |
*94 | Disable notifications about entry of a new conference participant |
*95 | Enable notifications about entry of a new conference participant |
"Extension Number” Section Resources
| Expand | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
GET /extension/{extension_id}/conference/ Get the conference properties URL Options
Response Fields
|
| Expand | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||
PUT /extension/{extension_id}/conference/ Change the conference properties URL Options
Request Options
Response Fields
|