View Omnichannel Room Sources

Prev Next
Get
/api/v1/livechat/rooms/filters

Use this endpoint to view the sources of the Omnichannel rooms, for example, an app or the Livechat widget. Permission required: view-l-room

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

Example 1
{
  "filters": [
    {},
    {
      "type": "app",
      "id": "5e3dadaa-e774-40d8-b3a4-b93b91747168",
      "alias": "WhatsApp Cloud",
      "sidebarIcon": "whatsapp",
      "defaultIcon": "whatsapp"
    },
    {
      "type": "app",
      "id": "99ecc706-ca5a-4b8f-bbaf-c28de243f1db",
      "alias": "WhatsApp Sandbox",
      "sidebarIcon": "whatsapp",
      "defaultIcon": "whatsapp"
    },
    {
      "type": "app",
      "id": "fc96e832-5472-49e4-aace-1521a7ebeaa6",
      "alias": "Telegram",
      "sidebarIcon": "telegram",
      "defaultIcon": "telegram"
    },
    {
      "type": "sms"
    },
    {
      "type": "widget"
    }
  ],
  "success": true
}
Expand All
object
filters
Array of object
object
type
string
id
string
alias
string
sidebarIcon
string
defaultIcon
string
success
boolean
401

Unauthorized

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