Berikut adalah model resource chat. Lihat model ini untuk menentukan kolom mana yang mungkin berisi 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"
}
]
},
Kolom service_level_event hanya dapat memiliki salah satu nilai berikut:
| Peristiwa Tingkat Layanan | Deskripsi |
|---|---|
| in_sla | Panggilan dijawab dalam SLA |
| not_in_sla | Panggilan tidak dijawab dalam SLA yang ditentukan |
| dikecualikan | Panggilan tidak disertakan dalam perhitungan SLA (misalnya, jika panggilan dibatalkan) |
Chat
| Parameter | Wajib | Jenis Data | Definisi |
|---|---|---|---|
| sort_column | FALSE | String | Mengurutkan respons berdasarkan kolom apa pun dalam objek respons. |
| sort_direction | FALSE | ASC atau DESC | Mencatat arah pengurutan, baik menaik atau menurun |
| page | FALSE | String | Dipasangkan dengan per untuk mencatat halaman rekaman. Misalnya, jika per dibuat menjadi 200 dan halaman adalah 2, respons akan berisi rekaman 201-400, karena halaman 1 akan berisi 1-200. |
| per | FALSE | String | Dipasangkan dengan halaman untuk mencatat jumlah rekaman yang akan disertakan dalam halaman rekaman. Misalnya, jika per dibuat menjadi 200 dan halaman adalah 2, respons akan berisi rekaman 201-400, karena halaman 1 akan berisi 1-200. |
| assigned_at[from] | FALSE | Waktu dalam UTC | membuat batas bawah kolom ditetapkan pada. Semua rekaman yang ditampilkan akan berada setelah nilai yang dimasukkan. |
| assigned_at[to] | FALSE | Waktu dalam UTC | membuat batas atas kolom ditetapkan pada. Semua rekaman yang ditampilkan akan berada sebelum nilai yang dimasukkan. |
| ends_at[from] | FALSE | Waktu dalam UTC | membuat batas bawah kolom berakhir pada. Semua rekaman yang ditampilkan akan berada setelah nilai yang dimasukkan. |
| ends_at[to] | FALSE | Waktu dalam UTC | membuat batas atas kolom berakhir pada. Semua rekaman yang ditampilkan akan berada sebelum nilai yang dimasukkan. |
| updated_at[from] | FALSE | Waktu dalam UTC | membuat batas bawah kolom diperbarui pada. Semua rekaman yang ditampilkan akan berada setelah nilai yang dimasukkan. |
| updated_at[to] | FALSE | Waktu dalam UTC | membuat batas atas kolom diperbarui pada. Semua rekaman yang ditampilkan akan berada sebelum nilai yang dimasukkan. |
| created_at[from] | FALSE | Waktu dalam UTC | membuat batas bawah kolom dibuat pada. Semua rekaman yang ditampilkan akan berada setelah nilai yang dimasukkan. |
| created_at[to] | FALSE | Waktu dalam UTC | membuat batas atas kolom dibuat pada. Semua rekaman yang ditampilkan akan berada sebelum nilai yang dimasukkan. |
| rating[from] | FALSE | Angka 1-5 atau null | membuat batas bawah kolom rating. Semua rekaman yang ditampilkan akan berada setelah nilai yang dimasukkan. |
| rating[to] | FALSE | Angka 1-5 atau null | membuat batas atas kolom rating. Semua rekaman yang ditampilkan akan berada sebelum nilai yang dimasukkan. |
| first_msg_sent_at[from] | FALSE | Waktu dalam UTC | membuat batas bawah kolom pesan pertama dikirim pada. Semua rekaman yang ditampilkan akan berada setelah nilai yang dimasukkan. |
| first_msg_sent_at[to] | FALSE | Waktu dalam UTC | membuat batas atas kolom pesan pertama dikirim pada. Semua rekaman yang ditampilkan akan berada sebelum nilai yang dimasukkan. |
| last_msg_sent_at[from] | FALSE | Waktu dalam UTC | membuat batas bawah kolom pesan terakhir dikirim pada. Semua rekaman yang ditampilkan akan berada setelah nilai yang dimasukkan. |
| last_msg_sent_at[to] | FALSE | Waktu dalam UTC | membuat batas atas kolom pesan terakhir dikirim pada. Semua rekaman yang ditampilkan akan berada sebelum nilai yang dimasukkan. |
| chat_duration[from] | FALSE | Angka | membuat batas bawah kolom durasi chat. Semua rekaman yang ditampilkan akan berada setelah nilai yang dimasukkan. |
| chat_duration[to] | FALSE | Angka | membuat batas atas kolom durasi chat. Semua rekaman yang ditampilkan akan berada sebelum nilai yang dimasukkan. |
| message_count[from] | FALSE | Angka | membuat batas bawah kolom jumlah pesan. Semua rekaman yang ditampilkan akan berada setelah nilai yang dimasukkan. |
| message_count[to] | FALSE | Angka | membuat batas atas kolom jumlah pesan. Semua rekaman yang ditampilkan akan berada sebelum nilai yang dimasukkan. |
| average_response_time[from] | FALSE | Angka | membuat batas bawah kolom waktu respons rata-rata. Semua rekaman yang ditampilkan akan berada setelah nilai yang dimasukkan. |
| average_response_time[to] | FALSE | Angka | membuat batas atas kolom waktu respons rata-rata. Semua rekaman yang ditampilkan akan berada sebelum nilai yang dimasukkan. |
| longest_response_time[from] | FALSE | Angka | membuat batas bawah kolom waktu respons terlama. Semua rekaman yang ditampilkan akan berada setelah nilai yang dimasukkan. |
| longest_response_time[to] | FALSE | Angka | membuat batas atas kolom waktu respons terlama. Semua rekaman yang ditampilkan akan berada sebelum nilai yang dimasukkan. |
| wait_duration[from] | FALSE | Angka | membuat batas bawah kolom durasi tunggu. Semua rekaman yang ditampilkan akan berada setelah nilai yang dimasukkan. |
| wait_duration[to] | FALSE | Angka | membuat batas atas kolom durasi tunggu. Semua rekaman yang ditampilkan akan berada sebelum nilai yang dimasukkan. |
| id[] | FALSE | Array[String] | Array[String]. ID rekaman yang akan dicari dan ditampilkan |
| agent_id[] | FALSE | Array[String] | Memfilter respons berdasarkan ID agen |
| end_user_id[] | FALSE | Array[String] | Memfilter respons berdasarkan ID pengguna akhir |
| chat_type[] | FALSE | Array[String] | Menampilkan rekaman berdasarkan cara pengguna akhir mengakses chat. Nilai yang mungkin: Messaging Inbound (Chat Aplikasi), Messaging Inbound (Chat Web), Messaging (SMS) |
| chat_status[] | FALSE | Array[String] | Menampilkan rekaman berdasarkan posisi pengguna dalam siklus proses chat. Nilai yang mungkin: queued, assigned, finished, canceled, failed, no_response |
| verified[] | FALSE | Boolean | Menampilkan rekaman yang telah diverifikasi (True) atau belum diverifikasi (False) |
| chat_fail_reason[] | FALSE | Array[String] | Menampilkan rekaman berdasarkan alasan chat mungkin gagal. Nilai yang mungkin: nothing, unknown, no_response, expired |
Nilai service_level_event dapat memiliki nilai berikut.
| Peristiwa Tingkat Layanan | Deskripsi |
|---|---|
| in_sla | Panggilan dijawab dalam SLA |
| not_in_sla | Panggilan tidak dijawab dalam SLA yang ditentukan |
| dikecualikan | Panggilan tidak disertakan dalam perhitungan SLA (misalnya, jika panggilan dibatalkan) |
Endpoint:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/chats
Contoh Permintaan/Respons lainnya:
Contoh permintaan: Chat
Kueri:
| Kunci | Nilai | Deskripsi |
|---|---|---|
| updated_at[from] | \{updated_at\[from\]\} | Waktu dalam UTC. membuat batas bawah kolom diperbarui pada. Semua rekaman yang ditampilkan akan berada setelah nilai yang dimasukkan. |
| updated_at[to] | \{updated_at\[to\]\} | Waktu dalam UTC. membuat batas atas kolom diperbarui pada. Semua rekaman yang ditampilkan akan berada sebelum nilai yang dimasukkan. |
Isi: Tidak ada
Contoh respons: Chat
[
{
"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"
}
]
}
]
Kode Status: 200