Query Conference
Query basic settings of conferences which are added on PBX web interface. You can query a conference, multiple conferences, or all conferences.
Request URL
{base_url}/{api_path}/conference/query?token={token}
Request parameters
Parameter | Required | Type | Description |
---|---|---|---|
number | Yes | String | Conference number. Valid values:
|
Response parameters
Parameter | Type | Description |
---|---|---|
status | String | Request result.
|
conferences | Array <ConferenceInfo> | Conference information. |
- ConferenceInfo
-
Parameter Type Description number String Conference number. name String Conference name. participantepassword String The password to join a conference. moderatorpassword String Moderator password. waitformoderator String Whether to wait for the moderator to start a conference or not. - yes
- no
allowinvite String Whether to allow the participants to invite other members to the conference or not. - yes
- no
moderators Integer Conference moderators. musiconhold String Whether music on hold is enabled. - yes
- no
mute String Whether to mute all participants except for moderators when entering this conference. - yes
- no
prompt String The prompt used for the login and logout of conference members. - default: Play a beep tone when users join or leave the conference.
- exten: Play caller number when users join or leave the conference.
- none: No prompt will be played when users join or leave the conference.
Examples
Request example
Query settings of conference 6401.
POST /api/v2.0.0/conference/query?token=721eebe15cb3c27b60daeb1f120f0c05 Content-Type:application/json; charset=utf-8 Host: 192.168.5.150 { "number": "6401" }
Response example
HTTP/1.1 200 OK Server: Boa/0.94.14rc21 Accept-Ranges: bytes Connection: close Content-Type: application/json Access-control-allow-origin: * Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE { "status": "Success", "conferences": [ { "number": "6401", "name": "PM", "participantepassword": "3201", "moderatorpassword": "", "waitformoderator": "no", "allowinvite": "yes", "moderators": "", "musiconhold": "yes", "mute": "no", "prompt": "default" } ] }