Query Scheduled Conference List

Query the list of the scheduled conferences that were created either from the PBX web portal or through API requests.

Request URL

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

Request parameters

Parameter	Required	Type	Description
page	Yes	Integer	Define which page is displayed.
page_size	Yes	Integer	Define how many records per page.
sort_by	No	String	Define the sorting field. Valid value: number (Default) name
order_by	No	String	Define the display order. Valid value: asc: Ascending order. (Default) desc: Descending order.

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.
total_number	Integer	The total number of conferences.
data	Array<Conference_Info>	The list of the conference information.

Conference_Info

Parameter	Type	Description
id	Integer	The ID of the conference.
name	String	Conference name.
number	String	Conference number.
moderator_list	Array<Moderator_List>	The information list of conference moderators.

Moderator_List

Parameter	Type	Description
id	String	The ID of the conference moderator.
name	String	The name of the conference moderator.
type	String	The type of the conference moderator. extension: Extension. ext_group: Extension group.

Examples

Request example

GET /openapi/v1.0/conference/list?access_token=4mZxlzE08rl3g7rE7wjoMIowMoVkMvUr&page=1&page_size=5 HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 3,
    "data": [
        {
            "id": 1,
            "name": "Sales Weekly Meeting",
            "number": "6500",
            "moderator_list": [
                {
                    "id": "50",
                    "name": "Emily Parker",
                    "type": "extension"
                }
            ]
        },
        {
            "id": 2,
            "name": "Support Case Review",
            "number": "6501",
            "moderator_list": [
                {
                    "id": "47",
                    "name": "Michael Harris",
                    "type": "extension"
                }
            ]
        },
        {
            "id": 3,
            "name": "Marketing Planning Room",
            "number": "6502",
            "moderator_list": [
                {
                    "id": "55",
                    "name": "Kevin Thompson",
                    "type": "extension"
                },
                {
                    "id": "202",
                    "name": "Krisin Hale",
                    "type": "extension"
                }
            ]
        }
    ]
}