Create External Chat Session


This request creates a new external chat session and returns chat session information.
A phone line ID is needed to start the session. A list of phone lines can be foubd through the list phone lines request.

Resource

POST /chats/external_session

Parameters

None

Payload

None

Context

Authorization

Administrator

Errors

HTTP code Xelion code Description

404

10100

The phone line is not found.

Example

Request
POST https://xelion.nl/api/v1/master/chats/external_session
Payload
{
        "clientId":"external1",
        "phoneLine": {
                "oid":"1651226"
        }
}
Response
{
    "object": {
        "participants": [
            {
                "commonName": "Wesley",
                "oid": "1650975",
                "objectType": "Person"
            },
            {
                "commonName": "external1",
                "oid": "1896104",
                "objectType": "UnknownAddressable"
            }
        ],
        "sessionType": "external",
        "commonName": "<Unknown> <XCCChatSession>",
        "oid": "1896095",
        "objectType": "XCCChatSession"
    },
    "links": [
        {
            "rel": "self",
            "href": "https://xelion.nl/api/v1/master/chats/1896095",
            "method": "GET"
        }
    ]
}