בהמשך מופיע מודל של משאב הצ'אט. כדאי לעיין במודל הזה כדי לדעת אילו שדות עשויים להכיל פרטים אישיים מזהים (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 | השיחה נענתה במסגרת הסכם רמת השירות |
| not_in_sla | השיחה לא נענתה במסגרת הסכם רמת השירות (SLA) שהוגדר |
| לא כלול | השיחה לא נכללה בחישוב של הסכם רמת השירות (לדוגמה, אם השיחה ננטשה) |
צ'אטים
| פרמטר | חובה | סוג הנתונים | הגדרה |
|---|---|---|---|
| sort_column | לא נכון | String | מיון התגובה על סמך שדה כלשהו באובייקט התגובה. |
| sort_direction | לא נכון | ASC או DESC | הערה לגבי כיוון המיון, בסדר עולה או יורד |
| ייפתח | לא נכון | String | התאמה לכל דף כדי לציין את מספר הדף של הרשומות. לדוגמה, אם הערך של per הוא 200 והערך של page הוא 2, התגובה תכיל את רשומות 201 עד 400, כי דף 1 יכיל את רשומות 1 עד 200. |
| לכל | לא נכון | String | השדה הזה משויך לדף ומציין כמה רשומות ייכללו בדף של רשומות. לדוגמה, אם הערך של per הוא 200 והערך של page הוא 2, התגובה תכיל את רשומות 201 עד 400, כי דף 1 יכיל את רשומות 1 עד 200. |
| assigned_at[from] | לא נכון | השעה לפי שעון UTC | יוצרת גבול תחתון של השדה assigned at. כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן. |
| assigned_at[to] | לא נכון | השעה לפי שעון UTC | יוצרת גבול עליון של השדה 'הוקצה בתאריך'. כל הרשומות שיוחזרו יהיו לפני הערך שהוזן. |
| ends_at[from] | לא נכון | השעה לפי שעון UTC | יוצרת גבול תחתון של הקצוות בשדה. כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן. |
| ends_at[to] | לא נכון | השעה לפי שעון UTC | יוצרת גבול עליון של הקצוות בשדה. כל הרשומות שיוחזרו יהיו לפני הערך שהוזן. |
| updated_at[from] | לא נכון | השעה לפי שעון UTC | יוצרת גבול תחתון של השדה updated at. כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן. |
| updated_at[to] | לא נכון | השעה לפי שעון UTC | יוצר גבול עליון של השדה 'עודכן בתאריך'. כל הרשומות שיוחזרו יהיו לפני הערך שהוזן. |
| created_at[from] | לא נכון | השעה לפי שעון UTC | יוצרת גבול תחתון של השדה created at. כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן. |
| created_at[to] | לא נכון | השעה לפי שעון UTC | יוצרת גבול עליון של השדה created at. כל הרשומות שיוחזרו יהיו לפני הערך שהוזן. |
| rating[from] | לא נכון | מספר 1-5 או ערך null | יוצרת גבול תחתון של שדה הדירוג. כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן. |
| rating[to] | לא נכון | מספר 1-5 או ערך null | יוצרת גבול עליון לשדה הדירוג. כל הרשומות שיוחזרו יהיו לפני הערך שהוזן. |
| first_msg_sent_at[from] | לא נכון | השעה לפי שעון UTC | יוצר גבול תחתון של השדה 'ההודעה הראשונה שנשלחה ב'. כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן. |
| first_msg_sent_at[to] | לא נכון | השעה לפי שעון UTC | יוצר גבול עליון של השדה 'הודעה ראשונה שנשלחה בשעה'. כל הרשומות שיוחזרו יהיו לפני הערך שהוזן. |
| last_msg_sent_at[from] | לא נכון | השעה לפי שעון UTC | יוצר גבול תחתון של השדה last msg sent at. כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן. |
| last_msg_sent_at[to] | לא נכון | השעה לפי שעון UTC | יוצר גבול עליון של השדה 'ההודעה האחרונה שנשלחה ב'. כל הרשומות שיוחזרו יהיו לפני הערך שהוזן. |
| chat_duration[from] | לא נכון | מספר | יוצר גבול תחתון של שדה משך הצ'אט. כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן. |
| chat_duration[to] | לא נכון | מספר | יוצר גבול עליון לשדה משך הצ'אט. כל הרשומות שיוחזרו יהיו לפני הערך שהוזן. |
| message_count[from] | לא נכון | מספר | יוצרת גבול תחתון של שדה ספירת ההודעות. כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן. |
| message_count[to] | לא נכון | מספר | יוצרת גבול עליון של שדה ספירת ההודעות. כל הרשומות שיוחזרו יהיו לפני הערך שהוזן. |
| average_response_time[from] | לא נכון | מספר | יוצר גבול תחתון של השדה 'זמן תגובה ממוצע'. כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן. |
| average_response_time[to] | לא נכון | מספר | יוצר גבול עליון של השדה 'זמן תגובה ממוצע'. כל הרשומות שיוחזרו יהיו לפני הערך שהוזן. |
| longest_response_time[from] | לא נכון | מספר | יוצר גבול תחתון של השדה 'זמן התגובה הארוך ביותר'. כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן. |
| longest_response_time[to] | לא נכון | מספר | יוצר גבול עליון של השדה 'זמן התגובה הארוך ביותר'. כל הרשומות שיוחזרו יהיו לפני הערך שהוזן. |
| wait_duration[from] | לא נכון | מספר | יוצרת גבול תחתון של שדה משך ההמתנה. כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן. |
| wait_duration[to] | לא נכון | מספר | יוצרת גבול עליון לשדה של משך ההמתנה. כל הרשומות שיוחזרו יהיו לפני הערך שהוזן. |
| id[] | לא נכון | Array[String] | Array[Strings]. מזהה הרשומות שרוצים לחפש ולהחזיר |
| agent_id[] | לא נכון | Array[String] | סינון התשובה לפי מזהה הסוכן |
| end_user_id[] | לא נכון | Array[String] | מסנן את התשובה על סמך מזהה משתמש הקצה |
| chat_type[] | לא נכון | Array[String] | הפונקציה מחזירה רשומות על סמך האופן שבו משתמש הקצה ניגש לצ'אט. ערכים אפשריים: הודעות נכנסות (צ'אט באפליקציה), הודעות נכנסות (צ'אט באתר), הודעות (SMS) |
| chat_status[] | לא נכון | Array[String] | הפונקציה מחזירה רשומות על סמך השלב שבו המשתמש נמצא במחזור החיים של הצ'אט. ערכים אפשריים: queued, assigned, finished, canceled, failed, no_response |
| verified[] | לא נכון | בוליאני | הפונקציה מחזירה רשומות שאומתו (True) או שלא אומתו (False) |
| chat_fail_reason[] | לא נכון | Array[String] | רשומות של החזרים על סמך הסיבה לכך ששיחה נכשלה. ערכים אפשריים: nothing, unknown, no_response, expired |
הערך של service_level_event יכול להיות אחד מהערכים הבאים.
| אירוע ברמת השירות | תיאור |
|---|---|
| in_sla | השיחה נענתה במסגרת הסכם רמת השירות |
| not_in_sla | השיחה לא נענתה במסגרת הסכם רמת השירות (SLA) שהוגדר |
| לא כלול | השיחה לא נכללה בחישוב של הסכם רמת השירות (לדוגמה, אם השיחה ננטשה) |
נקודת קצה (endpoint):
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/chats
דוגמאות נוספות לבקשות ולתשובות:
בקשה לדוגמה: צ'אטים
שאילתה:
| מפתח | ערך | תיאור |
|---|---|---|
| updated_at[from] | \{updated_at\[from\]\} | השעה בשעון UTC. יוצרת גבול תחתון לשדה 'עודכן בתאריך'. כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן. |
| updated_at[to] | \{updated_at\[to\]\} | השעה בשעון UTC. יוצרת גבול עליון לשדה updated at. כל הרשומות שיוחזרו יהיו לפני הערך שהוזן. |
Body: None
דוגמה לתגובה: צ'אטים
[
{
"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