Close Livechat Room by Visitor

Prev Next
Post
/api/v1/livechat/room.close

If you are a visitor, use this endpoint to close the livechat room.

Body parameters
Example 1
{
  "rid": "XFzMqgn33DcsQkpJp",
  "token": "iNKE8a6k6cjbqWhWd"
}
object
rid
string Required

The room ID.

ExampleXFzMqgn33DcsQkpJp
token
string Required

The visitor token.

ExampleiNKE8a6k6cjbqWhWd
Responses
200
Success Example
{
  "rid": "XFzMqgn33DcsQkpJp",
  "comment": "Closed by visitor",
  "success": true
}
object
rid
string
comment
string
success
boolean
400

Bad Request

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