Get Next Agent Information

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.
HTTP Method
URL
Requires Auth
GET
/api/v1/livechat/agent.next/:token
no
Path variables
Key
Example value
Description
token *
iNKE8a6k6cjbqWhWd
The visitor token.
To get the token value, call the Get Rooms endpoint to retrieve the details of all rooms.
Example Call
curl --location 'http://localhost:3000/api/v1/livechat/agent.next/54fc5544030bcecda053311cb6b98920bdf953f242c129d7b8065000b1f9b2e9'
Example Response
{
  "agent": {
    "_id": "7Gm3PoFCJWTCJ68XR",
    "emails": [
      {
        "address": "[email protected]",
        "verified": true
      }
    ],
    "name": "Livechat Agent",
    "username": "livechat.agent"
  },
  "success": true
}

HTTP Method	URL	Requires Auth
`GET`	`/api/v1/livechat/agent.next/:token`	`no`

Key	Example value	Description
`token` `*`	`iNKE8a6k6cjbqWhWd`	The visitor `token`.

Last modified 26d ago