Name | Type | Description |
|---|
room |
|
|
Chat unique identifier |
data |
|
| Object containing message info. See message data object for more details. |
Message Data Object
Name | Type | Description | ||
|---|---|---|---|---|
id |
|
|
message unique identifier | ||||
messageType |
|
| Type of the message. Can assume one of the following values: “TEXT” “IMAGE” “DOCUMENT” “LINK” “AUDIO” “VIDEO” “MENU” “MENU_RESPONSE” “QUICK_REPLY” “QUICK_REPLY_RESPONSE” “FORM” “FORM_RESPONSE” “REACTION” “CONTACTS” “LOCATION” “videoRequestedByAgent” “videoRequestedByCustomer” “videoAccepted” “videoRejected” “videoStarted” “videoEnded” “screenSharingStarted” “screenSharingEnded” “endChat” “leave” | |||
ts |
|
| Timestamp of when message was sent |
deliverySuccess |
| Indicates if the |
message has been succesfully delivered | ||||
deliveryErrorReason |
|
user unique identifier
| In case of delivery failed, describes the error occurred | |||
messageSeen |
|
|
/ |
text
|
Only in “TEXT” message, contains the message sent
| Timestamp of when the message was seen by the recipient | ||||
replyTo |
|
Contains base64 image message
Message ID you are replying to | ||||
content |
|
| Message content. See message content object for more details. |
Message
...
documentType
...
| Status | ||
|---|---|---|
|
...
Document format
...
Content Object
The structure of the message content depends on the messageType property
Text message
Name | Type | Description | ||
|---|---|---|---|---|
text |
|
Contains name of the document/image message
| Only in “TEXT” message, contains the message sent | |||
user |
|
Contains the url of the link message
deliverySuccess
| Status | ||
|---|---|---|
|
Indicates if the message has been succesfully delivered
deliveryErrorReason
| Status | ||
|---|---|---|
|
In case of delivery failed, describes the error occurred
Name
Type
Description
room
| Status | ||
|---|---|---|
|
Chat unique identifier
data
| Status | ||
|---|---|---|
|
Object containing message info. See message data object for more details.
Message Data 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”
“videoRequestedByAgent”
“videoRequestedByCustomer”
“videoAccepted”
“videoRejected”
“videoStarted”
“videoEnded”
“screenSharingStarted”
“screenSharingEnded”
“endChat”
“leave”
...
ts
...
| Status | ||
|---|---|---|
|
...
Timestamp of when message was sent
...
deliverySuccess
...
| Status | ||
|---|---|---|
|
...
Indicates if the message has been succesfully delivered
...
deliveryErrorReason
...
| Status | ||
|---|---|---|
|
...
In case of delivery failed, describes the error occurred
...
replyTo
...
| Status | ||
|---|---|---|
|
...
Message ID you are replying to
...
content
...
| Status | ||
|---|---|---|
|
...
Message content. See message content object for more details.
Message Content Object
The structure of the message content depends on the messageType property
Text message
...
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.
Example
...
| language | json |
|---|
...
| Semplified user object containing only user id and isAgent properties of the user who sent the message. |
Example
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"replyTo" : "",
"id" : "e857df30-76a4-4c6c-b4a5-4faed2ed6f45",
"messageType" : "TEXT",
"content" : {
"text" : "Buongiorno, sono l'operatore Gabriele Verde, come posso esserle utile?",
"user" : {
"id" : "USER_gverde1@acd.enghouse.com",
"isAgent" : true
}
},
"ts" : 1643191581119.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null
},
"_id" : ObjectId("61f11d7cd42454470cb22da4"),
"room" : "CHAT_DEFAULT_a098a0bc-b34c-452c-829c-1b03aa7a67ee"
} |
Image message
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
caption |
| Message caption | ||||
fileName |
| Contains name of the document/image message | ||||
documentType |
| Document format | ||||
user |
| Semplified user object containing only user id and isAgent properties of the user who sent the message. |
Example
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"replyTo" : "",
"id" : "03250778-0425-47c1-92c1-85d1840bef7c",
"messageType" : "IMAGE",
"content" : {
"caption" : "",
"fileName" : "45971097-illustrazione-di-happy-emoticon-dà-pollice-in-su-isolato-su-sfondo-bianco.jpg",
"documentType" : "jpg",
"user" : {
"id" : "USER_DEFAULT_9a0a411c-f9c7-4af7-9754-024bf157a3ef",
"isAgent" : false
}
},
"ts" : 1643191627987.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null
},
"_id" : ObjectId("61f11d7cd42454470cb22da5"),
"room" : "CHAT_DEFAULT_a098a0bc-b34c-452c-829c-1b03aa7a67ee"
} |
Document message:
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
caption |
| Message caption | ||||
fileName |
| Contains name of the document/image message | ||||
documentType |
| Document format | ||||
user |
| Semplified user object containing only user id and isAgent properties of the user who sent the message. |
Example
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"replyTo" : "",
"id" : "16daf4d4-a77f-406f-ab75-0475f510bc95",
"messageType" : "DOCUMENT",
"content" : {
"caption" : "",
"fileName" : "WHATSAPP-TEMPLATE-AD-v09.xlsx",
"documentType" : "xlsx",
"user" : {
"id" : "USER_gverde1@acd.enghouse.com",
"isAgent" : true
}
},
"ts" : 1643191652417.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null
},
"_id" : ObjectId("61f11d7cd42454470cb22da6"),
"room" : "CHAT_DEFAULT_a098a0bc-b34c-452c-829c-1b03aa7a67ee"
} |
Video message:
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
caption |
| Message caption | ||||
fileName |
| Contains name of the document/image message | ||||
documentType |
| Document format | ||||
user |
| Semplified user object containing only user id and isAgent properties of the user who sent the message. |
Example
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"replyTo" : "",
"id" : "m_dXya7ckVUHyYxQHcQrrdgT2MVSImQFjQ7aCDxA_Mxf7AeR9GMI0vDs2dy2PKgTjE24tQrJImLWYnR5hgtpt7Uw",
"messageType" : "VIDEO",
"content" : {
"caption" : "",
"fileName" : "video.mp4",
"documentType" : "mp4",
"user" : {
"id" : "4149729381806003",
"isAgent" : false
}
},
"ts" : 1643207226322.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null
},
"_id" : ObjectId("61f15a4c932c660c83d5e229"),
"room" : "CHAT_DEFAULT_06b6ace1-a923-4657-876b-c6432729610d"
} |
Audio message:
caption |
| Message caption | ||||
fileName |
| Contains name of the document/image message | ||||
documentType |
| Document format | ||||
user |
| Semplified user object containing only user id and isAgent properties of the user who sent the message. |
Example
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"replyTo" : "",
"id" : "m_JLR7O2EHIE6d3fiskFBiqz2MVSImQFjQ7aCDxA_Mxf6hm6TYUaJKXiEqfYgCX8WKxriZux06OzPB8XLZa8yNKA",
"messageType" : "AUDIO",
"content" : {
"caption" : "",
"fileName" : "audioclip-1643206881000-5760.mp4",
"documentType" : "mp4",
"user" : {
"id" : "4149729381806003",
"isAgent" : false
}
},
"ts" : 1643206886118.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null
},
"_id" : ObjectId("61f158ee932c660c83d5e1fa"),
"room" : "CHAT_DEFAULT_24ec70f1-b92d-44c4-94ad-49bcd15986ea"
} |
Link message:
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
url |
| Contains the url of the link message | ||||
user |
| Semplified user object containing only user id and isAgent properties of the user who sent the message. |
Example
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"replyTo" : "",
"id" : "17909c52-1f26-402c-90cb-3106ba80bb3b",
"messageType" : "LINK",
"content" : {
"url" : "https://www.google.it",
"user" : {
"id" : "USER_gverde1@acd.enghouse.com",
"isAgent" : true
}
},
"ts" : 1643191666618.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null
},
"_id" : ObjectId("61f11d7cd42454470cb22da7"),
"room" : "CHAT_DEFAULT_a098a0bc-b34c-452c-829c-1b03aa7a67ee"
} |
Menu message (bot):
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
text |
| Menu title | ||||
options |
| Array of objects for the various possibilities of choice. See the next section for more details. | ||||
user |
| Semplified user object containing only user id and isAgent properties of the user who sent the message. |
option object:
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
id |
| Unique option id | ||||
command |
| Menu action. Can assume one of the following values:
| ||||
text |
| label shown in the option | ||||
targetUrl |
| text to send as a next query to the bot | ||||
params |
| array of two objects that specify how to open the external url. The first object has two properties:
The second object has two properties:
|
Example
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"replyTo" : "",
"id" : "d77210fa-4aa2-4876-8fcc-8eaf43122987",
"messageType" : "MENU",
"content" : {
"text" : "Scegli un'opzione:",
"options" : [
{
"id" : 0,
"command" : "load-item",
"text" : "prenotazione volo",
"targetUrl" : "vorrei prenotare un volo"
},
{
"id" : 1,
"command" : "open-url",
"params" : [
{
"name" : "method",
"text" : "GET"
},
{
"name" : "where",
"text" : "_blank"
}
],
"text" : "google",
"targetUrl" : "https://www.google.it"
},
{
"id" : 2,
"command" : "open-url",
"params" : [
{
"name" : "method",
"text" : "GET"
},
{
"name" : "where",
"text" : "_blank"
}
],
"text" : "enghouse",
"targetUrl" : "https://enghouseinteractive.it/"
}
],
"user" : {
"id" : "BOT_BOT1",
"isAgent" : true
}
},
"ts" : 1655210172935.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null
},
"_id" : ObjectId("62a880c20ece623848eb290a"),
"room" : "CHAT_DEFAULT_84afbdd3-a4be-4057-ae49-32edc6802658"
} |
Menu response message (bot):
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
menuId |
| Id of the “MENU” message which was replied to | ||||
option |
| Response that was chosen by the user. See the next section for more details | ||||
user |
| Semplified user object containing only user id and isAgent properties of the user who sent the message. |
option object:
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
id |
| Id of the response chosen | ||||
targetUrl |
| query sent to the bot |
Example
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"replyTo" : "",
"id" : "fdaa821a-4355-4f3a-9507-1184c3285701",
"messageType" : "MENU_RESPONSE",
"content" : {
"menuId" : "d77210fa-4aa2-4876-8fcc-8eaf43122987",
"option" : {
"id" : 0,
"targetUrl" : "vorrei prenotare un volo"
},
"user" : {
"id" : "USER_DEFAULT_9a0a411c-f9c7-4af7-9754-024bf157a3ef",
"isAgent" : false
}
},
"ts" : 1655210175559.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null
},
"_id" : ObjectId("62a880c20ece623848eb290b"),
"room" : "CHAT_DEFAULT_84afbdd3-a4be-4057-ae49-32edc6802658"
} |
Quick reply message (bot):
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
text |
| Title of the quick reply | ||||
header |
| header of the quick reply | ||||
footer |
| footer of the quick reply | ||||
quickReplies |
| array of strings containing the options (max 3 allowed) | ||||
user |
| Semplified user object containing only user id and isAgent properties of the user who sent the message. |
Example
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"replyTo" : "",
"id" : "5bd5fcd0-ee5e-48c9-b825-c3e42b85cc45",
"messageType" : "QUICK_REPLY",
"content" : {
"text" : "Do you want to continue?",
"quickReplies" : [
"No",
"Yes",
"Help"
],
"header" : "Cool Title!",
"footer" : "Cool Footer!",
"user" : {
"id" : "BOT_BOT1",
"isAgent" : true
}
},
"ts" : 1679325011759.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null
},
"room" : "CHAT_DEFAULT_e7473a4a-88c7-415d-957b-01aac31673c0"
} |
Quick reply response message (bot):
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
quickReplyId |
| id of the quick reply message whose response is referring to | ||||
reply |
| quick reply chosen | ||||
user |
| Semplified user object containing only user id and isAgent properties of the user who sent the message. |
Example
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"replyTo" : "",
"id" : "wamid.HBgMMzkzNDAzNjA5MTY5FQIAEhggMUM2MjFFNDYxMjIwRTYyQkNGRUVEMEVGMDE5RUVEQTcA",
"messageType" : "QUICK_REPLY_RESPONSE",
"content" : {
"quickReplyId" : "5bd5fcd0-ee5e-48c9-b825-c3e42b85cc45",
"reply" : "Yes",
"user" : {
"id" : "393403602702",
"isAgent" : false
}
},
"ts" : 1679325017885.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null
},
"room" : "CHAT_DEFAULT_e7473a4a-88c7-415d-957b-01aac31673c0"
} |
Form message (bot):
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
title |
| title fo the form | ||||
response_to_bot |
| query sent back to the bot after the form is submitted | ||||
formData |
| array of objects that defines the form fields. The object has the same properties of the data collection object Data Collection Object | ||||
user |
| Semplified user object containing only user id and isAgent properties of the user who sent the message. |
Example
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"replyTo" : "",
"id" : "f3f3352c-7f50-43c6-9dd8-7db3fa44ce8c",
"messageType" : "FORM",
"content" : {
"title" : "Titolo Form",
"response_to_bot" : "ciao",
"formData" : [
{
"value" : "",
"label" : "Società",
"customMandatoryErrorMessage" : "Campo obbligatorio",
"isMandatory" : true,
"custom_regexp" : "",
"customValidationErrorMessage" : "",
"mode" : "manual",
"isEditable" : true,
"isVisibleCustomer" : true,
"isVisibleAgent" : true,
"name" : "company",
"dc_type" : "text"
},
{
"label" : "Indirizzo",
"custom_regexp" : "",
"name" : "address",
"isEditable" : true,
"customMandatoryErrorMessage" : "Indirizzo obbligatorio",
"isVisibleCustomer" : true,
"isVisibleAgent" : true,
"mode" : "manual",
"value" : "",
"dc_type" : "text",
"isMandatory" : true,
"customValidationErrorMessage" : ""
},
{
"value" : "",
"dc_type" : "email",
"isVisibleCustomer" : true,
"mode" : "manual",
"isMandatory" : true,
"isVisibleAgent" : true,
"customMandatoryErrorMessage" : "Email obbligatoria",
"custom_regexp" : ".*@.*",
"customValidationErrorMessage" : "Email non valida",
"label" : "Email",
"name" : "email2",
"isEditable" : true
},
{
"options" : {
"mattina" : "Mattina",
"pomeriggio" : "Pomeriggio"
},
"name" : "fascia",
"isMandatory" : true,
"dc_type" : "select",
"value" : "",
"isVisibleCustomer" : true,
"customValidationErrorMessage" : "",
"isEditable" : true,
"mode" : "manual",
"customMandatoryErrorMessage" : "Fascia richiamo obbligatoria",
"isVisibleAgent" : true,
"custom_regexp" : "",
"label" : "Quando vuoi essere richiamato?"
}
],
"user" : {
"id" : "BOT_BOT1",
"isAgent" : true
}
},
"ts" : 1679325464928.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null
},
"room" : "CHAT_DEFAULT_df3b98ab-4a53-4d1f-8138-c3b45a58c9a0"
} |
Form response message (bot):
The form response message has the same structure of the form message, with the addition that the field “value” is filled with the customer response.
Example
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"replyTo" : "",
"id" : "1601da67-ccf3-495e-b86b-3c51bae8789d",
"messageType" : "FORM_RESPONSE",
"content" : {
"title" : "Titolo Form",
"response_to_bot" : "ciao",
"formData" : [
{
"value" : "Enghouse",
"label" : "Società",
"customMandatoryErrorMessage" : "Campo obbligatorio",
"isMandatory" : true,
"custom_regexp" : "",
"customValidationErrorMessage" : "",
"mode" : "manual",
"isEditable" : true,
"isVisibleCustomer" : true,
"isVisibleAgent" : true,
"name" : "company",
"dc_type" : "text"
},
{
"label" : "Indirizzo",
"custom_regexp" : "",
"name" : "address",
"isEditable" : true,
"customMandatoryErrorMessage" : "Indirizzo obbligatorio",
"isVisibleCustomer" : true,
"isVisibleAgent" : true,
"mode" : "manual",
"value" : "Viale Sarca 336, edificio 12",
"dc_type" : "text",
"isMandatory" : true,
"customValidationErrorMessage" : ""
},
{
"value" : "legal.operations@enghouse.com",
"dc_type" : "email",
"isVisibleCustomer" : true,
"mode" : "manual",
"isMandatory" : true,
"isVisibleAgent" : true,
"customMandatoryErrorMessage" : "Email obbligatoria",
"custom_regexp" : ".*@.*",
"customValidationErrorMessage" : "Email non valida",
"label" : "Email",
"name" : "email2",
"isEditable" : true
},
{
"options" : {
"mattina" : "Mattina",
"pomeriggio" : "Pomeriggio"
},
"name" : "fascia",
"isMandatory" : true,
"dc_type" : "select",
"value" : "mattina",
"isVisibleCustomer" : true,
"customValidationErrorMessage" : "",
"isEditable" : true,
"mode" : "manual",
"customMandatoryErrorMessage" : "Fascia richiamo obbligatoria",
"isVisibleAgent" : true,
"custom_regexp" : "",
"label" : "Quando vuoi essere richiamato?"
}
],
"user" : {
"id" : "USER_DEFAULT_9a0a411c-f9c7-4af7-9754-024bf157a3ef",
"isAgent" : false
}
},
"ts" : 1679325479470.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null
},
"_id" : ObjectId("64187943bb85a6727df80efc"),
"room" : "CHAT_DEFAULT_df3b98ab-4a53-4d1f-8138-c3b45a58c9a0"
} |
Reaction message:
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
emoji |
| emoji sent | ||||
user |
| Semplified user object containing only user id and isAgent properties of the user who sent the message. |
Example
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"replyTo" : "223908fd-93ce-432d-b3b2-0b4f90b70c74",
"id" : "wamid.HBgMMzkzNDAzNjA5MTY5FQIAEhggMTdBREMzMjJGRjJDRDU2RjY5NUVFMDM4RDBFQTBBQTQA",
"messageType" : "REACTION",
"content" : {
"emoji" : "👍🏻",
"user" : {
"id" : "393403609169",
"isAgent" : false
}
},
"ts" : 1679329738463.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null
},
"room" : "CHAT_DEFAULT_c1201fe5-e653-4540-a766-b583bfeb4c8c"
} |
Contacts message:
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
contacts |
| array of objects representing the contact. See the table below for the properties of the contact object. | ||||
user |
| Semplified user object containing only user id and isAgent properties of the user who sent the message. |
option object:
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
name |
| object containing the name of the contact. See table below for details. | ||||
phones |
| Array of objects containing the phone numbers of the contact. See table below |
name object:
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
first_name |
| contact name | ||||
formatted_name |
| contact formatted name |
phone object:
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
phone |
| phone number | ||||
wa_id |
| whatsapp id | ||||
type |
| phone type |
Example
| Code Block | ||
|---|---|---|
| ||
{ "data" : { "replyTo" : "", "id" : "wamid.HBgMMzkzNDAzNjA5MTY5FQIAEhggMUMzQUREMEI1NzAzMDkyOTc1NTUwOUVBNERENkM0QTUA", "messageType" : "CONTACTS", "content" : { "contacts" : [ { "name" : { "first_name" : "Felice Griffi", "formatted_name" : "Felice Griffi" }, "phones" : [ { "phone" : "+39 339 366 9393", "wa_id" : "393393669393", "type" : "Cellulare" } ] }, { "name" : { "first_name" : "Giulia Cavazzana", "formatted_name" : "Giulia Cavazzana" }, "messageTypephones" : "TEXT", [ "content" : { "text" : "Buongiorno, sono l'operatore Gabriele{ Verde, come posso esserle utile?", "user" : { "idphone" : "USER_gverde1@acd.enghouse.com", +39 039 606 6024", "isAgent" : true } "type" },: "Casa" "ts" : 1643191581119.0, "deliverySuccess" : true, "deliveryErrorReason" : "" }, }, "_id" : ObjectId("61f11d7cd42454470cb22da4"), "room" : "CHAT_DEFAULT_a098a0bc-b34c-452c-829c-1b03aa7a67ee" } |
Image message
...
Name
...
Type
...
Description
...
caption
...
| Status | ||
|---|---|---|
|
...
Message caption
...
fileName
...
| Status | ||
|---|---|---|
|
...
Contains name of the document/image message
...
documentType
...
| Status | ||
|---|---|---|
|
...
Document format
...
user
...
| Status | ||
|---|---|---|
|
...
Semplified user object containing only user id and isAgent properties of the user who sent the message.
Example
...
| language | json |
|---|
{ " |
...
phone" : |
...
"+39 347 192 6356", " |
...
wa_id" : "393471926356", |
...
"type" : " |
...
Cellulare" |
...
|
...
|
...
} |
...
|
...
|
...
|
...
|
...
|
...
] |
...
|
...
|
...
} |
...
|
...
|
...
], "user" : { "id" : " |
...
393403609169", "isAgent" : false } }, "ts" : |
...
1679329765410.0, "deliverySuccess" : true, "deliveryErrorReason" : "", |
...
"messageSeen" : null |
...
|
...
}, "room" : "CHAT_DEFAULT_ |
...
c1201fe5- |
...
e653- |
...
4540- |
...
a766- |
...
b583bfeb4c8c" } |
...
Location message:
Name | Type | Description |
|---|
latitude |
| latitude coordinate | ||||
longitude |
|
|
longitude coordinate |
name |
|
Contains name of the document/image message
location name | |||||
url |
|
location public url | ||||||
user |
| Semplified user object containing only user id and isAgent properties of the user who sent the message. |
Example
| Code Block | ||||
|---|---|---|---|---|
| {
"data" : {
"replyTo" : "",
"id" : "16daf4d4-a77f-406f-ab75-0475f510bc95",||||
{ "messageType" : "DOCUMENT", "contentdata" : { "captionreplyTo" : "", "fileNameid" : "WHATSAPP-TEMPLATE-AD-v09.xlsxwamid.HBgMMzkzNDAzNjA5MTY5FQIAEhggNDIzQTgwNjQ5QzFCMkNFRDI1MzA5QTQzQjEyQzM3MTkA", "documentType" : "xlsx", "user"messageType" : {"LOCATION", "idcontent" : "USER_gverde1@acd.enghouse.com",{ "isAgent" : true "address" : "Via pascoli, Bellusco, Lombardia", } }, "tslatitude" : 164319165241745.0618205788846, "deliverySuccess" : true, "deliveryErrorReasonlongitude" : ""9.4231867131938, }, "_id" : ObjectId("61f11d7cd42454470cb22da6"), "roomname" : "CHAT_DEFAULT_a098a0bc-b34c-452c-829c-1b03aa7a67ee" } |
Link message:
...
Name
...
Type
...
Description
...
url
...
| Status | ||
|---|---|---|
|
...
Contains the url of the link message
...
user
...
| Status | ||
|---|---|---|
|
...
Semplified user object containing only user id and isAgent properties of the user who sent the message.
Example
| Code Block | ||
|---|---|---|
| ||
{Centro sportivo bellusco", "data" : { "replyTourl" : "https://foursquare.com/v/4cf222607bf3b60c0b28647f", "id "user" : "17909c52-1f26-402c-90cb-3106ba80bb3b", { "messageTypeid" : "LINK393403609169", "content" : { "urlisAgent" : "https://www.google.it", false "user" : { } "id" : "USER_gverde1@acd.enghouse.com" }, "isAgentts" : true 1679329786335.0, "deliverySuccess" }: true, }, "tsdeliveryErrorReason" : 1643191666618.0"", "deliverySuccess "messageSeen" : true, null }, "deliveryErrorReason" : "" }, "_id" : ObjectId("61f11d7cd42454470cb22da7641889f6bb85a6727df80f7b"), "room" : "CHAT_DEFAULT_a098a0bcc1201fe5-b34ce653-452c4540-829ca766-1b03aa7a67eeb583bfeb4c8c" } |
...
Video chat events messages:
All video chat events messages have the audio and video boolean properties to indicate the channel used.
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
audio |
| if true the audio chennel is engaged | ||||
video |
| if true the video chennel is engaged |
Examples
videoRequestedByCustomer message
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"id" : "c6d3e132-4432-4208-943d-cc2b34ba3107",
"messageType" : "videoRequestedByCustomer",
"ts" : 1617786830148.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null,
"content" : {
"user" : {
"isAgent" : false,
"id" : "USER_DEFAULT_9a0a411c-f9c7-4af7-9754-024bf157a3ef"
},
"audio" : true,
"video" : true
}
},
"_id" : ObjectId("606d7810d6e88353f88732a1"),
"room" : "CHAT_DEFAULT_d06723cf-518e-4767-99b6-6d21d5998081"
} |
...
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"id" : "715a2213-3123-4718-8266-a489bebc493b",
"messageType" : "videoAccepted",
"ts" : 1617786834240.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null,
"content" : {
"user" : {
"isAgent" : true,
"id" : "USER_gverde1@acd.enghouse.com"
},
"audio" : true,
"video" : true
}
},
"_id" : ObjectId("606d7810d6e88353f88732a0"),
"room" : "CHAT_DEFAULT_d06723cf-518e-4767-99b6-6d21d5998081"
} |
...
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"id" : "cfa53427-1ee7-4e8f-9848-e8e87523aec4",
"messageType" : "videoStarted",
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null,
"ts" : 1617786839849.0,
"content" : {
"user" : {
"isAgent" : true,
"id" : "USER_gverde1@acd.enghouse.com"
},
"audio" : true,
"video" : true
}
},
"_id" : ObjectId("606d7810d6e88353f887329f"),
"room" : "CHAT_DEFAULT_d06723cf-518e-4767-99b6-6d21d5998081"
} |
...
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"id" : "227130be-f490-4ef2-9923-9bb69ad6756c",
"messageType" : "screenSharingStarted",
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null,
"ts" : 1617786873764.0,
"content" : {
"user" : {
"isAgent" : true,
"id" : "USER_gverde1@acd.enghouse.com"
},
"audio" : true,
"video" : true
}
},
"_id" : ObjectId("606d7810d6e88353f887329c"),
"room" : "CHAT_DEFAULT_d06723cf-518e-4767-99b6-6d21d5998081"
} |
...
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"id" : "a8ffdf71-ad3e-4495-ba91-057442df88c0",
"messageType" : "videoEnded",
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null,
"ts" : 1617786886374.0,
"content" : {
"user" : {
"isAgent" : true,
"id" : "USER_gverde1@acd.enghouse.com"
},
"audio" : true,
"video" : true
}
},
"_id" : ObjectId("606d7810d6e88353f887329a"),
"room" : "CHAT_DEFAULT_d06723cf-518e-4767-99b6-6d21d5998081"
} |
endChat message:
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
user |
| Semplified user object containing only user id and isAgent properties of the user who sent the message. |
Example
| Code Block | ||
|---|---|---|
| ||
{
"data" : {
"id" : "b88d3de0-23b8-41d1-95c3-1209dd4c8cff",
"messageType" : "endChat",
"ts" : 1617786896642.0,
"deliverySuccess" : true,
"deliveryErrorReason" : "",
"messageSeen" : null,
"content" : {
"user" : {
"isAgent" : false,
"id" : "USER_DEFAULT_9a0a411c-f9c7-4af7-9754-024bf157a3ef"
}
}
},
"_id" : ObjectId("606d7810d6e88353f8873297"),
"room" : "CHAT_DEFAULT_d06723cf-518e-4767-99b6-6d21d5998081"
} |