Client
GET /client/{client_id}/agent/local/{agent_id}/events/
Get queue events
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. Start datetime. |
|
|
Required. End datetime. |
|
|
Datetime sorting order. One of 'desc', 'asc'. Default: desc |
|
|
Event type. |
GET /client/{client_id}/agent/remote/{agent_id}/events/
Get queue events
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. Start datetime. |
|
|
Required. End datetime. |
|
|
Datetime sorting order. One of 'desc', 'asc'. Default: desc |
|
|
Event type. |
GET /client/{client_id}/call_history/
Get call history list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
One of 'in', 'out'. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Result page. Default: 1 |
|
|
Items per page. Default: 100000 |
|
|
Datetime sorting order. One of 'desc', 'asc'. Default: desc |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Items per page. |
|
|
Default: [] |
|
|
Datetime sorting order. |
|
|
Result page. |
Resource call_history
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /client/{client_id}/call_history/{call_uuid
}
Get call history item
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Resource cdr_response
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /client/{client_id}/calls/
Get call list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
One of 'in', 'out'. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Result page. Default: 1 |
|
|
Items per page. Default: 100000 |
|
|
Datetime sorting order. One of 'desc', 'asc'. Default: desc |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Items per page. |
|
|
Datetime sorting order. |
|
|
|
|
|
Result page. |
Resource calls
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /client/{client_id}/calls/stats/
Get calls statistics
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
|
|
GET /client/{client_id}/cdr/
Get call list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
|
|
|
|
|
|
|
|
|
|
|
One of 'in', 'out', 'transfer'. |
|
|
|
|
|
|
|
|
|
|
|
Result page. Default: 1 |
|
|
Items per page. Default: 100000 |
|
|
Datetime sorting order. One of 'desc', 'asc'. Default: desc |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Items per page. |
|
|
Datetime sorting order. |
|
|
|
|
|
Result page. |
Resource cdr_response
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /client/{client_id}/cdr/stats/
Get calls statistics
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
|
|
GET /client/{client_id}/disk_space/
Get client available free disk space
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /client/{client_id}/disk_space/stats/
Get client available free disk space
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Start datetime. |
|
|
End datetime. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /client/{client_id}/extension/call_status/stats/history/
Get extension call status history
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
|
|
Required. |
|
|
|
|
|
Result page. Default: 1 |
|
|
Items per page. Default: 100000 |
|
|
Datetime sorting order. One of 'desc', 'asc'. Default: desc |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /client/{client_id}/fax/in/
Get incoming fax messages list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Fax uuid. |
|
|
Extension id. |
|
|
Extension group id. |
|
|
Start datetime. |
|
|
End datetime. |
|
|
Destination number. |
|
|
Caller id number. |
|
|
Datetime sorting order. One of 'desc', 'asc'. Default: desc |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Fax uuid. |
|
|
Destination number. |
|
|
Caller id. |
|
|
Record datetime. |
|
|
Fax file size. |
|
|
Extension id. |
|
|
Client id. |
|
|
Extension group id. |
GET /client/{client_id}/fax/out/
Get client fax messages list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
Start datetime. |
|
|
End datetime. |
|
|
Datetime sorting order. One of 'desc', 'asc'. Default: desc |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
Resource id. |
|
|
|
|
|
|
|
|
|
|
|
GET /client/{client_id}/reg_status_log/
Get logs for change registrations of all client extensions
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. Start datetime. |
|
|
Required. End datetime. |
|
|
Datetime sorting order. One of 'desc', 'asc'. Default: desc |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
GET /client/{client_id}/voicemail/
Get voice mail messages list
Path parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. |
Query parameters
Name |
Type |
Description |
---|---|---|
|
|
Required. Start datetime. |
|
|
Required. End datetime. |
|
|
Datetime sorting order. One of 'desc', 'asc'. Default: desc |
|
|
Extension id. |
|
|
Extension id. |
Resource fields
Name |
Type |
Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Extension id. |
|
|
|
|
|