Comment on page

Get Available Agent Information

Get information about the currently available agent.  
HTTP Method
URL
Requires Auth
GET
/api/v1/omnichannel/agents/available
​yes​
Query Parameters (Optional)
Supports the Pagination parameters. Additional query parameters are as follows:
Key
Data Type
Description
query
string
Use the query operator to search for specific data. 
​
For more information, see Query and Fields​
text
string
The response is the data that contains this text.
includeExtension
string
The voice channel extension associated with the agent. If you don't enter any extension number, the endpoint returns a list of all agents who have not been assigned any extensions.
​
For information about extensions, see Associate agents with extensions in Rocket.Chat.
Example Call
curl --location 'http://localhost:3000/api/v1/omnichannel/agents/available' \
--header 'X-Auth-Token: Y97tM4GkYjgaH_fIO5dwBitQQvm3yp-AptYzGQZMX6e' \
--header 'X-User-Id: CkCPNcvsvCDfmWLqC' \
--data ''
Example Response
{
    "agent": {
        "_id": "XycfA5CetCPuEjqxw",
        "username": "test.agent",
        "name": "agent123",
        "status": "online",
        "statusLivechat": "online",
        "emails": [
            {
                "address": "[email protected]",
                "verified": true
            }
        ],       
        "livechat": {
            "maxNumberSimultaneousChat": "5"
        }
    },
    "success": true
}

HTTP Method	URL	Requires Auth
`GET`	`/api/v1/omnichannel/agents/available`	`yes`

Key	Data Type	Description
`query`	`string`	Use the query operator to search for specific data. For more information, see Query and Fields
`text`	`string`	The response is the data that contains this text.
`includeExtension`	`string`	The voice channel extension associated with the agent. If you don't enter any extension number, the endpoint returns a list of all agents who have not been assigned any extensions. For information about extensions, see Associate agents with extensions in Rocket.Chat.

Last modified 1mo ago