Versions Compared

Key

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

...

Name

Type

Description

id

Status
titlestring

message unique identifier

messageType

Status
titleSTRING

Type of the message. Can assume one of the following values:

“text”“TEXT”

“image”“IMAGE”

“document”“DOCUMENT”

“link”“LINK”

“audio”“AUDIO”

“video”“VIDEO”

“videoRequestedByAgent”

“videoRequestedByCustomer”

“videoAccepted”

“videoRejected”

“videoStarted”

“videoEnded”

“screenSharingStarted”

“screenSharingEnded”

“endChat”

“leave”

ts

Status
titleNUMBER

Timestamp of when message was sent

deliverySuccess

Status
titleboolean

Indicates if the message has been succesfully delivered

deliveryErrorReason

Status
titlestring

In case of delivery failed, describes the error occurred

replyTo

Status
titlestring

Message ID you are replying to

content

Status
titleobject

Message content. See message content object for more details.

...

Name

Type

Description

caption

Status
titleSTRING

Message caption

fileName

Status
titlestring

Contains name of the document/image message

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.

...

Code Block
languagejson
{
    "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" : ""
    },
    "_id" : ObjectId("61f15a4c932c660c83d5e229"),
    "room" : "CHAT_DEFAULT_06b6ace1-a923-4657-876b-c6432729610d"
}

Audio message:

caption

Status
titleSTRING

Message caption

fileName

Status
titlestring

Contains name of the document/image message

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.

...