Get Next Agent Information

Prev Next
Get
/api/v1/livechat/agent.next/{token}

Get information about the next available agent for an incoming conversation. This endpoint returns the available agents who have not been assigned to any chat yet. To get the token value, call the Get Rooms endpoint to retrieve the details of all rooms.

Path parameters
token
stringRequired

The visitor token.

Responses
200

OK

Success Example
{
  "agent": {
    "_id": "7Gm3PoFCJWTCJ68XR",
    "emails": [
      {
        "address": "[email protected]",
        "verified": true
      }
    ],
    "name": "Livechat Agent",
    "username": "livechat.agent"
  },
  "success": true
}
Expand All
object
agent
object
_id
string
emails
Array of object
object
address
string
verified
boolean
name
string
username
string
success
boolean