チャット リソースのモデルを次に示します。このモデルを参照して、どのフィールドに PII が含まれている可能性があるかを判断します。
[
{
"id": 31354,
"lang": "en",
"chat_type": "Messaging Inbound (App Chat)",
"status": "finished",
"sub_status": "Disconnected by end user",
"created_at": "2019-07-17T07:27:14.000Z",
"assigned_at": "2019-07-17T07:27:20.000Z",
"ends_at": "2019-07-17T07:29:02.000Z",
"updated_at": "2019-07-17T07:29:02.000Z",
"first_msg_sent_at": "2019-07-17T07:27:26.000Z",
"last_msg_sent_at": "2019-07-17T07:27:28.000Z",
"wait_duration": 0, //Deprecated, use queue_duration instead
"queue_duration": 0,
"chat_duration": 0,
"verified": false,
"rating": 0,
"has_feedback": false,
"out_ticket_id": "string",
"out_ticket_url": "string",
"finish_reason": "finish_reason_none",
"fail_reason": null,
"message_count": 3,
"average_response_time": 0,
"longest_response_time": 0,
"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": 1,
"name": "Ringo",
"materialized_path": "3389"
},
"agent_info": {
"id": 0,
"name": "string",
"last_name": "string",
"first_name": "string",
"agent_number": "string",
"avatar_url": "string"
},
"end_user": {
"id": 0,
"identifier": "string",
"out_contact_id": "string"
},
"photos": [
{
"id": 0,
"photo_type": "photo",
"url": "string"
}
],
"videos": [
{
"id": 0,
"url": "string"
}
],
"transfers": [
{
"id": 0,
"status": "transferring",
"fail_reason": "nothing",
"created_at": "2018-06-07T19:49:52.896Z",
"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",
"last_name": "string",
"first_name": "string",
"agent_number": "string",
"avatar_url": "string"
},
"to_agent": {
"id": 0,
"name": "string",
"last_name": "string",
"first_name": "string",
"agent_number": "string",
"avatar_url": "string"
}
}
],
"handle_durations": [
{
"agent_id": 0,
"acw_duration": 0,
"chat_duration" 0,
"wait_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",
"event": "chat_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,
"end_user_id": 0,
"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"
}
]
}
"offer_type": "cascade",
"offer_events": [
{
"casting_time": "2019-07-17T07:27:15.000Z",
"group": "Group 1"
}
]
},
service_level_event フィールドには、次のいずれかの値のみを指定できます。
| サービスレベル イベント | 説明 |
|---|---|
| in_sla | 通話が SLA の期間内に応答された |
| not_in_sla | 定義された SLA 内で通話に応答しなかった |
| 除外 | 通話が SLA の計算に含まれていない（通話が放棄された場合など） |
チャット
| パラメータ | 必須 | データ型 | 定義 |
|---|---|---|---|
| sort_column | FALSE | 文字列 | レスポンス オブジェクトの任意のフィールドに基づいてレスポンスを並べ替えます。 |
| sort_direction | FALSE | ASC または DESC | 並べ替えの方向（昇順または降順）を記録します。 |
| ページ | FALSE | 文字列 | 「per」と組み合わせて、レコードのページ番号を示します。たとえば、per が 200 で page が 2 の場合、レスポンスにはレコード 201 ～ 400 が含まれます。ページ 1 には 1 ～ 200 が含まれます。 |
| / | FALSE | 文字列 | ページとペアになって、レコードのページに含まれるレコードの数を示します。たとえば、per が 200 で page が 2 の場合、レスポンスにはレコード 201 ～ 400 が含まれます。ページ 1 には 1 ～ 200 が含まれます。 |
| assigned_at[from] | FALSE | UTC の時間 | 割り当て日フィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| assigned_at[to] | FALSE | UTC の時間 | 割り当て日フィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| ends_at[from] | FALSE | UTC の時間 | ends at フィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| ends_at[to] | FALSE | UTC の時間 | ends at フィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| updated_at[from] | FALSE | UTC の時間 | updated at フィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| updated_at[to] | FALSE | UTC の時間 | updated at フィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| created_at[from] | FALSE | UTC の時間 | created_at フィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| created_at[to] | FALSE | UTC の時間 | created_at フィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| rating[from] | FALSE | 1 ～ 5 の数値または null | レーティング フィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| rating[to] | FALSE | 1 ～ 5 の数値または null | は、評価フィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| first_msg_sent_at[from] | FALSE | UTC の時間 | 最初のメッセージの送信時刻フィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| first_msg_sent_at[to] | FALSE | UTC の時間 | は、最初のメッセージが送信された時刻の上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| last_msg_sent_at[from] | FALSE | UTC の時間 | フィールドで送信された最後のメッセージの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| last_msg_sent_at[to] | FALSE | UTC の時間 | フィールドに送信された最後のメッセージの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| chat_duration[from] | FALSE | 数値 | チャット時間のフィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| chat_duration[to] | FALSE | 数値 | チャット時間のフィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| message_count[from] | FALSE | 数値 | メッセージ数のフィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| message_count[to] | FALSE | 数値 | は、メッセージ数の上限フィールドを作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| average_response_time[from] | FALSE | 数値 | 平均応答時間フィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| average_response_time[to] | FALSE | 数値 | 平均応答時間フィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| longest_response_time[from] | FALSE | 数値 | 最長応答時間フィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| longest_response_time[to] | FALSE | 数値 | 最長応答時間フィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| wait_duration[from] | FALSE | 数値 | 待機時間のフィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| wait_duration[to] | FALSE | 数値 | 待機時間のフィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
| id[] | FALSE | Array[String] | Array[Strings]。検索して返すレコードの ID |
| agent_id[] | FALSE | Array[String] | エージェント ID でレスポンスをフィルタします |
| end_user_id[] | FALSE | Array[String] | エンドユーザー ID に基づいてレスポンスをフィルタします |
| chat_type[] | FALSE | Array[String] | エンドユーザーがチャットにアクセスした方法に基づいてレコードを返します。有効な値: Messaging Inbound（アプリ チャット）、Messaging Inbound（ウェブ チャット）、Messaging（SMS） |
| chat_status[] | FALSE | Array[String] | ユーザーがチャット ライフサイクルのどの段階にいるかに基づいてレコードを返します。有効な値: queued、assigned、finished、canceled、failed、no_response |
| verified[] | FALSE | ブール値 | 確認済み（True）または未確認（False）のレコードを返します。 |
| chat_fail_reason[] | FALSE | Array[String] | チャットが失敗した理由に基づいてレコードを返します。有効な値: nothing、unknown、no_response、expired |
service_level_event 値には次の値を指定できます。
| サービスレベル イベント | 説明 |
|---|---|
| in_sla | 通話が SLA の期間内に応答された |
| not_in_sla | 定義された SLA 内で通話に応答しなかった |
| 除外 | 通話が SLA の計算に含まれていない（通話が放棄された場合など） |
エンドポイント:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/chats
リクエスト/レスポンスのその他の例:
リクエストの例: チャット
クエリ:
| キー | 値 | 説明 |
|---|---|---|
| updated_at[from] | \{updated_at\[from\]\} | UTC の時刻。updated_at フィールドの下限を作成します。返されるすべてのレコードは、入力された値より後のものになります。 |
| updated_at[to] | \{updated_at\[to\]\} | UTC 時間。updated at フィールドの上限を作成します。返されるすべてのレコードは、入力された値より前のものになります。 |
本文: なし
回答の例: チャット
[
{
"id": 1,
"lang": "en",
"chat_type": "Messaging Inbound (App Chat)",
"status": "finished",
"created_at": "2016-02-26T18:35:54.000Z",
"assigned_at": "2016-02-26T18:36:05.000Z",
"ends_at": "2016-02-26T18:37:24.000Z",
"updated_at": "2016-02-26T18:37:24.000Z",
"first_msg_sent_at": null,
"last_msg_sent_at": null,
"chat_duration": 11,
"wait_duration": 22,
"queue_duration": 22,
"verified": true,
"rating": 5,
"has_feedback": false,
"out_ticket_id": "209",
"out_ticket_url": null,
"fail_reason": null,
"message_count": 0,
"average_response_time": 0,
"longest_response_time": 0,
"selected_menu": null,
"menu_path": null,
"agent_info": {
"id": 4,
"agent_number": "007",
"name": "Storm Trooper 1",
"last_name": "Storm",
"first_name": "Trooper 1",
},
"end_user": {
"id": 1,
"identifier": "Death Star Carpentry",
"out_contact_id": "360949501087"
},
"photos": [
{
"id": 3,
"photo_type": "photo",
"url": "true"
}
],
"consumer_handle_durations": [
{
"id": 100,
"chat_duration": 314,
"message_count": 10,
"response_count": 6,
"response_time_total": 85,
"response_time_max": 25,
"response_time_avg": 12,
"started_at": "2016-02-19T18:50:08.000Z",
"ended_at": "2016-02-19T18:55:22.000Z"
}
],
"consumer_event_durations": [
{
"id": 11,
"type": "csat",
"event": "finished",
"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": 30001,
"agent_id": 4,
"acw_duration": 0,
"chat_duration": 11,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"transfer": 0,
"transfer_id": null,
"started_at": "2016-03-02T23:24:08.000Z",
"ended_at": "2016-03-02T23:24:42.000Z",
"response_count": 11,
"response_time_total": 259,
"response_time_max": 29,
"response_time_avg": 24,
"assigned_connection_duration": 10
}
],
"queue_durations": [
{
"id": 41234,
"agent_id": 5,
"queue_duration": 22,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"transfer": 0,
"transfer_id": null,
"transfer_cold": 0,
"started_at": "2016-03-02T23:23:56.000Z",
"ended_at": "2016-03-02T23:24:08.000Z",
"service_level_abandon_time_threshold": 10,
"service_level_event": "not_in_sla",
"service_level_target_percent": 90,
"service_level_target_time": 60
}
]
"videos": [],
"transfers": [],
"participants": [],
"virtual_agent": null,
"virtual_agent_deflected_escalations": [],
"virtual_agent_handle_durations": []
},
{
"id": 2,
"lang": "en",
"chat_type": "in-app",
"status": "finished",
"created_at": "2016-03-02T23:24:05.000Z",
"assigned_at": "2016-03-02T23:24:08.000Z",
"ends_at": "2016-03-02T23:24:42.000Z",
"updated_at": "2016-03-02T23:24:42.000Z",
"first_msg_sent_at": null,
"last_msg_sent_at": null,
"wait_duration": 12,
"queue_duration": 12,
"chat_duration": 34,
"verified": false,
"rating": 2,
"has_feedback": false,
"out_ticket_id": "214",
"out_ticket_url": null,
"fail_reason": null,
"message_count": 0,
"average_response_time": 0,
"longest_response_time": 0,
"selected_menu": null,
"menu_path": null,
"agent_info": null,
"end_user": {
"id": 1,
"identifier": "Death Star Carpentry",
"out_contact_id": "360949501087"
},
"photos": [],
"videos": [],
"transfers": [],
"participants": [],
"handle_durations": [
{
"id": 30001,
"agent_id": 4,
"acw_duration": 0,
"chat_duration": 34,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"transfer": 0,
"transfer_id": null,
"started_at": "2016-03-02T23:24:08.000Z",
"ended_at": "2016-03-02T23:24:42.000Z",
"response_count": 11,
"response_time_total": 259,
"response_time_max": 29,
"response_time_avg": 24,
"assigned_connection_duration": 10
}
],
"queue_durations": [
{
"id": 41234,
"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-03-02T23:23:56.000Z",
"ended_at": "2016-03-02T23:24:08.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_reason": "by_end_user_message",
"escalated_at": "2016-03-02T23:23:56.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"
},
"chat_duration": 11,
"escalation_reason": "by_end_user_message",
"response_count": 11,
"response_time_total": 34,
"response_time_max": 4,
"response_time_avg": 3,
"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-03-02T23:23:16.000Z",
"ended_at": "2016-03-02T23:23:56.000Z"
}
]
}
]
ステータス コード: 200