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


Request parameters

Parameter Required Type Description
number Yes String Conference number.

Valid values:

  • A conference number: Query the specified conference.

    Example: "number":"6400"

  • Multiple conference numbers: Query multiple conferences. Separate multiple conference numbers with ,.

    Example: "number":"6400,6401"

  • all: Query all conferences.

    Example: "number":"all"

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed
conferences Array <ConferenceInfo> Conference information.
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.


Request example

Query settings of conference 6400.

POST /api/v2.0.0/conference/query?token=721eebe15cb3c27b60daeb1f120f0c05
Content-Type:application/json; charset=utf-8

	"number": "6400"

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": "6400",
			"name": "6400",
			"participantepassword": "",
			"moderatorpassword": "",
			"waitformoderator": "no",
			"allowinvite": "yes",
			"moderators": "4000"