Edit a Conference
Edit basic settings of a conference which is added on the PBX web interface.
Request URL
{base_url}/{api_path}/conference/update?token={token}
Request parameters
Parameter | Required | Type | Description |
---|---|---|---|
number | Yes | String | Conference number. |
name | No | String | Conference name. Note: The following characters are NOT
allowed:
& ' < > ` | $ ] \ " . |
participantepassword | No | String | The password to join a conference. Note: Only numbers and
* are allowed. |
moderatorpassword | No | String | Moderator password. Note: Only numbers and *
are allowed. |
waitformoderator |
No | String | Whether to wait for the moderator to start a conference or
not. Valid values:
|
allowinvite | No | String | Whether to allow the participants to invite other members to
the conference or not. Valid values:
|
moderators | No | Integer | Conference moderator. Note: moderators must
be extension numbers. |
musiconhold | No | String | Whether to enable music on hold. Valid values:
|
mute | No | String | Whether to mute all participants except for moderators when
entering this conference. Valid values:
|
prompt | No | String | Set the prompt used for the login and logout of conference
members. Valid values:
|
Response parameters
Parameter | Type | Description |
---|---|---|
status | String | Request result.
|
Examples
Request example
Change participantepassword
to “5678” for conference 6400.
POST /api/v2.0.0/conference/update?token=721eebe15cb3c27b60daeb1f120f0c05 Content-Type:application/json; charset=utf-8 Host: 192.168.5.150 { "number": "6400", "participantepassword": "5678" }
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" }