Listen In Information

This request gets the listen in infromation of a specific channel.
A channel is 1 side of a call. Which can be requested from various API calls.
Listen in can be used to listen to an active call of a colleague.
The request returns some information about the call and (if listen in is possible) the extension that needs to be dialed to listen in.

Resource

GET /communications/listen_in_info

Parameters

Name Type Description

Name	Type	Description
`channel`	String	The channel name to listen in to

channel

String

The channel name to listen in to

Payload

An ListenInInfo object containing the listen in information of the selected channel.

Response

None

Context

Authorization

User

Errors

Common Errors

Example

Request

GET https://xelion.nl/api/v1/master/communications/listen_in_info?channel=SIP/wes-00000143

Response

{
    "object": {
        "listenInPossible": true,
        "listenInExtension": "_listenIn_SIP/wes-00000143",
        "addressable": {
            "commonName": "Wesley",
            "oid": "1650975",
            "objectType": "Person"
        },
        "callLog": {
            "participants": [],
            "commonName": "Wesley <- Xelion B.V., 2021-12-21",
            "oid": "2009120",
            "objectType": "CallLog"
        }
    },
    "links": [
        {
            "rel": "self",
            "href": "https://sip.xelion.nl/api/v1/master/communications/listen_in_info",
            "method": "GET"
        }
    ]
}