Get Agent Information

Get
/api/v1/livechat/agent.info/{rid}/{token}

Get the Livechat agent data according to the path variables. To get the rid and token values, call the Get Rooms endpoint to retrieve the details of all rooms.

Path parameters
rid
stringRequired

The room ID.

ExamplezRAeTszXor8CCPceB
token
stringRequired

The visitor token.

ExampleiNKE8a6k6cjbqWhWd
Responses
200

OK

Success Example
{
  "agent": {
    "_id": "XycfA5CetCPuEjqxw",
    "emails": [
      {
        "address": "[email protected]",
        "verified": true
      }
    ],
    "status": "online",
    "name": "testAgent",
    "username": "test.agent",
    "livechat": {
      "maxNumberSimultaneousChat": "5"
    }
  },
  "success": true
}
Expand All
object
agent
object
_id
string
emails
Array of object
object
address
string
verified
boolean
status
string
name
string
username
string
livechat
object
maxNumberSimultaneousChat
string
success
boolean