Get a Livechat Message

Prev Next
Get
/api/v1/livechat/message/{_id}

Retrieve specific livechat message information.

Path parameters
_id
stringRequired

The message ID that you want to update.

ExampleZKWP8LfGnRHQ3ozWa
Query parameters
token
stringRequired

The visitor token.

Example8s7e9ony6ctl27e1qf8kue
rid
stringRequired

The room ID.

ExamplemmqCzYgiL8fzRYfuY
Responses
200
Success Example
{
  "message": {
    "_id": "AgRFdj96mbHDPrTHq",
    "rid": "mmqCzYgiL8fzRYfuY",
    "msg": "hi",
    "token": "8s7e9ony6ctl27e1qf8kue",
    "alias": "Mary",
    "ts": "2021-07-13T16:20:26.672Z",
    "u": {
      "_id": "47Dajwh9DjpnTAugW",
      "username": "guest-165",
      "name": "Mary"
    },
    "unread": true,
    "_updatedAt": "2021-07-13T16:20:26.776Z",
    "urls": [],
    "mentions": [],
    "channels": [],
    "md": [
      {
        "type": "PARAGRAPH",
        "value": [
          {
            "type": "PLAIN_TEXT",
            "value": "hi"
          }
        ]
      }
    ]
  },
  "success": true
}
Expand All
object
message
object
_id
string
rid
string
msg
string
token
string
alias
string
ts
string
u
object
_id
string
username
string
name
string
unread
boolean
_updatedAt
string
urls
Array of object
object
mentions
Array of object
object
channels
Array of object
object
md
Array of object
object
type
string
value
Array of object
object
type
string
value
string
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'rid' [invalid-params]",
  "errorType": "invalid-params"
}
Example 2
{
  "success": false,
  "error": "must have required property 'token' [invalid-params]",
  "errorType": "invalid-params"
}
object
success
boolean
error
string
errorType
string