Send Array of Messages

Prev Next
Post
/api/v1/livechat/messages

Send an array of messsages in a Livechat room.

Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example 1
{
  "visitor": {
    "token": "54fc5544030bcecda053311cb6b98920b"
  },
  "messages": [
    {
      "msg": "test"
    },
    {
      "msg": "hello"
    }
  ]
}
Expand All
object
visitor
object Required

The vistor token.

token
string
messages
Array of object Required

The array of messages.

object
msg
string
Responses
200
Success Example
{
  "messages": [
    {
      "username": "guest-35",
      "msg": "test",
      "ts": "2023-10-31T08:41:29.724Z"
    },
    {
      "username": "guest-35",
      "msg": "hello",
      "ts": "2023-10-31T08:41:29.725Z"
    }
  ],
  "success": true
}
Expand All
object
messages
Array of object
object
username
string
msg
string
ts
string
success
boolean
400

Bad Request

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

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string