Create External Chat Gateway

User Guide > Create external chat gateway

This request adds an external chat gateway to the database.

Resource

POST /externalchatgateways

Parameters

Common Create Parameters

Payload

External Chat Gateway

Response

Object Response < ExternalChatGateway > The created object.

Context

Authorization

Administration

Errors

Common Errors

Example

Request
POST https://xelion.nl/api/v1/master/externalchatgateways
Payload
{
    "identity": "test2",
    "transcriptEmailSender": {
        "address": "info@xelion.nl"
    },
    "transcriptEmailSubject": "Transcription of chat",
    "transcriptEmailText": "Hello, here is your transcript.\n\nGreetings,\nXelion",
    "transcriptTitle": "Transcript of chat",
    "transcriptLocale": {
        "oid": "1001309",
        "objectType": "Locale"
    },
    "active": true,
    "traceIncoming": true,
    "traceOutgoing": true,
    "phoneLine": {
        "oid": "1651614",
        "objectType": "XCCPhoneLine"
    },
    "xelionAuthToken": "sadf89aew934hf4h98aw",
    "commonName": "test2",
    "objectType": "ExternalChatGateway"
}
Response
{
    "object": {
        "identity": "test2",
        "transcriptEmailSender": {
            "commonName": "info@xelion.nl",
            "addressType": "Email",
            "address": "info@xelion.nl",
            "label": "",
            "orderNumber": 0,
            "oid": "2053751",
            "objectType": "TelecomAddress"
        },
        "transcriptEmailSubject": "Transcription of chat",
        "transcriptEmailText": "Hello, here is your transcript.\n\nGreetings,\nXelion",
        "transcriptTitle": "Transcript of chat",
        "transcriptLocale": {
            "permissions": "ReadWriteRemove",
            "commonName": "English (United Kingdom)",
            "oid": "1001309",
            "objectType": "Locale"
        },
        "active": true,
        "traceIncoming": true,
        "traceOutgoing": true,
        "traces": [],
        "phoneLine": {
            "permissions": "ReadWriteRemove",
            "commonName": "Support",
            "x1syncid": "Support",
            "x1syncsource": "csv",
            "oid": "1651614",
            "objectType": "XCCPhoneLine"
        },
        "xelionAuthToken": "sadf89aew934hf4h98aw",
        "permissions": "ReadWriteRemove",
        "commonName": "test2",
        "oid": "2053747",
        "objectType": "ExternalChatGateway"
    },
    "links": [
        {
            "rel": "self",
            "method": "GET"
        }
    ]
}