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

id

Status
titleString

Message unique identifier

messageType

Status
titleString

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
titlenumber

Timestamp of when message was sent

isAgent

Status
titleboolean

Indicates if the person who sent the message is an agent

id [user object]

Status
titleString

user unique identifier

firstIP

Status
titlestring

Agent/customer IP

text

Status
titlestring

Only in “TEXT” message, contains the message sent

img

Status
titlestring

Contains base64 image message

caption

Status
titlestring

Message caption

documentType

Status
titlestring

Document format

fileName

Status
titlestring

Contains name of the document/image message

url

Status
titlestring

Contains the url of the link message

deliverySuccess

Status
titleboolean

Indicates if the message has been succesfully delivered

deliveryErrorReason

Status
titlestring

In case of delivery failed, describes the error occurred

Name

Type

Description

room

Status
titleSTRING

Chat unique identifier

data

Status
titleobject

Object containing message info. See message data object for more details.

...