List Active Channels
This request returns the current active channels on the PBX.
This can be used to set up a list with the current calls.
The callId identifies the call that is connected with the channel.
If you want to make sure the active call list stays up to date, open a web socket connection for active channel events.
Resource
GET /communications/active_channels
Parameters
None
Payload
None
Context
| Authorization |
User |
Errors
Example
Request
GET https://xelion.nl/api/v1/master/communications/active_channels
Response
{
"data": [
{
"object": {
"callId": "SIP/wes-000001d8",
"channelId": "SIP/wes-000001d8",
"state": "CONNECTED",
"name": "Wesley Klasen",
"role": "CALLER",
"phone": "wes",
"twinChannel": false
}
},
{
"object": {
"callId": "SIP/wes-000001d8",
"channelId": "SIP/arno-000001d9",
"state": "CONNECTED",
"name": "Arno Janssen",
"role": "CALLEE",
"phone": "arno",
"twinChannel": false
}
}
],
"meta": {
"links": [
{
"rel": "refresh",
"href": "https://xelion.nl/api/v1/master/communications/active_channels",
"method": "GET"
}
]
}
}