Query Extension Group List

Query the extension group list.

Request URL

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

Request parameters

Parameter Required Type Description
page No Integer Define which page is displayed.
page_size No Integer Define how many records per page.
sort_by No String Define the sorting field.

Valid value:

  • id
  • name
order_by No String Define the display order.

Valid value:

  • asc: Ascending order.
  • 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 extension groups.
data Array<ExtGroup_info> The information of the extension group.
ExtGroup_info
Parameter Type Description
id Integer Extension Group ID.
name String Extension Group name.
member_select String How extensions are added to the group.
  • sel_all_ext: All extensions are added.
  • sel_specific: Only specified extensions are added.
total_extensions Integer The total number of member extensions in the group.

Examples

Request example

GET /openapi/v1.0/extensiongroup/list?access_token=Hb19mIhO9E1lfCWCF01P9D4R7MiG1Jow&sort_by=name&order_by=asc HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 4,
    "data": [
        {
            "id": 1,
            "name": "Default_All_Extensions",
            "member_select": "sel_all_ext",
            "total_extensions": 36
        },
        {
            "id": 161,
            "name": "Front-Desk",
            "member_select": "sel_specific",
            "total_extensions": 4
        },
        {
            "id": 179,
            "name": "OL",
            "member_select": "sel_specific",
            "total_extensions": 0
        },
        {
            "id": 178,
            "name": "Docs",
            "member_select": "sel_specific",
            "total_extensions": 0
        }
    ]
}