コンタクト センター AI プラットフォーム（CCAI プラットフォーム）との間でやり取りされるすべての通話に対して、通話オブジェクトが作成されます。次のモデルを参照して、どのフィールドに PII が含まれている可能性があるかを確認します。
[
{
"id": 0,
"parent_id": 0,
"lang": "en",
"call_type": "Voice Inbound (App)",
"status": "scheduled",
"sub_status": "Scheduled: Disconnected by unknown",
"created_at": "2018-06-07T19:49:52.896Z",
"queued_at": "2018-06-07T19:49:52.896Z",
"assigned_at": "2018-06-07T19:49:52.896Z",
"connected_at": "2018-06-07T19:49:52.896Z",
"ends_at": "2018-06-07T19:49:52.896Z",
"scheduled_at": "2018-06-07T19:49:52.896Z",
"updated_at": "2018-06-07T19:49:52.896Z",
"wait_duration": 0, //Deprecated, use queue_duration instead
"queue_duration": 0,
"call_duration": 0,
"hold_duration": 0,
"rating": 0,
"has_feedback": true,
"voip_provider": "voip_provider_twilio",
"out_ticket_id": "string",
"out_ticket_url": "string",
"verified": true,
"recording_url": "string",
"recording_permission": "not_asked",
"voicemail_reason": "not_voicemail",
"deflection": "no_deflection",
"disconnected_by": "disconnected_by_unknown",
"finish_reason": "no_reason",
"fail_details": "string",
"fail_reason": "nothing",
"adapter_fail_code": null,
"adapter_fail_message": null,
"support_number": "string",
"selected_menu": {
"id": 0,
"name": "string",
"parent_id": 0,
"position": 0,
"deleted": true,
"hidden": "string",
"menu_type": "ivr_menu",
"output_msg": "string"
},
"menu_path": {
"items_count": 0,
"name": "string",
"materialized_path": "string"
},
"agent_info": {
"id": 0,
"name": "string", //This may be considered PII
"last_name": "string", //This may be considered PII
"first_name": "string", //This may be considered PII
"agent_number": "string",
"avatar_url": "string"
},
"end_user": {
"id": 0, //This may be considered PII
"identifier": "string", //This may be considered PII
"out_contact_id": "string" //This may be considered PII
},
"photos": [
{
"id": 0, //This may be considered PII
"photo_type": "photo", //This may be considered PII
"url": "string" //This may be considered PII
}
],
"videos": [
{
"id": 0, //This may be considered PII
"url": "string" //This may be considered PII
}
],
"transfers": [
{
"id": 0,
"status": "transferring",
"fail_reason": "nothing",
"created_at": "2018-06-07T19:49:52.896Z",
"call_duration": 300,
"wait_duration": 40,
"assigned_at": "2018-06-07T19:50:32.896Z",
"connected_at": "2018-06-07T19:50:35.896Z",
"updated_at": "2018-06-07T19:55:35.896Z",
"deflection": 0,
"from_menu": {
"items_count": 0,
"name": "string",
"materialized_path": "string"
},
"to_menu": {
"items_count": 0,
"name": "string",
"materialized_path": "string"
},
"from_agent": {
"id": 0,
"name": "string", //This may be considered PII
"last_name": "string", //This may be considered PII
"first_name": "string", //This may be considered PII
"agent_number": "string",
"avatar_url": "string"
},
"to_agent": {
"id": 0,
"name": "string", //This may be considered PII
"last_name": "string", //This may be considered PII
"first_name": "string", //This may be considered PII
"agent_number": "string",
"avatar_url": "string"
}
}
],
"handle_durations": [
{
"agent_id": 0,
"acw_duration": 0,
"call_duration" 0,
"menu_path_id": 0,
"wait_duration": 0,
"lang": "en",
"transfer": false,
"started_at": "2019-07-17T07:27:14.000Z",
"ended_at": "2019-07-17T07:27:20.000Z",
"event": "call_finished"
}
],
"queue_durations": [
{
"agent_id": 0,
"queue_duration" 0,
"menu_path_id": 0,
"lang": "en",
"transfer": false,
"started_at": "2019-07-17T07:27:14.000Z",
"ended_at": "2019-07-17T07:27:20.000Z",
"service_level_abandon_time_threshold": 10,
"service_level_event": "not_in_sla",
"service_level_target_percent": 90,
"service_level_target_time": 60,
"event": "answered"
}
]
"participants": [
{
"id": 0,
"type": "end_user",
"status": "waiting",
"call_id": 0,
"user_id": 0, //This may be considered PII
"end_user_id": 0, //This may be considered PII
"call_duration": 0,
"hold_duration": 0,
"connected_at": "2018-06-07T19:49:52.896Z",
"ended_at": "2018-06-07T19:49:52.896Z",
"fail_reason": "nothing",
"adapter_fail_code": null,
"adapter_fail_message": null
},
"offer_type": null,
"offer_events": [],
"answer_type": "manual",
"outbound_number": null,
"wait_time_sms": [],
"in_call_sms": []
]
}
]
ステータス フィールドは次のいずれかの状態になります。
| 通話状況 | 説明 |
|---|---|
| 選択中 | エンドユーザーがコンタクト センターに電話をかけたものの、リーフノードからの通話リクエストの前にメニュー オプションを操作している状態。 |
| キューに格納済み | エンドユーザーがリーフ メニューノードを選択し、エージェントにデルタキャストまたはマルチキャストされる通話リクエストを開始した後に発生する状態。 |
| 割り当て済み | エージェントがエンドユーザーの通話を受けるために選択されたときに発生する状態。これは、エージェントが通話に応答したときに発生します。 |
| 接続中 | エージェントが割り当てられた後に発生し、エンドユーザーとエージェント間の接続が確立されるのを待っている状態。 |
| 接続済み | 通話が接続され、エージェントとエンドユーザーの両方が通話に参加している状態。 |
| 終了 | エージェントとエンドユーザーの会話がエラーなく通話を終了したときに発生する状態。 |
| 失敗 | エラーが原因で通話が終了したときに発生する状態。このステータスが表示されると、失敗の理由も表示され、コンテキストがより詳しく説明されます。 |
| 切り替え中 | 接続を試みているときに通話が失敗し、CCAI Platform が別の VOIP プロバイダで通話を接続しようとしているときに発生する状態。 |
| 復元済み | 通話に失敗したときにコールバックが発生する状態。この新しい通話は元の通話の子です。コールバックがエラーなく完了したことを示すメモが復元されました。 |
| スケジュール設定済み | エンドユーザーが、たらい回しオプションの一環として後で電話を受けることを選択した場合、または In-Web または In-App を使用して後で電話を受けることを選択した場合に発生する状態。 |
| アクションのみ | クライアント独自の電話プロバイダによって処理される通話が、iOS または Android SDK に接続されたときに発生する状態。 |
| アクションのみが完了しました | クライアントの電話プロバイダによって処理された通話が iOS または Android SDK に接続され、終了したときに発生する状態 |
| Deflected | 過剰容量キューまたは営業時間外の通話の構成に基づいて発生する状態。転送オプションには、ボイスメールや通話のスケジュール設定などがあります。回避率はチャネル（アプリ内、IVR、ウェブ内）によって異なります。 |
| ボイスメール | エンドユーザーがボイスメール オプションに転送され、後で聞くためにボイスメール メッセージを残すことを選択したときに発生する状態。この状態は、エンドユーザーがボイスメールを残しているときに存在します |
| ボイスメールの受信 | エンドユーザーがボイスメールを残し、エージェントがボイスメールを聴いていない状態 |
| Voicemail Read（ボイスメールの読み取り） | エージェントがボイスメールを開いて聴いているときに発生する状態。 |
call_type フィールドには、次のいずれかの値のみを指定できます。
| 呼び出しの種類 | 説明 |
|---|---|
| Voice Inbound（IVR） | エンドユーザーの電話からの PSTN 着信。 |
| 音声インバウンド（アプリ） | Google Mobile SDK を使用する iOS アプリまたは Android アプリ内から発信された着信。 |
| 音声コールバック（ウェブ） | Web SDK 内から発信された着信通話リクエスト |
| 音声スケジュール設定（アプリ） | Mobile SDK のスケジュール設定機能を使用して事前にスケジュール設定された、エージェントからエンドユーザーへの通話。 |
| Voice Scheduled（ウェブ） | Web SDK のスケジュール設定機能を使用して事前にスケジュール設定された、エージェントからエンドユーザーへの通話 |
| Voice Outbound | エージェントからエンドユーザーへの通話。ダイヤルパッドまたは外部電話回線への通話の他の方法を使用してダイヤルされます。 |
service_level_event フィールドには、次のいずれかの値のみを指定できます。
| サービスレベル イベント | 説明 |
|---|---|
| in_sla | SLA 内で通話に応答した |
| not_in_sla | 定義された SLA 内で通話に応答しなかった |
| 除外 | 通話が SLA の計算に含まれていない（通話が放棄された場合など） |
adapter_fail_code フィールドと adapter_fail_message フィールドは、null でない場合、次のいずれかの値のみになります。
| アダプターの失敗コード | アダプターのエラー メッセージ |
|---|---|
| 10001 | この呼び出しで予期しないエラーが発生しました。 |
| 11001 | この通話はキューで待機中に期限切れになりました。 |
| 20001 | この通話はお客様によってキャンセルされました。 |
| 20002 | この通話は顧客によって拒否されました。 |
| 20003 | この通話は顧客によって放棄されました。 |
| 20004 | この通話は、お客様がメニューを選択している途中で放棄されました。 |
| 21001 | 通話できませんでした。お客様の回線が話し中です。 |
| 21002 | 発信先の電話番号は無効です。 |
| 21003 | お客様がこの電話に出ませんでした。 |
| 22001 | この通話を開始するためのプッシュ通知を送信できませんでした。 |
| 30001 | この通話はキャンセルされました。 |
| 30002 | この期限切れの通話は参加されませんでした。 |
| 31001 | マイクを検出できません。デバイスの設定をご確認のうえ、もう一度お試しください。 |
| 31002 | マイクにアクセスできません。デバイスの権限を確認してから、もう一度お試しください。 |
| 32001 | 選択した発信番号が無効です。 |
| 32002 | 発信先の電話番号に電話を接続できません。 |
| 41001 | 通話接続で予期しないエラーが発生しました。 |
| 42001 | 通話接続で予期しないエラーが発生しました。 |
| 43001 | この呼び出しで予期しないエラーが発生しました。 |
| 44001 | この呼び出しで予期しないエラーが発生しました。 |
| 44002 | 接続がタイムアウトしたため、この通話は終了しました。 |
| 44003 | この呼び出しで予期しないエラーが発生しました。 |
| 90001 | 音声が検出されなかったため、この通話は終了しました。 |
| 90002 | オーディオ デバイスを起動できません。オーディオ デバイスの権限を確認してから、もう一度お試しください。 |
通話
| パラメータ | 必須 | データ型 | 定義 |
|---|---|---|---|
| connected_at[from] | FALSE | UTC の時間 | connected_at フィールドの下限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| connected_at[to] | FALSE | UTC の時間 | connected_at フィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| updated_at[from] | FALSE | UTC の時間 | updated at フィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| updated_at[to] | FALSE | UTC の時間 | connected_at フィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| queued_at[from] | FALSE | UTC の時間 | queued at フィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| queued_at[to] | FALSE | UTC の時間 | queued at フィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| rating[from] | FALSE | 1 ～ 5 の数値または null | レーティング フィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| rating[to] | FALSE | 1 ～ 5 の数値または null | は、評価フィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| call_duration[from] | FALSE | 数値 | 通話時間のフィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| call_duration[to] | FALSE | 数値 | は、通話時間フィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| hold_duration[from] | FALSE | 数値 | 保持期間フィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| hold_duration[to] | FALSE | 数値 | 保持期間フィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| id[] | FALSE | Array[String] | 文字列の配列。検索して返すレコードの ID。 |
| agent_id[] | FALSE | Array[String] | エージェント ID でレスポンスをフィルタします |
| end_user_id[] | FALSE | Array[String] | エンドユーザー ID に基づいてレスポンスをフィルタする |
| call_status[] | FALSE | Array[String] | 通話ライフサイクル内の特定の状態のレコードを返します。有効な値は、scheduled、queued、assigned、connecting、switching、connected、finished、failed、recovered、deflected、selecting、action_only、action_only_finished、voicemail、voicemail_received、voicemail_read です。 |
| call_fail_reason[] | FALSE | Array[String] | 特定の方法で失敗したレコードを返します。有効な値は、nothing、unknown、expired、eu_canceled、eu_rejected、eu_abandoned、eu_in_menu_abandoned、eu_busy、eu_wrong_number、eu_no_answer、eu_noti_failed、ag_canceled、ag_ignored、ag_mic_no_device、ag_mic_denied、voip_twilio_error、voip_tokbox_error、voip_invalid_token、voip_conn_general、voip_conn_timeout、voip_conn_signal です。 |
| verified[] | FALSE | ブール値 | 確認済み（True）または未確認（False）のレコードを返します。 |
| call_type[] | FALSE | Array[String] | 指定された通話タイプのレコードを返します。使用できる値は、IncomingCallApp、ScheduledCallApp、OutboundCall、AgentScheduledCall、IvrCall、IncomingCallWeb、ScheduledCallWeb、ActionOnlyCall です。 |
| support_number[] | FALSE | Array[String] | エンドユーザーが連絡に使用した電話番号でフィルタ（IVR 通話のみ） |
エンドポイント:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/calls
ヘッダー:
| キー | 値 | 説明 |
|---|---|---|
| Content-Type | application/json |
リクエスト/レスポンスのその他の例:
リクエストの例: 通話
本文: なし
回答の例: 通話
[
{
"id": 1,
"lang": "en",
"call_type": "Voice Inbound (App)",
"status": "finished",
"created_at": "2016-02-19T18:53:56.000Z",
"queued_at": "2016-02-19T18:53:57.000Z",
"assigned_at": "2016-02-19T18:53:58.000Z",
"connected_at": "2016-02-19T18:54:18.000Z",
"ends_at": "2016-02-19T18:54:39.000Z",
"updated_at": "2016-02-19T18:54:39.000Z",
"scheduled_at": null,
"queue_duration": 22,
"wait_duration": 22,
"call_duration": 21,
"hold_duration": 0,
"rating": null,
"has_feedback": false,
"voip_provider": "voip_provider_twilio",
"out_ticket_id": null,
"out_ticket_url": null,
"verified": false,
"recording_url": null,
"recording_permission": "not_asked",
"voicemail_reason": "not_voicemail",
"deflection": "no_deflection",
"disconnected_by": "disconnected_by_unknown",
"fail_reason": "nothing",
"fail_details": null,
"recordings": [
{
"id": 7,
"call_id": 1,
"conference_sid": "CF50ec183fafcff801226b6fc332EC02ba7c4",
"duration": 20,
"recording_type": "default",
"redaction_times": [
{
"start": "2016-02-19T18:54:23.000Z",
"end": "2016-02-19T18:54:25.000Z",
"duration": 2.000,
"start_agent_id": 2,
"end_agent_id": 2
}
],
"started_at": "2016-02-19T18:54:18.000Z"
}
],
"support_number": "+12128675309",
"selected_menu": {
"id": 11,
"name": "Carpentry",
"parent_id": 1,
"position": 1,
"deleted": false,
"hidden": false,
"menu_type": "ivr_menu",
"output_msg": "Thanks for calling Death Star Carpentry"
},
"menu_path": {
"items_count": 1,
"name": "Carpentry",
"materialized_path": "Death Star/Carpentry"
},
"queue_priority_level": 0,
"end_user": {
"id": 3,
"identifier": "Death Star Carpentry Union",
"out_contact_id": "363876643527"
},
"photos": [{
"id": 0,
"photo_type": "photo",
"url": "www.photolocation.co/photo/123456868686"
}],
"videos": [{
"id": 0,
"url": "www.videolocation.co/video/123456868686"
}],
"transfers": [{
"id": 11,
"status": "transferring",
"fail_reason": "nothing",
"created_at": "2016-02-19T18:58:18.000Z",
"from_menu": {
"items_count": 2,
"name": "Cabinetry",
"materialized_path": "Death Star/Cabinetry"
},
"to_menu": {
"items_count": 2,
"name": "Carpentry",
"materialized_path": "Death Star/Carpentry"
},
"from_agent": {
"id": 2,
"name": "San Holo",
"last_name": "San",
"first_name": "Holo",
"agent_number": "6",
"avatar_url": "www.avatarurl.co/avatar/1234543"
},
"to_agent": {
"id": 0,
"name": "Farrison Hord",
"last_name": "Farrison",
"first_name": "Hord",
"agent_number": "12",
"avatar_url": "www.avatarurl.co/avatar/1234545"
}
}],
"participants": [
{
"id": 5,
"type": "end_user",
"status": "finished",
"call_id": 3,
"user_id": null,
"end_user_id": 3,
"call_duration": 21,
"hold_duration": null,
"connected_at": "2016-02-19T18:54:18.000Z",
"ended_at": "2016-02-19T18:54:39.000Z",
"fail_reason": "nothing"
},
{
"id": 3,
"type": "agent",
"status": "finished",
"call_id": 3,
"user_id": 5,
"end_user_id": null,
"call_duration": 21,
"hold_duration": null,
"connected_at": "2016-02-19T18:54:18.000Z",
"ended_at": "2016-02-19T18:54:39.000Z",
"fail_reason": "nothing"
},
{
"id": 6,
"type": "agent",
"status": "finished",
"call_id": 3,
"user_id": 12,
"end_user_id": null,
"call_duration": 21,
"hold_duration": null,
"connected_at": "2016-02-19T18:54:18.000Z",
"ended_at": "2016-02-19T18:54:39.000Z",
"fail_reason": "nothing"
}
],
"offer_type": "cascade",
"offer_events": [
{
"casting_time": "2018-11-12T15:52:38.000Z",
"group": "Group 1"
}
],
"answer_type": "manual",
"outbound_number": null,
"dispositions": [
{
"user_id": 3,
"participant_id": 225,
"code": "Product question"
},
{
"user_id": 3,
"transfer_id": 1,
"participant_id": 226,
"code": "Requires follow up"
}
],
"consumer_handle_durations": [
{
"id": 100,
"call_duration": 314,
"hold_duration": 3,
"started_at": "2016-02-19T18:50:08.000Z",
"ended_at": "2016-02-19T18:55:22.000Z"
}
],
"consumer_in_menu_durations": [
{
"id": 100,
"event": "finished",
"duration": 238,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"started_at": "2016-02-19T18:50:08.000Z",
"ended_at": "2016-02-19T18:54:06.000Z"
}
],
"consumer_event_durations": [
{
"id": 10,
"type": "payment",
"event": "finished",
"duration": 20,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"started_at": "2016-02-19T18:54:38.000Z",
"ended_at": "2016-02-19T18:54:58.000Z"
},
{
"id": 11,
"type": "csat",
"event": "abandoned",
"duration": 4,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"started_at": "2016-02-19T18:54:39.000Z",
"ended_at": "2016-02-19T18:54:43.000Z"
}
],
"handle_durations": [
{
"id": 10001,
"agent_id": 5,
"acw_duration": 0,
"bcw_duration": 0,
"call_duration": 21,
"assigned_connection_duration": 10,
"hold_duration": 3,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"barged": 0,
"transfer": 0,
"transfer_id": null,
"transfer_cold": 0,
"started_at": "2016-02-19T18:54:18.000Z",
"ended_at": "2016-02-19T18:54:39.000Z",
"scheduled_at": null
},
{
"id": 10002,
"agent_id": 5,
"acw_duration": 25,
"bcw_duration": 0,
"call_duration": 0,
"assigned_connection_duration": 0,
"hold_duration": 0,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"barged": 0,
"transfer": 0,
"transfer_id": null,
"transfer_cold": 0,
"started_at": "2016-02-19T18:54:39.000Z",
"ended_at": "2016-02-19T18:55:04.000Z",
"scheduled_at": null
},
{
"id": 10003,
"agent_id": 12,
"acw_duration": 1,
"bcw_duration": 0,
"call_duration": 21,
"assigned_connection_duration": 5,
"hold_duration": 0,
"menu_path_id": 4,
"menu_path": "Deathstar/Returns",
"lang": "en",
"barged": 0,
"transfer": 1,
"transfer_id": 11,
"transfer_cold": 0,
"started_at": "2016-02-19T18:54:18.000Z",
"ended_at": "2016-02-19T18:54:39.000Z",
"scheduled_at": null
}
],
"queue_durations": [
{
"id": 20011,
"agent_id": 5,
"queue_duration": 12,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"transfer": 0,
"transfer_id": null,
"transfer_cold": 0,
"started_at": "2016-02-19T18:54:06.000Z",
"ended_at": "2016-02-19T18:54:18.000Z",
"service_level_abandon_time_threshold": 10,
"service_level_event": "in_sla",
"service_level_target_percent": 90,
"service_level_target_time": 60
},
{
"id": 20012,
"agent_id": 12,
"queue_duration": 10,
"menu_path_id": 21,
"menu_path": "Deathstar/Returns",
"lang": "en",
"transfer": 1,
"transfer_id": 11,
"transfer_cold": 0,
"started_at": "2016-02-19T18:54:08.000Z",
"ended_at": "2016-02-19T18:54:18.000Z",
"service_level_abandon_time_threshold": 10,
"service_level_event": "not_in_sla",
"service_level_target_percent": 90,
"service_level_target_time": 60
}
],
"virtual_agent": {
"id": 10,
"name": "D2-R2"
},
"virtual_agent_deflected_escalations": [
{
"id": 1,
"deflection": "after_hours",
"escalation_id": 1,
"escalation_reason": "by_end_user_message",
"escalated_at": "2016-02-19T18:54:06.000Z",
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"virtual_agent": {
"id": 10,
"name": "D2-R2"
}
}
],
"virtual_agent_handle_durations": [
{
"id": 1,
"virtual_agent": {
"id": 10,
"name": "D2-R2"
},
"call_duration": 11,
"escalation_reason": "by_end_user_message",
"sentiment": 85,
"response_count": 11,
"fallback_response_count": 1,
"initiated_by": "end_user",
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"transfer": false,
"transfer_id": null,
"started_at": "2016-02-19T18:52:36.000Z",
"ended_at": "2016-02-19T18:54:06.000Z"
}
]
}
]
ステータス コード: 200