Links

Get Livechat Queue

HTTP Method
URL
Requires Auth
GET
/api/v1/livechat/queue
yes
Permission required: view-l-room

Query Parameters

This endpoint supports the optional Pagination parameters. Other optional parameters are as follows:
Key
Example Value
Description
includeOfflineAgents
true
Whether you want to include offline agents or not.
agentId
aobEdbYhXfu5dsd9
The agent ID.
departmentId
3n2kj3n2j3fu5hkeqG
The department ID.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/livechat/queue?includeOfflineAgents=true

Example Response

{
"queue": [
{
"chats": 1,
"user": {
"_id": "CaevAPDbXN252kyXa",
"username": "marcos.defendi",
"status": "online"
},
"department": {
"_id": "457diLwcQMmdpaTjo",
"name": "Department 1"
}
},
{
"chats": 2,
"user": {
"_id": "CaevAPDbXN252kyXa",
"username": "marcos.defendi",
"status": "online"
},
"department": {
"_id": "5mt9oEtQxuMMH23Co",
"name": "Department 2"
}
}
],
"count": 2,
"offset": 0,
"total": 2,
"success": true
}

Change Log

Version
Description
2.4.0
Added
Last modified 3mo ago
Rocket.Chat versions receive support for six months after release.