Comment on page

Get Department Transfer History

Retrieve the conversation transfer history from one department to another.

Retrieve the department transfer history for a room.
HTTP Method
URL
Requires Auth
GET
/api/v1/livechat/transfer.history/:rid
​yes​
Permission required: view-livechat-rooms
Path Variables
Key
Example Value
Description
rid*
zRAeTszXor8CCPceB
The room ID.
Query Parameters
This endpoint supports the optional Paginationquery parameters.
Example Call
curl --location --request GET 'http://localhost:3000/api/v1/livechat/transfer.history/:rid\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'
Example Response
{
    "history": [],
    "count": 0,
    "offset": 0,{
    "history": [
        {
            "transferredBy": {
                "_id": "646b3be5671066d5f560818d",
                "username": "guest-20",
                "name": "Patou",
                "type": "visitor"
            },
            "ts": "2023-11-08T13:12:42.423Z",
            "scope": "department",
            "previousDepartment": "64181a0728384134ed600dcc",
            "nextDepartment": {
                "_id": "649230d479f5c6e276cf4a12",
                "name": "TestBH"
            }
        }
    ],
    "count": 1,
    "offset": 0,
    "total": 1,
    "success": true
}
    "total": 0,
    "success": true
}

HTTP Method	URL	Requires Auth
`GET`	`/api/v1/livechat/transfer.history/:rid`	`yes`

Key	Example Value	Description
`rid*`	`zRAeTszXor8CCPceB`	The room ID.

Last modified 10d ago