API-V2

Extensions

The current collection shows all the methods available to get or put extensions information.

AUTHORIZATION Bearer Token

GET /extensions

http://{{host}}/api/v2/extensions

Get all extensions and its devices from the PBX filtered by tenant.

AUTHORIZATION Bearer Token

This request is using Bearer Token from folder Extensions.

HEADERS

app-key {{api-key}}
Application key to authenticate requests
tenant {{tenant}}
Filter by tenant
Example Request
/extensions
Example Response
200 OK
 

GET /extensions/{id}

http://{{host}}/api/v2/extensions/{{extension-id}}

Get specific extension from server filtered by extension id.

AUTHORIZATION Bearer Token

This request is using Bearer Token from folder Extensions

HEADERS

app-key {{api-key}}
Application key to authenticate requests
tenant {{tenant}}
Filter by tenant
Example Request
/extensions
Example Response
200 OK
 

GET /extensions/{id}/devices

http://{{host}}/api/v2/extensions/{{extension-id}}/devices

Retrive all devices for a specific extension

AUTHORIZATION Bearer Token

This request is using Bearer Token from folder Extensions

HEADERS

app-key {{api-key}}
tenant {{tenant}}
Example Request
200 – Devices retrieve
Example Response
200 OK
 

GET /extensions/{id}/queues

http://{{host}}/api/v2/extensions/{{extension-id}}/queues

Retrive queues info for an specific extension

AUTHORIZATION Bearer Token

This request is using Bearer Token from folder Extensions

HEADERS

app-key {{api-key}}
tenant {{tenant}}
Example Request
200 – Queues Info Retrieved
Example Response
200 OK
 

GET /extensions/{id}/cdr_summary

http://{{host}}/api/v2/extensions/{{extension-id}}/cdr_summary

Get cdr summary from a specific extension

AUTHORIZATION Bearer Token

This request is using Bearer Token from folder Extensions

HEADERS

app-key {{api-key}}
tenant {{tenant}}
Example Request
200 – CDR Summary
Example Response
200 OK
 

GET /extensions/{id}/voicemail_records

http://{{host}}/api/v2/extensions/{{extension-id}}/voicemail_records

Return all the voicemail records for an specific extension

AUTHORIZATION Bearer Token

This request is using Bearer Token from folder Extensions

HEADERS

app-key {{api-key}}
tenant {{tenant}}
Example Request
200 – Voicemail Recordings
Example Response
200 OK
 

Voicemail