Transfer Omnichannel Room

Prev Next
Post
Deprecated
/api/v1/livechat/room.transfer

This endpoint has been deprecated in the 7.0.0 release. Use the Forward Livechat Room endpoint instead.

Transfer an omnichannel conversation to another department.

Body parameters
Example 1
{
  "rid": "XFzMqgn33DcsQkpJp",
  "token": "iNKE8a6k6cjbqWhWd",
  "department": "wXpPLofkffqWAwDNF"
}
object
rid
string Required

The room _id.

token
string Required

The visitor token.

department
string Required

The new department. To get the department ID, call the Get Livechat Configurations endpoint. Note that the endpoint only returns public departments.

Responses
200

OK

Success Example
{
  "room": {
    "_id": "XFzMqgn33DcsQkpJp",
    "servedBy": {
      "_id": "wiyTfFKXr5GhgRu9A",
      "username": "livechat.agent"
    },
    "open": true,
    "departmentId": "wXpPLofkffqWAwDNF"
  },
  "success": true
}
Expand All
object
room
object
_id
string
servedBy
object
_id
string
username
string
open
boolean
departmentId
string
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'rid' [invalid-params]",
  "errorType": "invalid-params"
}
object
success
boolean
error
string
errorType
string