Queue operation statuses endpoint

You can use the queue operation statuses endpoint to get availability status for a queue before you deflect a session to it. This endpoint returns the following boolean properties:

  • after_hours: true if the queue is unavailable because it's in an after hours state

  • overcapacity: true if the queue is unavailable because it's in an overcapacity state

Endpoint:

Method: GET

Type: RAW

URL: https://{subdomain}.{domain}/apps/api/v1/queue_operation_statuses

Query:

Key Value Description
menu_id integer The ID for the queue that you want availability information for. Required.
lang string The two-letter language code for the queue, in ISO 639-1 format. Required.
channel_type string The channel type. Possible values are call and chat. Required.

Example request and response

This section provides an example request and response.

Request

https://{subdomain}.{domain}/apps/api/v1/queue_operation_statuses?menu_id=1&lang=en&channel_type=call

Response

{
  "menu_id": 1,
  "lang": "en",
  "channel_type": "call",
  "after_hour": false,
  "overcapacity": true
}