Query information of Instant Conferences

Query the information of instant conferences created through API requests.

Request URL

GET {base_url}/{api_path}/conference/query_interim_conference?access_token={access_token}

Request parameters

Parameter Required Type Description
number Yes String Conference number.
Valid value:
  • To query a specific instant conference, pass the number of the conference.
  • To query multiple instant conferences, pass the numbers of the conferences, and use commas to separate multiple numbers.
  • To query all instant conferences, pass the value all.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
data Array <Conference_Info> The detailed information of the instant conference.
Conference_Info
Parameter Type Description
number String Conference number.
name String Conference name.
moderators_channel_id Array <String> The channel ID of the conference moderators.
members_channel_id Array <String> The channel ID of the conference participants.

Example

Request example

GET /openapi/v1.0/conference/query_interim_conference?number=all&access_token=WM3RnLSIDUaDiCbQBemebFMuY5FmauNO HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": [
        {
            "number": "6902",
            "name": "instant conference",
            "moderators_channel_id": [
                "PJSIP/1001-0000003e"
            ],
            "members_channel_id": [
                "PJSIP/1007-00000041"
            ]
        },
        {
            "number": "6905",
            "name": "instant conference-2",
            "moderators_channel_id": [
                "PJSIP/1000-00000043"
            ],
            "members_channel_id": [
                "PJSIP/1003-00000045",
                "PJSIP/1001-00000046"
            ]
        }
        
    ]
}