Transfer Livechat Room

Transfer an omnichannel conversation to another department.
HTTP Method
URL
Requires Auth
POST
/api/v1/livechat/room.transfer
no
Payload
Key
Example Value
Description
rid*
XFzMqgn33DcsQkpJp
The room _id.
token*
iNKE8a6k6cjbqWhWd
The visitor token.
department*
wXpPLofkffqWAwDNF
The new department. To get the department ID, call the Get Livechat Configurations endpoint. Note that the endpoint only returns public departments.
Example Call
curl -X POST \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/livechat/room.transfer \
     -d '{"rid": "XFzMqgn33DcsQkpJp", 
          "token": "iNKE8a6k6cjbqWhWd", 
          "department": "wXpPLofkffqWAwDNF"}'
Example Response
{
  "room": {
    "_id": "XFzMqgn33DcsQkpJp",
    "servedBy": {
      "_id": "wiyTfFKXr5GhgRu9A",
      "username": "livechat.agent"
    },
    "open": true,
    "departmentId": "wXpPLofkffqWAwDNF"
  },
  "success": true
}

HTTP Method	URL	Requires Auth
`POST`	`/api/v1/livechat/room.transfer`	`no`

Key	Example Value	Description
`rid*`	`XFzMqgn33DcsQkpJp`	The room `_id`.
`token*`	`iNKE8a6k6cjbqWhWd`	The visitor `token`.
`department*`	`wXpPLofkffqWAwDNF`	The new `department`. To get the department ID, call the Get Livechat Configurations endpoint. Note that the endpoint only returns public departments.

Last modified 18d ago