Get Department Transfer History

Prev Next
Get
/api/v1/livechat/transfer.history/{rid}

Retrieve the conversation transfer history from one department to another. Permission required: view-livechat-rooms

Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Path parameters
rid
stringRequired

The room ID

Query parameters
count
integer

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

Example25
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
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
{
  "history": [
    {}
  ],
  "count": 0,
  "offset": 0,
  "data": {
    "history": [
      {
        "transferredBy": {
          "_id": "string",
          "username": "string",
          "name": "string",
          "type": "string"
        },
        "ts": "string",
        "scope": "string",
        "previousDepartment": "string",
        "nextDepartment": {
          "_id": "string",
          "name": "string"
        }
      }
    ],
    "count": 0,
    "offset": 0,
    "total": 0,
    "success": true
  },
  "total": 0,
  "success": true
}
Expand All
object
history
Array of object
object
count
integer
offset
integer
data
object
history
Array of object
object
transferredBy
object
_id
string
username
string
name
string
type
string
ts
string
scope
string
previousDepartment
string
nextDepartment
object
_id
string
name
string
count
integer
offset
integer
total
integer
success
boolean
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