Lists all open Livechat inquiries. An incoming chat that has not yet been taken by the agent is called an inquiry. After it's been taken by the agent it is referred to as room.
Permission required: view-livechat-manager
Changelog
| Version | Description |
|---|---|
| 1.2.0 | Added |
The authToken of the authenticated user.
The userId of the authenticated user.
The department ID or name.
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.
List of fields to order by, and in which direction. JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, sort = {"value": -1, "_id": 1}. Refer to the official documentation to learn more.
OK
{
"inquiries": [
{
"_id": "GpxfRo8TaPHfsnnC5",
"rid": "EbQjtCosHJWLQmQYT",
"name": "Marcos Defendi",
"ts": "2019-06-11T19:01:57.424Z",
"status": "queued"
}
],
"offset": 0,
"count": 1,
"total": 1,
"success": true
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}Forbidden
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}{
"success": false,
"error": "unauthorized"
}