다음은 채팅 리소스의 모델입니다. 이 모델을 참고하여 개인 식별 정보가 포함될 수 있는 필드를 확인하세요.
[
{
"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 내에 통화가 응답되지 않음 |
| excluded | 통화가 SLA 계산에 포함되지 않음 (예: 통화가 중단된 경우) |
채팅
| 매개변수 | 필수 | 데이터 유형 | 정의 |
|---|---|---|---|
| sort_column | FALSE | 문자열 | 응답 객체의 모든 필드를 기준으로 응답을 정렬합니다. |
| sort_direction | FALSE | ASC 또는 DESC | 오름차순 또는 내림차순으로 정렬 방향을 기록합니다. |
| page | FALSE | 문자열 | 페이지당 레코드 수를 기록하기 위해 per와 쌍을 이룹니다. 예를 들어 per가 200이고 페이지가 2이면 응답에는 201~400번 레코드가 포함됩니다. 페이지 1에는 1~200번 레코드가 포함되기 때문입니다. |
| per | FALSE | 문자열 | 페이지당 포함될 레코드 수를 기록하기 위해 page와 쌍을 이룹니다. 예를 들어 per가 200이고 페이지가 2이면 응답에는 201~400번 레코드가 포함됩니다. 페이지 1에는 1~200번 레코드가 포함되기 때문입니다. |
| assigned_at[from] | FALSE | UTC 시간 | assigned at 필드의 하한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이후에 발생합니다. |
| assigned_at[to] | FALSE | UTC 시간 | assigned at 필드의 상한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이전에 발생합니다. |
| 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 필드의 하한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이후에 발생합니다. |
| rating[to] | FALSE | 숫자 1~5 또는 null | rating 필드의 상한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이전에 발생합니다. |
| first_msg_sent_at[from] | FALSE | UTC 시간 | first msg sent at 필드의 하한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이후에 발생합니다. |
| first_msg_sent_at[to] | FALSE | UTC 시간 | first msg sent at 필드의 상한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이전에 발생합니다. |
| last_msg_sent_at[from] | FALSE | UTC 시간 | last msg sent at 필드의 하한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이후에 발생합니다. |
| last_msg_sent_at[to] | FALSE | UTC 시간 | last msg sent at 필드의 상한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이전에 발생합니다. |
| chat_duration[from] | FALSE | 숫자 | chat duration 필드의 하한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이후에 발생합니다. |
| chat_duration[to] | FALSE | 숫자 | chat duration 필드의 상한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이전에 발생합니다. |
| message_count[from] | FALSE | 숫자 | message count 필드의 하한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이후에 발생합니다. |
| message_count[to] | FALSE | 숫자 | message count 필드의 상한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이전에 발생합니다. |
| average_response_time[from] | FALSE | 숫자 | average response time 필드의 하한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이후에 발생합니다. |
| average_response_time[to] | FALSE | 숫자 | average response time 필드의 상한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이전에 발생합니다. |
| longest_response_time[from] | FALSE | 숫자 | longest response time 필드의 하한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이후에 발생합니다. |
| longest_response_time[to] | FALSE | 숫자 | longest response time 필드의 상한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이전에 발생합니다. |
| wait_duration[from] | FALSE | 숫자 | wait duration 필드의 하한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이후에 발생합니다. |
| wait_duration[to] | FALSE | 숫자 | wait duration 필드의 상한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이전에 발생합니다. |
| id[] | FALSE | 배열[문자열] | 배열[문자열]. 검색하고 반환할 레코드의 ID |
| agent_id[] | FALSE | 배열[문자열] | 상담사 ID로 응답을 필터링합니다. |
| end_user_id[] | FALSE | 배열[문자열] | 최종 사용자 ID를 기준으로 응답을 필터링합니다. |
| chat_type[] | FALSE | 배열[문자열] | 최종 사용자가 채팅에 액세스한 방식을 기준으로 레코드를 반환합니다. 가능한 값: Messaging Inbound (앱 채팅), Messaging Inbound (웹 채팅), Messaging (SMS) |
| chat_status[] | FALSE | 배열[문자열] | 사용자가 채팅 수명 주기의 어느 단계에 있는지에 따라 레코드를 반환합니다. 가능한 값: queued, assigned, finished, canceled, failed, no_response |
| verified[] | FALSE | 불리언 | 인증된 레코드 (True) 또는 인증되지 않은 레코드 (False)를 반환합니다. |
| chat_fail_reason[] | FALSE | 배열[문자열] | 채팅이 실패한 이유를 기준으로 레코드를 반환합니다. 가능한 값: nothing, unknown, no_response, expired |
service_level_event 값은 다음 값을 가질 수 있습니다.
| 서비스 수준 이벤트 | 설명 |
|---|---|
| in_sla | SLA 내에 통화가 응답됨 |
| not_in_sla | 정의된 SLA 내에 통화가 응답되지 않음 |
| excluded | 통화가 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