Reply Chat Communication


This request replies to a chat message inside a chat session.

Resource

POST /communications/chat/<OID>/reply

Where the OID is the object ID of the communication.

Parameters

None

Payload

Response

The Chat Message object contains the chat contents and the object ID.

Context

Authorization

User

Errors

HTTP code Xelion code Description

400

10203

Replied message cannot be found.

404

10066

Example

Request
POST https://xelion.nl/api/v1/master/communications/chat/1588675/reply

Send a plain text

Payload
{
        "clientId": "postman",
        "text": "hello there"
}
Response
{
    "object": {
        "subject": "hello there",
        "date": "2024-10-11 15:24:19",
        "contents": {
            "content": "hello there",
            "contentType": "",
            "oid": "4647701",
            "objectType": "Comment"
        },
        "durationSec": 0,
        "incoming": false,
        "retrieved": true,
        "displayed": true,
        "displayedUser": "",
        "flagged": false,
        "forwarded": false,
        "processed": false,
        "recordingStatus": "unknown",
        "hasAttachment": false,
        "hasInlineAttachment": false,
        "hasMessageReference": false,
        "contentSummary": "hello there",
        "contentSummaryIsComplete": true,
        "participants": [
            {
                "commonName": "Arno",
                "role": "rtFrom",
                "address": "",
                "addressable": {
                    "commonName": "Arno",
                    "oid": "1389401",
                    "objectType": "Person"
                },
                "addresseeLabel": "Arno",
                "person": {
                    "commonName": "Arno",
                    "oid": "1389401",
                    "objectType": "Person"
                },
                "oid": "4647702",
                "objectType": "Addressee"
            },
            {
                "commonName": "Haas",
                "role": "rtTo",
                "address": "",
                "addressable": {
                    "iconId": "4435216",
                    "commonName": "Haas",
                    "oid": "1815710",
                    "objectType": "Person"
                },
                "addresseeLabel": "Haas",
                "person": {
                    "commonName": "Haas",
                    "oid": "1815710",
                    "objectType": "Person"
                },
                "oid": "4647703",
                "objectType": "Addressee"
            }
        ],
        "voicemail": false,
        "voicemailIsHeard": false,
        "callId": "",
        "id": "ce446930aee57b45",
        "callFlowId": "",
        "phone": "",
        "isConferenceCall": false,
        "callAnswerTimeSec": 0,
        "onHoldDuration": 0,
        "trunk": "",
        "phoneLine": {
            "permissions": "ReadWriteRemove",
            "commonName": "Telefoonaansluiting Arno",
            "oid": "1389593",
            "objectType": "XCCPhoneLine"
        },
        "wrapUpTime": 0,
        "chatSessionType": "user",
        "whatsAppTemplateCategory": "",
        "original": {
            "participants": [],
            "permissions": "ReadWriteRemove",
            "commonName": "Arno -> Haas, 2024-10-11",
            "oid": "4647666",
            "objectType": "XCCUserChat"
        },
        "transferredFromName": "",
        "transferredToName": "",
        "chatSession": {
            "permissions": "ReadWriteRemove",
            "commonName": "Chat Haas <->Telefoonaansluiting Arno",
            "oid": "1935036",
            "objectType": "XCCChatSession"
        },
        "afterCallType": "",
        "packetsLog": [],
        "permissions": "ReadWriteRemove",
        "commonName": "Arno -> Haas, 2024-10-11",
        "oid": "4647700",
        "objectType": "XCCUserChat"
    }
}