Forward Chat Message
This request forwards a chat message to a chat session.
Resource
POST /chats/<OID>/messages/<OID>/forward
Where the first OID
is the object ID of the chat session and the second 'OID' is the object ID of the chat object.
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 |
Forwarded message cannot be found. |
404 |
10066 |
Example
Request
POST https://xelion.nl/api/v1/master/chats/1588675/messages/147781/forward
Send a plain text
Payload
{
"chatSession": {
"oid": "1895315"
},
"clientId": "postman"
}
Response
{
"object": {
"subject": "we need a bigger boat",
"date": "2024-10-11 15:20:42",
"contents": {
"content": "we need a bigger boat",
"contentType": "",
"oid": "4647667",
"objectType": "Comment"
},
"durationSec": 0,
"incoming": false,
"retrieved": true,
"displayed": true,
"displayedUser": "",
"flagged": false,
"forwarded": true,
"processed": false,
"recordingStatus": "unknown",
"hasAttachment": false,
"hasInlineAttachment": false,
"hasMessageReference": false,
"contentSummary": "we need a bigger boat",
"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": "4647668",
"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": "4647669",
"objectType": "Addressee"
}
],
"voicemail": false,
"voicemailIsHeard": false,
"callId": "",
"id": "d9c2cbbde7cdd747",
"callFlowId": "",
"phone": "",
"isConferenceCall": false,
"callAnswerTimeSec": 0,
"onHoldDuration": 0,
"trunk": "",
"phoneLine": {
"permissions": "ReadWriteRemove",
"commonName": "Arno",
"oid": "1389593",
"objectType": "XCCPhoneLine"
},
"wrapUpTime": 0,
"chatSessionType": "user",
"whatsAppTemplateCategory": "",
"transferredFromName": "",
"transferredToName": "",
"chatSession": {
"permissions": "ReadWriteRemove",
"commonName": "Chat Haas <-> Arno",
"oid": "1935036",
"objectType": "XCCChatSession"
},
"afterCallType": "",
"packetsLog": [],
"permissions": "ReadWriteRemove",
"commonName": "Arno -> Haas, 2024-10-11",
"oid": "4647666",
"objectType": "XCCUserChat"
}
}