List Queued User Inquiries

Get
/api/v1/livechat/inquiries.queuedForUser

Permission required: view-l-room The livechat/inquiries.queued endpoint has been removed from 7.0. Use this endpoint instead.

Header parameters
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
Query parameters
department
string

The department ID or name.

offset
integer

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.

Example50
count
integer

The number of items to return. Refer to the official documentation to learn more.

Example25
sort
(object)

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.

Responses
200

OK

Success Example
{
  "inquiries": [
    {
      "_id": "xn5sKBatdkgDfjDLC",
      "rid": "8AuphbFBSNBjeZQFs",
      "name": "hk",
      "ts": "2021-07-22T14:28:57.987Z",
      "department": "CAJioQNAvLnYWTy8i",
      "message": "",
      "status": "queued",
      "v": {
        "_id": "hPF84vuahYBZugM8L",
        "username": "guest-535",
        "token": "zdynf0a9vsiiiq1dlf9abf",
        "status": "offline"
      },
      "t": "l",
      "queueOrder": 1,
      "estimatedWaitingTimeQueue": 0,
      "estimatedServiceTimeAt": "2021-07-22T14:28:57.987Z",
      "_updatedAt": "2021-07-22T14:37:28.470Z"
    },
    {
      "_id": "g6FY2B8PNwneteRG9",
      "rid": "iZ7XDSgcjBgczqko9",
      "name": "dk",
      "ts": "2021-07-22T14:28:07.350Z",
      "department": "CAJioQNAvLnYWTy8i",
      "message": "",
      "status": "queued",
      "v": {
        "_id": "ycwLFcaH4ey9XYYvu",
        "username": "guest-534",
        "token": "ili20miimhh8x33ld0b5de",
        "status": "offline"
      },
      "t": "l",
      "queueOrder": 1,
      "estimatedWaitingTimeQueue": 0,
      "estimatedServiceTimeAt": "2021-07-22T14:28:07.350Z",
      "_updatedAt": "2021-07-22T14:28:24.521Z"
    }
  ],
  "count": 2,
  "offset": 0,
  "total": 2,
  "success": true
}
Expand All
object
inquiries
Array of object
object
_id
string
rid
string
name
string
ts
string
department
string
message
string
status
string
v
object
_id
string
username
string
token
string
status
string
t
string
queueOrder
integer
estimatedWaitingTimeQueue
integer
estimatedServiceTimeAt
string
_updatedAt
string
count
integer
offset
integer
total
integer
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string