キュー エンドポイント

キューのステータス エンドポイントは、通話を転送するかどうかを判断するためにキュー情報を返します。

キューのステータス

推定待ち時間、エージェントの空き状況、コールバック スロットの容量、営業時間、休日など、リーフキューのリアルタイム データを提供します。これを使用すると、音声 AI システムで、通話をライブ エージェントにエスカレーションするか、スケジュールされたコールバック ウィンドウを発信者に提供するかを動的に決定できます。詳細については、キューのステータス エンドポイントをご覧ください。

リクエストの例

メソッド: GET

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

ヘッダー

キー 値 説明
Content-Type application/json
同意する application/json

クエリ

キー 値 説明
lang 文字列 キューの 2 文字の言語コード（ISO 639-1 形式（en、es など））。必須。
menu_id[] 文字列 単一のキュー ID または複数のキュー ID の配列。必須。
menu_type 文字列 メニューのタイプ。有効な値は ivr_menu、mobile_menu、web_menu です。必須。
callback_period_hours integer コールバック スロット期間を返す合計将来期間（時間単位）。8 時間以下にする必要があります。デフォルトは 4 時間です。省略可。
callback_start_from 文字列 コールバック スロットの検索期間の開始日時。キューまたは会社のタイムゾーンの ISO 8601 の日付時刻形式で指定します。省略すると、デフォルトで現在の時刻（キューまたは会社のタイムゾーンに変換されたサーバー時刻）になります。過去の日付を指定することはできません。また、24 時間以上先の日付を指定することもできません。省略可。

レスポンスの例

{
    "queues": [
        {
            "menu_id": 2,
            "menu_type": "ivr_menu",
            "lang": "en",
            "materialized_path": "IVR Support",
            "current_queue_ewt": 18000,
            "scheduled_callback_ewt": 0,
            "logged_in_agents": 0,
            "available_agents": 0,
            "breakthrough_agents": 0,
            "callback_periods": [
                {
                    "date": "20260225",
                    "start_time": "17:30",
                    "end_time": "17:45",
                    "scheduled_calls": 0,
                    "max_slots": 1
                },
                {
                    "date": "20260225",
                    "start_time": "17:45",
                    "end_time": "18:00",
                    "scheduled_calls": 0,
                    "max_slots": 1
                }
            ],
            "hoops": {
                "current_status": 0,
                "time_zone": "America/Los_Angeles",
                "start_of_hoops": "2026-02-25T09:00:00-08:00",
                "end_of_hoops": "2026-02-25T18:00:00-08:00",
                "hoops_early_cutoff_minutes": null
            },
            "holiday": {
                "current_status": 0,
                "holiday_name": null,
                "time_range_all_day": null,
                "time_range_start_time": null,
                "time_range_end_time": null,
                "time_zone": "America/Los_Angeles"
            }
        }
    ]
}

キューの可用性

セッションをキューに転送する前に、キューの空き状況を取得します。このエンドポイントは、次のブール値プロパティを返します。

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

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

リクエストの例

メソッド: GET

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

クエリ

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

レスポンスの例

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