get-the-visitor-info.md

Get Visitor Information by ID

Get the information of a specific visitor.

HTTP Method	URL	Requires Auth
GET	/api/v1/livechat/visitors.info	yes

Query Parameters

Key	Example Value	Description
visitorId*	642fc15452492a08c3a756de	The visitor's ID.

Example Call

{% code overflow="wrap" %}

curl --location 'http://localhost:3000/api/v1/livechat/visitors.info?visitorId=642fc15452492a08c3a756de' \
--header 'X-Auth-Token: Y97tM4GkYjgaH_fIO5dwB' \
--header 'X-User-Id: CkCPNcvsvCDfmWLqC'

{% endcode %}

Example Response

{
    "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": "visitor@rocket.chat"
            }
        ],
        "department": "64181a0728384134ed600dcc"
    },
    "success": true
}