Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Type

Description

_id

Status
titleSTRING

Internal object identifier

room

Status
titleSTRING

Chat unique identifier

messages

Status
title

ARRAY

Array containing chat multimedia messages

id [message object]

Status
titleSTRING

message unique identifier

img

Status
titlestring

Base64 of the image

document

Status
titlestring

Base64 of the document

caption

Status
titlestring

file caption

fileName

Status
titlestring

Contains name of the document/image message

documentType

Status
titleSTRING

Document format

id [user object]

Status
titleSTRING

user unique identifier

isAgent

Status
titleBOOLEAN

Indicates if the person who sent the message is an agent

Name

Type

Description

_id

Status
titleSTRING

Internal object identifier

room

Status
titleSTRING

Chat unique identifier

messages

Status
titlearray

Array containing multimedia chat messages. See Multimedia Message Object for more details

...

Code Block
languagejson
{
    "_id" : ObjectId("61f11d7cd42454470cb22dab"),
    "room" : "CHAT_DEFAULT_a098a0bc-b34c-452c-829c-1b03aa7a67ee",
    "id" : "16daf4d4-a77f-406f-ab75-0475f510bc95",
    "content" : {
        "document" : { "$binary" : "UEsDBBQABgAIAAAAIQDMkURCrQEAAL0HAAATAA....", "$type" : "00" },
        "caption" : "",
        "fileName" : "WHATSAPP-TEMPLATE-AD-v09.xlsx",
        "documentType" : "xlsx",
        "user" : {
            "id" : "USER_gverde1@acd.enghouse.com",
            "isAgent" : true
        }
    }
}

Audio message

Name

Type

Description

audio

Status
titlestring

Base64 of the audio

fileName

Status
titlestring

Contains name of the image message

caption

Status
titlestring

file caption

documentType

Status
titleSTRING

Document format

user

Status
titleobject

Semplified user object containing only user id and isAgent properties of the user who sent the message.

Example

Code Block
languagejson
{
    "_id" : ObjectId("61f158ee932c660c83d5e201"),
    "room" : "CHAT_DEFAULT_24ec70f1-b92d-44c4-94ad-49bcd15986ea",
    "id" : "m_JLR7O2EHIE6d3fiskFBiqz2MVSImQFjQ7aCDxA_Mxf6hm6TYUaJKXiEqfYgCX8WKxriZux06OzPB8XLZa8yNKA",
    "content" : {
        "caption" : "",
        "fileName" : "audioclip-1643206881000-5760.mp4",
        "documentType" : "mp4",
        "user" : {
            "id" : "4149729381806003",
            "isAgent" : false
        },
        "audio" : { "$binary" : "AAAAHGZ0eXBpc29tAAACAGlzb21pc28ybXA0MQAABvJ......", "$type" : "00" }
    }
}

Video message

video

Status
titlestring

Base64 of the video

fileName

Status
titlestring

Contains name of the image message

caption

Status
titlestring

file caption

documentType

Status
titleSTRING

Document format

user

Status
titleobject

Semplified user object containing only user id and isAgent properties of the user who sent the message.

Example

Code Block
languagejson
{
    "_id" : ObjectId("61f15a4c932c660c83d5e22f"),
    "room" : "CHAT_DEFAULT_06b6ace1-a923-4657-876b-c6432729610d",
    "id" : "m_dXya7ckVUHyYxQHcQrrdgT2MVSImQFjQ7aCDxA_Mxf7AeR9GMI0vDs2dy2PKgTjE24tQrJImLWYnR5hgtpt7Uw",
    "content" : {
        "caption" : "",
        "fileName" : "video.mp4",
        "documentType" : "mp4",
        "user" : {
            "id" : "4149729381806003",
            "isAgent" : false
        },
        "video" : { "$binary" : "AAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1wNDE...", "$type" : "00" }
    }
}