Links

Inquiries List

Lists all of the open livechat inquiries.
It supports the Pagination parameters.
URL
Requires Auth
HTTP Method
/api/v1/livechat/inquiries.list
yes
GET

Headers

Argument
Example
Required
Description
X-User-Id
myuser-name
Required
Your username hash (returned after you log in through the API)
X-Auth-Token
myauth-token
Required
Your token (returned after you log in through the API)

Query Parameters

Argument
Example
Required
Description
department
ByehQjC44FwMeiLbX
Optional
The department's id or name

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/livechat/inquiries.list

Example Result

{
"inquiries": [
{
"_id": "GpxfRo8TaPHfsnnC5",
"rid": "EbQjtCosHJWLQmQYT",
"name": "Marcos Defendi",
"ts": "2019-06-11T19:01:57.424Z",
"department": "jHFgdJyJWstB9M2ik",
"status": "open"
},
{
"_id": "9dCi64GkwWE389xCm",
"rid": "ZpjCcbRwPPdnhKWW5",
"name": "Marcos Defendi",
"ts": "2019-06-11T19:00:43.124Z",
"department": "gDDAjeJb7BhHzzEQ8",
"status": "open"
}
],
"offset": 0,
"count": 1,
"total": 1,
"success": true
}

Change Log

Version
Description
1.2.0
Added

Last modified 2mo ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.