Name
Type
Description
room
| Status | ||
|---|---|---|
|
Chat unique identifier
data
| Status | ||
|---|---|---|
|
Object containing message info. See message data object for more details.
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
_id |
| Internal object identifier | ||||
room |
| Chat unique identifier | ||||
ctlive_type |
| Chat type according to the initiator. Can be one of the following values: “chat” “cbn” “cbl” “cbfs” “call” | ||||
messages |
| Array containing chat messages. See Message Object for more details. |
Message Object
...
...
Name
...
Type
...
Description
...
id
...
| Status | ||
|---|---|---|
|
...
message unique identifier
...
messageType
...
| Status | ||
|---|---|---|
|
...
Type of the message. Can assume one of the following values:
“TEXT”
“IMAGE”
“DOCUMENT”
“LINK”
...
ts
...
| Status | ||
|---|---|---|
|
...
Timestamp of when message was sent
...
deliverySuccess
...
| Status | ||
|---|---|---|
|
...
Indicates whether the message was sent successfully
...
deliveryErrorReason
...
| Status | ||
|---|---|---|
|
...
Error occurred if the message was not sent correctly
...
replyTo
...
| Status | ||
|---|---|---|
|
...
Message ID you are replying to
...
content
...
| Status | ||
|---|---|---|
|
...
Message content. See message content object for more details.
Message Content Object
Name
Type
Description
text
| Status | ||
|---|---|---|
|
Only in “TEXT” message, contains the message sent
user
| Status | ||
|---|---|---|
|
Semplified user object containing only user id and isAgent properties of the user who sent the message.
url
| Status | ||
|---|---|---|
|
Example
| Code Block | ||
|---|---|---|
| ||
{
"_id" :"5d8dbcdaf6a71d3120275017 "CHAT_DEFAULT_8857106a-55b8-4c47-a5af-a3aae7530e5a",
"room" : "CHAT_DEFAULT_1c5e4ed88857106a-b67555b8-46f94c47-866e-b4fc1d893a72",a5af-a3aae7530e5a",
"ctlive_type" : "chat",
"messages" : [
{
"data" : {
"replyTo" : "",
"id" :"eee89a4f-8000-4589-a5ab-c52d3b520785", "aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEOjE3ODQxNDUwODQxMzk0OTA4OjM0MDI4MjM2Njg0MTcxMDMwMDk0OTEyODE2NzQwNTg4MTcxMjQ0NzozMDMwMDcwMTg3NTA5MTIwMjkwMzUzNDkzMzgzMjEwNTk4NAZDZD",
"messageType" : "TEXT",
"content" : {
"text" : "helloprova1",
"user" : {
"id" :"USER_gverde1@acd.enghouse.com", "4747235938674011",
"isAgent":true : false
}
},
"ts" :1569569940285 1642604343631.0,
} "deliverySuccess" : true,
"_id":"5d8dbcdaf6a71d312027501b", "deliveryErrorReason" : "",
"roommessageSeen":"CHAT_1c5e4ed8-b675-46f9-866e-b4fc1d893a72" : null
}, },
{ "data_id" :{ ObjectId("61e8277aef3d6b076066d287"),
"idroom" : "df7da65a-099b-40b4-a076-ff486b245afd",CHAT_DEFAULT_8857106a-55b8-4c47-a5af-a3aae7530e5a"
},
"messageType":"LINK",{
"contentdata" : {
"urlreplyTo" :"https://www.google.com/ "",
"userid" :{
"fb32e661-136d-4867-a1f8-a31eca5b673a",
"idmessageType" :"USER_c8e1eb84-60d3-4d69-b10b-96364845023e "TEXT",
"isAgentcontent" :false {
} "text" : "Buongiorno, sono l'operatore Gabriele Verde, come posso esserle }utile?",
"ts":1569569956940.0 "user" : {
}, "_id" :"5d8dbcdaf6a71d312027501a "USER_gverde1@acd.enghouse.com",
"room":"CHAT_1c5e4ed8-b675-46f9-866e-b4fc1d893a72" }, "isAgent" : {true
"data": { }
"id": "a94118a5-9536-4c8c-a3db-18d6a66673b2", "messageType": "IMAGE", },
"contentts" : {1642604351616.0,
"captiondeliverySuccess" : "AA"true,
"documentTypedeliveryErrorReason" : "png",
"usermessageSeen" : null
{ },
"_id" : "USER_gverde1@acd.enghouse.com"ObjectId("61e8277aef3d6b076066d288"),
"room" : "CHAT_DEFAULT_8857106a-55b8-4c47-a5af-a3aae7530e5a"
"isAgent": true },
{
} "data" : {
}, "tsreplyTo" : 1580293820154
"",
}, "_id": "5e315ece8a595c36a05b8de9",
"room": "CHAT_DEFAULT_990d3e8b-7b1d-402b-974b-69d57ba9eaae"ba35d81d-d56e-49b4-ae17-020b9e477281",
}, { "messageType" : "endChat",
"data": { "idts" : "615424ff-994e-4403-88a7-6113b9e56795"1642604409492.0,
"messageTypedeliverySuccess" : "DOCUMENT",true,
"contentdeliveryErrorReason" : {"",
"captionmessageSeen" : "BB",null
"documentTypecontent" : "pdf", {
"user" : {
"idisAgent" : "USER__eada93a1-5b87-41dd-aa81-e8f7b64d33da"true,
"isAgentid" : false "USER_gverde1@acd.enghouse.com"
} }
}, }
"ts": 1580293833802 },
}, "_id" : ObjectId("5e315ece8a595c36a05b8de861e8277aef3d6b076066d289"),
"room" : "CHAT_DEFAULT_990d3e8b8857106a-7b1d55b8-402b4c47-974ba5af-69d57ba9eaaea3aae7530e5a"
}
],
"__v" : 0
} |