Update Extension Status Monitoring Settings

Update extension status monitoring settings for the API feature.

Request URL

POST {base_url}/{api_path}/extension_status_monitor/update?access_token={access_token}

Request parameters

Parameter Required Type Description
ext_monitor_list No Array<Monitoring_Settings> The status monitoring settings of extensions.
Monitoring_Settings
Parameter Required Type Description
ext_id Yes Integer Extension ID.
Note: You can get extension IDs using Query Extension Status Monitoring Settings.
number No String Extension Number.
name No String Extension's Caller ID Name.
enb_register_status No Integer

Whether to enable registration status monitoring for the extension.

Valid value:

  • 0: Disable
  • 1: Enable
enb_call_status No Integer Whether to enable call status monitoring for the extension.

Valid value:

  • 0: Disable
  • 1: Enable
enb_presence_status No Integer Whether to enable presence status monitoring for the extension.

Valid value:

  • 0: Disable
  • 1: Enable

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.

Examples

Request example

Update monitoring settings for an extension (ID: 10).

POST /openapi/v1.0/extension_status_monitor/update?access_token=eyqOGfQ6xGbQ3R5VSxHbXkey9fiOW8bZ HTTP/1.1 

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "ext_monitor_list": [
        {
            "ext_id": 10,
            "name": "Phillip Huff",
            "number": "1001",
            "enb_call_status": 1,
            "enb_presence_status": 1,
            "enb_register_status": 0
        }
    ]
}

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}