agent.md

Get Agent Information

Get the Livechat agent data according to the path variables.

HTTP Method	URL	Requires Auth
GET	/api/v1/livechat/agent.info/:rid/:token	no

Path Variables

Key	Example Value	Description
rid*	zRAeTszXor8CCPceB	The room _id.
token*	iNKE8a6k6cjbqWhWd	The visitor token.

{% hint style="info" %} To get the rid and token values, call the Get Rooms endpoint to retrieve the details of all rooms. {% endhint %}

Example Call

{% code overflow="wrap" %}

curl --location 'http://localhost:3000/api/v1/livechat/agent.info/hGFwSKA28nRKut3pD/54fc5544030bcecda053311cb6b98920bdf953f242c129d7b8065000b1f9b2e9'

{% endcode %}

Example Response

{
    "agent": {
        "_id": "XycfA5CetCPuEjqxw",
        "emails": [
            {
                "address": "agent@rocket.chat",
                "verified": true
            }
        ],
        "status": "online",
        "name": "testAgent",
        "username": "test.agent",
        "livechat": {
            "maxNumberSimultaneousChat": "5"
        }
    },
    "success": true
}