Links

Get List of Livechat Rooms

Retrieves a list of Livechat rooms.
HTTP Method
URL
Requires Auth
GET
/api/v1/livechat/rooms
yes

Query Parameters

It supports the Pagination parameters, alongside the field parameter for Query and Fields. Additional optional query parameters are as follows:
Key
Example Value
Description
agents
['b32h3b2hhwb25d']
A list of agents, can be a list of ids or usernames
departmentId
AkzpHAvZpdnuchw2a
The department's id
open
true
If it should filter by open/closed rooms
createdAt
{"start": "2018-01-26T00:11:22.345Z", "end": "2018-01-26T00:11:22.345Z"}
An object representing when the room was created(Can also be filtered only with start or end)
closedAt
{"start": "2018-01-26T00:11:22.345Z", "end": "2018-01-26T00:11:22.345Z"}
An object representing when the room was closed(Can also be filtered only with start or end)
tags
['rocket', 'chat']
A list of tags
customFields
{"docId": "aobEdbYhXfu5hkeqG"}
An object with custom fields to be filtered(previously created and populated at custom fields endpoints)
roomName
room name
The room's name

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/livechat/rooms?agents[]=agent1&agents[]=agent2&departamentId=123&open=true&createdAt={"start": "2018-01-26T00:11:22.345Z", "end": "2018-01-26T00:11:22.345Z"}&closedAt={"start": "2018-01-26T00:11:22.345Z", "end": "2018-01-26T00:11:22.345Z"}&tags[]=rocket&customFields={"docId": "031041"}&count=3&offset=1&sort={"_updatedAt": 1}&fields={"msgs": 1}&roomName=test

Example Response

{
"rooms": [
{
"_id": "9dQMveZhqxiDgCM3B",
"msgs": 1,
"usersCount": 1,
"lm": "2019-08-09T20:18:02.350Z",
"fname": "Marcos Defendi",
"t": "l",
"ts": "2019-08-09T20:18:02.108Z",
"v": {
"_id": "xh45w4y7oPW5SiMJu",
"username": "guest-4",
"token": "xn5hdkyptei11m07f3me",
"status": "online"
},
"servedBy": {
"_id": "3kyWm8PsmwhC7xgwg",
"username": "marcos",
"ts": "2019-08-09T20:18:02.109Z"
},
"cl": false,
"open": true,
"waitingResponse": true,
"departmentId": "xnmXQmytuvxp2TuSC",
"_updatedAt": "2019-08-09T20:19:34.856Z",
"lastMessage": {
"_id": "TBEz7zSCBaKsfyrzc",
"rid": "9dQMveZhqxiDgCM3B",
"msg": "Hello",
"token": "xn5hdkyptei11m07f3me",
"alias": "Marcos Defendi",
"ts": "2019-08-09T20:18:02.350Z",
"u": {
"_id": "xh45w4y7oPW5SiMJu",
"username": "guest-4",
"name": "Marcos Defendi"
},
"_updatedAt": "2019-08-09T20:18:02.383Z",
"mentions": [],
"channels": [],
"newRoom": false,
"showConnecting": false
},
"metrics": {
"v": {
"lq": "2019-08-09T20:18:02.350Z"
}
},
"livechatData": {
"docId": "0310584343112"
},
"tags": [
"rocket",
"chat"
],
"name": "Marcos Defendi"
}
],
"count": 1,
"offset": 1,
"total": 7,
"success": true
}

Change Log

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