Skip to Content

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

ParameterRequiredTypeDescription
ext_monitor_listNoArray<Monitoring_Settings>The status monitoring settings of extensions.

Monitoring_Settings

ParameterRequiredTypeDescription
ext_idYesIntegerExtension ID.
Note: You can get extension IDs using Query Extension Status Monitoring Settings.
numberNoStringExtension Number.
nameNoStringExtension's Caller ID Name.
enb_register_statusNoInteger

Whether to enable registration status monitoring for the extension.

Valid value:

  • 0: Disable
  • 1: Enable
enb_call_statusNoIntegerWhether to enable call status monitoring for the extension.

Valid value:

  • 0: Disable
  • 1: Enable
enb_presence_statusNoIntegerWhether to enable presence status monitoring for the extension.

Valid value:

  • 0: Disable
  • 1: Enable

Response parameters

ParameterTypeDescription
errcodeIntegerReturned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsgStringReturned 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: 192.168.5.150:8088
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"
}