Query Instant Conference

Query settings of instant conferences which are called by API interface instant_conference/create. You can query basic settings of an instant conference, multiple instant conferences, or all instant conferences.

Request URL

{base_url}/{api_path}/instant_conference/query?token={token}

Request parameters

Parameter Required Type Description
number Yes String Instant conference number.

Valid values:

  • A conference number: Query settings of the specified instant conference.

    Example: "number":"6400"

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

    Example: "number":"6400,6401"

  • all: Query settings of all instant conferences.

    Example: "number":"all"

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed
conferences Array <ConferenceInfo> Instant conference information.
ConferenceInfo
Parameter Type Description
number String Instant conference number.
name String Instant conference name.
moderators Integer Instant conference moderators.
member String Instant conference members.

Examples

Request example

Query settings of instant conference 6466.

POST /api/v2.0.0/instant_conference/query?token=3ddc40cf73c8ed477e4e466b044e9c89
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "6466"
}
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": "6466",
			"name": " 6466",
			"moderators": "4000",
			"members": "4001"
		}
	]
}