List Phone Channels


This request returns a list of phone channels.

A phone channel is created for each device participating in a call. When a call is initiated a channel is created for the caller. Another channel is created for each phone that is rang for answering the call. When the call is answered, the answering channel is linked to the caller channel and all other channels are hung-up.

Resource

GET /channels[?parameters]

Parameters

Name Type Description

with

[oid]

return channels of that addressable OID.

Payload

None

Response

Context

Authorization

User

Errors

Examples

List all active channels

Request
GET https://xelion.nl/api/v1/master/channels
Response
{
    "data": [
        {
            "object": {
                "channelId": "1536738562.289",
                "channelName": "SIP/sander-000000cd",
                "flowId": "2018-09-12-09:50:43-00000002",
                "state": "Up",
                "creationDate": "2018-09-12 07:50:43",
                "addressable": {
                    "commonName": "Sander Kloos",
                    "oid": "1557855",
                    "objectType": "Person"
                },
                "linkedChannelId": "1536738563.292"
            }
        },
        {
            "object": {
                "channelId": "1536738563.292",
                "channelName": "SIP/arnon-000000ce",
                "flowId": "2018-09-12-09:50:44-00000005",
                "state": "Up",
                "creationDate": "2018-09-12 07:50:43",
                "addressable": {
                    "commonName": "Arnon Ron",
                    "oid": "1556377",
                    "objectType": "Person"
                },
                "linkedChannelId": "1536738562.289"
            }
        }
    ],
    "meta": {
        "links": [
            {
                "rel": "refresh",
                "href": "http://xelion.nl/api/v1/master/channels",
                "method": "GET"
            }
        ]
    }
}