Search Visitor Chat

Print
Dark
Light
PDF

Search Visitor Chat

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/api/v1/livechat/visitors.searchChats/room/{roomId}/visitor/{visitorId}

Get the Livechat information of a visitor. This endpoint returns only those chats that are served and closed.

Header parameters

X-Auth-Token

stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f

X-User-Id

stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ

Path parameters

roomId

stringRequired

The room ID.

visitorId

stringRequired

The visitor ID.

Responses

200

Success Example

{
  "history": [
    {
      "_id": "hhMKhHnnbY79mGs9K",
      "msgs": 2,
      "fname": "Maria",
      "ts": "2021-07-22T17:17:04.216Z",
      "v": {
        "_id": "QyBAKC5Wc8tcv6cco",
        "username": "guest-537",
        "token": "8s7e9ony6ctl27e1qf8kue",
        "status": "online",
        "lastMessageTs": "2021-07-22T17:17:04.937Z"
      }
    }
  ],
  "count": 1,
  "offset": 0,
  "total": 1,
  "success": true
}

Expand All

object

history

Array of object

object

_id

string

msgs

integer

fname

string

object

_id

string

username

string

token

string

status

string

lastMessageTs

string

count

integer

offset

integer

total

integer

success

boolean

401

Unauthorized

Authorization Error

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

object

status

string

message

string

Was this article helpful?

What's Next

Autocomplete Visitors