コンタクト センター AI プラットフォーム（CCAI プラットフォーム）は、さまざまなチャネル タイプのキューの現在の待ち時間を取得するための Wait time エンドポイントを提供します。
待機時間
| パラメータ | 必須 | データ型 | 定義 |
|---|---|---|---|
| lang | TRUE | 文字列 | キューの言語コード。（例: 「en」） |
| menu_id | FALSE | Integer | レスポンスは、そのメニューを含む、そのメニューのサブツリー内のすべてのメニューをフィルタします。 |
| menu_type | FALSE | 文字列 | 特定のタイプのメニューを返します。指定できる値は、ivr_menu、mobile_menu、web_menu です。 |
| channel_type | FALSE | 文字列 | 特定のチャンネルのメニューを返します。可能な値: voice_call、chat）。 |
| wait[from] | FALSE | Integer | 値より大きい待機時間があるレコードを返します。 |
| wait[to] | FALSE | Integer | 待機時間が値より小さいレコードを返します。 |
エンドポイント:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/apps/api/v1/wait_times
ヘッダー:
| キー | 値 | 説明 |
|---|---|---|
| Content-Type | application/json |
リクエストとレスポンスの例
以降のセクションでは、エンドポイントに対するリクエストの例を示します。
モバイル キューの待ち時間
この例では、モバイルキューの待ち時間を取得する方法を示します。
リクエスト
ヘッダー:
| キー | 値 | 説明 |
|---|---|---|
| Content-Type | application/json |
クエリ:
| キー | 値 | 説明 |
|---|---|---|
| lang | en | |
| menu_type | mobile_menu |
本文: なし
回答: モバイル キューの待ち時間
[
{
"menu_id": 29,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Laptop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 42,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Desktop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 43,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Smart Phone",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
ステータス コード: 200
wait[from] から wait[to] までの待機時間
この例では、待機時間（待機開始値と待機終了値の間）がある呼び出しを取得する方法を示します。
リクエスト
ヘッダー:
| キー | 値 | 説明 |
|---|---|---|
| Content-Type | application/json |
クエリ:
| キー | 値 | 説明 |
|---|---|---|
| lang | en | |
| wait[from] | 5 | |
| wait[to] | 15 |
本文: なし
レスポンス: wait[from] から wait[to] までの待機時間
[
{
"menu_id": 3,
"menu_type": "web_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Web App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 29,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Laptop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 42,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Desktop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 44,
"menu_type": "web_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Mobile App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 43,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Smart Phone",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
ステータス コード: 200
モバイルキューの音声通話の待ち時間が 5 秒を超えている
この例では、待ち時間が 5 秒を超えるモバイル音声通話を取得する方法を示します。
リクエスト
ヘッダー:
| キー | 値 | 説明 |
|---|---|---|
| Content-Type | application/json |
クエリ:
| キー | 値 | 説明 |
|---|---|---|
| lang | en | |
| menu_type | mobile_menu | |
| channel_type | voice_call | |
| wait[from] | 5 |
本文: なし
回答: モバイル キューの音声通話の待ち時間が 5 秒を超えている
[
{
"menu_id": 29,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Laptop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 42,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Desktop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 43,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Smart Phone",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
ステータス コード: 200
特定のメニューの待ち時間
この例では、特定のメニュー ID の待ち時間を取得する方法を示します。
リクエスト
ヘッダー:
| キー | 値 | 説明 |
|---|---|---|
| Content-Type | application/json |
クエリ:
| キー | 値 | 説明 |
|---|---|---|
| lang | en | |
| menu_id | 9 |
本文: なし
回答: 特定のメニューの待ち時間
[
{
"menu_id": 9,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Death Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
ステータス コード: 200
すべての音声通話の待ち時間
この例では、現在のすべての音声通話の待ち時間を取得する方法を示します。
リクエスト
ヘッダー:
| キー | 値 | 説明 |
|---|---|---|
| Content-Type | application/json |
クエリ:
| キー | 値 | 説明 |
|---|---|---|
| lang | en | |
| channel_type | voice_call |
本文: なし
回答: すべての音声通話の待ち時間
[
{
"menu_id": 3,
"menu_type": "web_menu",
"voice_call": 10,
"materialized_path": "Web App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 9,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Death Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 29,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Laptop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 41,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Lock Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 42,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Desktop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 44,
"menu_type": "web_menu",
"voice_call": 10,
"materialized_path": "Mobile App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 43,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Smart Phone",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
ステータス コード: 200
英語キューの待ち時間
この例では、言語が英語のキューのすべての待ち時間を取得する方法を示します。
リクエスト
ヘッダー:
| キー | 値 | 説明 |
|---|---|---|
| Content-Type | application/json |
クエリ:
| キー | 値 | 説明 |
|---|---|---|
| lang | en |
本文: なし
回答: 英語キューの待ち時間
[
{
"menu_id": 3,
"menu_type": "web_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Web App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 9,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Death Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 29,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Laptop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 41,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Lock Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 42,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Desktop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 44,
"menu_type": "web_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Mobile App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 43,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Smart Phone",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
ステータス コード: 200