キュー オペレーション ステータス エンドポイント

キュー オペレーション ステータス エンドポイントを使用すると、セッションをキューに転送する前に、キューの可用性ステータスを取得できます。このエンドポイントは、次のブール値プロパティを返します。

• after_hours: キューが営業時間外の状態であるため使用できない場合は true

• overcapacity: キューが容量超過状態のため使用できない場合は true

エンドポイント:

メソッド: GET

タイプ: RAW

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

クエリ:

キー	値	説明
menu_id	integer	空き情報を取得するキューの ID。必須。
lang	文字列	キューの 2 文字の言語コード（ISO 639-1 形式）。必須。
channel_type	文字列	チャネルのタイプ。有効な値は call と chat です。必須。

リクエストとレスポンスの例

このセクションでは、リクエストとレスポンスの例を示します。

リクエスト

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

レスポンス

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