Get Visitor Information by ID

Prev Next
Get
/api/v1/livechat/visitors.info

Get the information of a specific visitor.

Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Query parameters
visitorId
stringRequired

The visitor ID.

Responses
200
Success Example
{
  "visitor": {
    "_id": "642fc15452492a08c3a756de",
    "username": "guest-19",
    "status": "online",
    "ts": "2023-04-07T07:08:04.375Z",
    "_updatedAt": "2023-11-03T08:23:23.449Z",
    "name": "Livechat Visitor",
    "phone": [
      {
        "phoneNumber": "55 51 5555-5555"
      }
    ],
    "token": "iNKE8a6k6cjbqWhWd",
    "visitorEmails": [
      {
        "address": "[email protected]"
      }
    ],
    "department": "64181a0728384134ed600dcc"
  },
  "success": true
}
Expand All
object
visitor
object
_id
string
username
string
status
string
ts
string
_updatedAt
string
name
string
phone
Array of object
object
phoneNumber
string
token
string
visitorEmails
Array of object
object
address
string
department
string
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'visitorId' [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