Forward Omnichannel Room

Prev Next
Post
/api/v1/livechat/room.forward

Use this endpoint to transfer a chat to another department or agent. When transfering the chat to another department, you can also specify a default agent in that department to receive the chat if an auto-assignment routing algorithm is enabled.

Changelog

Version Description
7.10.0 Added support for selecting a default agent when transferring chat to another department.
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example
{
  "roomId": "XFzMqgn33DcsQkpJp",
  "userId": "iNKE8a6k6cjbqWhWd"
}
object
roomId
string Required

The room ID.

userId
string

The new agent ID.

departmentId
string

The new department ID.

Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

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

Unauthorized

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