'Changed Extension Status' Report

The PBX will send a report to the application server when the extension status changes.

Prerequisite: Enable Status Monitor of the extension on the PBX web interface: Settings > PBX > General > API.

Extension Status

  • Ringing: The PBX will send a report when the extension is ringing.
  • Busy: The PBX will send a report when the extension is off-hook.

  • Idle: The PBX will send a report when the extension is on-hook.

  • Registered: The PBX will send a report when the extension status is changed from Unregistered to Registered.
  • Unregistered: The PBX will send a report when the extension status is changed from Registered to Unregistered.

Report Parameters

Name Type Description
action String Status change of extension.
extension Int The number of extension with status change.
status String The status of extension after change.
sn String The PBX's serial number.

Report Example

POST / HTTP/1.1
User-Agent: WebAPI
Host: api.yeastarcloud.com
Content-Type: application/json
Accept: application/json
{
    "action": "ExtensionStatus",
    "extension": "1006",
    "status": "Registered",
    "sn": "369362089179"
}