Get Livechat Routing Configuration

Prev Next
Get
/api/v1/livechat/config/routing

This endpoint returns the livechat routing configuration. It is called automatically when logging into the application to make the Omnichannel/livechat features available in the client.

Changelog

Version Description
7.11.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Responses
200

OK The parameters in the response indicate whether the specific livechat setting in the workspace is enabled or not.

Example 1
{
  "config": {
    "previewRoom": false,
    "showConnecting": false,
    "showQueue": false,
    "showQueueLink": true,
    "returnQueue": false,
    "enableTriggerAction": true,
    "autoAssignAgent": true
  },
  "success": true
}
Expand All
object
config
object
previewRoom
boolean
showConnecting
boolean
showQueue
boolean
showQueueLink
boolean
returnQueue
boolean
enableTriggerAction
boolean
autoAssignAgent
boolean
success
boolean
401

Unauthorized

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