Estimated Wait Time API

この API エンドポイントは、キューごとに算出された予想待ち時間（EWT）を返します。

これは、Contact Center AI Platform（CCAI Platform）SDK 以外のウェブページやモバイルアプリでのカスタム サポート チャネル EWT の表示、カスタム通知やトリガーに使用できます。

リクエストの例

URL: http://{subdomain}.{domain}/apps/api/v1/wait_times

パラメータ

ID	フィールド名	タイプ	必須	説明	値	メモ
1	menu_id	id	いいえ	レスポンスは、そのメニューを含む、そのメニューのサブメニュー内のすべてのメニュー（キュー）をフィルタします。	ルートメニュー（デフォルト）特定のメニュー	何も渡されない場合は、キュー構造全体が返されます。
2	channel_type	enum	いいえ	特定のチャネルのメニューを返します。	voice_call chat	省略可能なパラメータ
3	menu_type	enum	いいえ	特定のタイプのメニューを返します。	ivr_menu mobile_menu web_menu すべて（デフォルト）	省略可
4	wait[from]	int	いいえ	待機時間が値より大きいレコードを返します。		検証:正の整数のみ
5	wait[to]	int	いいえ	待機時間が値より小さいレコードを返します。		検証:正の整数のみ
6	lang	enum	はい	ewt を取得するキュー構造	例: 「en」、「es」、「fr」、「de」 「it」、「ja」、「ko」、「pt」 「pt-BR」、「sv」

レスポンス

ID	フィールド名	タイプ	必須	説明
1	menu_id	id	はい	/menus マネージャー API エンドポイントへの外部キー
2	wait	INT	はい	待機時間（分）
3	マテリアライズド パス	文字列	はい	/menus API にあるマテリアライズド パス

例

http://{subdomain}.{domain}/apps/api/v1/wait_times?lang=en&menu_id=10

[
    {
        "menu_id": 10,
        "menu_type": "ivr_menu",
        "voice_call": 120,
        "materialized_path": "Subscription",
        "logged_in_agents": 3,
        "available_agents": 0,
        "breakthrough_agents": 1
    }
]

ステータス コード:200

メニュー ID 10 の予想待ち時間は 120 秒（2 分）です。