Global events of all telephone terminals in PBX

Using this resource, you can set events that will apply to all PBX telephone terminals.

Also in this resource, in addition to events that can be set to a specific extension, there is an additional event type extension-call-status, it allows you to track events on call status changes of telephone terminals

Event data `extension-call-status`

In the case when the request method is GET, the data will be contained in the request header, if the request method is POST, the data will be contained in the request body. In both cases, the data is in the format application/x-www-form-urlencoded.

Name	Type	Description

Name	Type	Description
old_status_id	integer	ID of the old status that was changed. If null, then the status was just added to the incremental one, and not changed (there was no status before this)
new_status_id	integer	The ID of the new status that was changed to. If null, then the status was just removed from the extension, and not changed (now the status is missing)
extension_id	integer	Identifier of the telephone terminal on which the status change occurred
change_dt	string	Status change time
event_type	string	Event type. For this type of event, it always takes the value `"call-status-change"`
client_id	integer	Client ID
extension_name	string	The telephone terminal where the status change occurred

Resources of the “Client” section

POST /client/{client_id}/phone_events/

Add an event to all telephone terminals in PBX

URL Options

Name	Type

Name	Type
client_id	string

JSON Options

Name	Type	Mandatory

Name	Type	Mandatory
url	string	yes
event_type	string	yes
method	string	yes

Response Fields

Name	Type

Name	Type
url	string
method	string
event_type	string
id	long

GET /client/{client_id}/phone_events/

Get a list of events installed globally on all PBX telephone terminals

URL Options

Name	Type

Name	Type
client_id	string

Response Fields

Name	Type

Name	Type
url	string
method	string
event_type	string
id	long

DELETE /client/{client_id}/phone_events/

Delete all events installed globally on all PBX telephone terminals

URL Options

Name	Type

Name	Type
client_id	string

PUT /client/{client_id}/phone_event/{id}

Update an event set globally on all PBX telephone terminals

URL Options

Name	Type

Name	Type
client_id	string
id	integer

JSON Options

Name	Type	Mandatory

Name	Type	Mandatory
url	string	no
event_type	string	no
method	string	no

Response Fields

Name	Type

Name	Type
url	string
method	string
event_type	string
id	long

REST API Client Documentation

Global events of all telephone terminals in PBX

Event data `extension-call-status`

Resources of the “Client” section

Related content

Global events of all telephone terminals in PBX

Event data extension-call-status

Resources of the “Client” section

Related content

Event data `extension-call-status`