Query Extension Status Monitoring Settings

Query extension status monitoring settings for the API feature.

Request URL

GET {base_url}/{api_path}/extension_status_monitor/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:

  • ext_id
order_by No String Define the display order.

Valid value:

  • asc: Ascending 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 extensions.
data Array<Monitoring_Settings> The status monitoring settings of extensions.
Monitoring_Settings
Parameter Type Description
ext_id Integer Extension ID.
number String Extension Number.
name String Extention's Caller ID Name.
enb_register_status Integer
Whether the Registration Status Monitor is enabled.
  • 0: Disabled
  • 1: Enabled
enb_call_status Integer Whether the Call Status Monitor is enabled.
  • 0: Disabled
  • 1: Enabled
enb_presence_status Integer Whether the Presence Status Monitor is enabled.
  • 0: Disabled
  • 1: Enabled

Examples

Request example

GET /openapi/v1.0/extension_status_monitor/list?access_token=bZDofvFsZ6oMkZgII195h1BzLa0co5o4&page=1&page_size=4&sort_by=ext_id&order_by=asc HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 12,
    "data": [
        {
            "ext_id": 9,
            "number": "1000",
            "name": "Leo Ball",
            "enb_register_status": 0,
            "enb_call_status": 1,
            "enb_presence_status": 0
        },
        {
            "ext_id": 10,
            "number": "1001",
            "name": "Phillip Huff",
            "enb_register_status": 1,
            "enb_call_status": 1,
            "enb_presence_status": 0
        },
        {
            "ext_id": 4,
            "number": "1002",
            "name": "Terrell Smith",
            "enb_register_status": 0,
            "enb_call_status": 0,
            "enb_presence_status": 1
        },
        {
            "ext_id": 5,
            "number": "1003",
            "name": "Dave Harris",
            "enb_register_status": 0,
            "enb_call_status": 0,
            "enb_presence_status": 0
        }
    ]
}