查询通话报告详情
查询指定的 IVR、队列、坐席报告中的通话详情。
请求 URL
GET {base_url}/{api_path}/call_report/detail?access_token={access_token}
请求参数
参数 | 适用范围 | 是否必填 | 类型 | 说明 |
---|---|---|---|---|
type | 此参数适用于查询所有类型的通话报告。 | 是 | String | 通话报告类型。 取值范围:
|
start_time | 此参数仅适用于查询以下类型的通话报告:
|
是 | String | 指定起始时间以筛选报告。 注: 填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX
上的 中设置)。
示例:
|
end_time | 此参数仅适用于查询以下类型的通话报告:
|
是 | String | 指定结束时间以筛选报告。 注: 填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX
上的 中设置)。
示例:
|
detail_time_begin | 此参数仅适用于查询以下类型的通话报告:
|
是 | String | 指定起始时间以筛选通话详情。 注: 填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX
上的 中设置)。
示例:
|
detail_time_end | 此参数仅适用于查询以下类型的通话报告:
|
是 | String | 指定结束时间以筛选通话详情。 注: 填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX
上的 中设置)。
示例:
|
time | 此参数仅适用于查询 队列业绩活动报告。 | 是 | String |
指定时间范围以筛选报告。 注: 时间格式取决于 PBX 的日期显示格式。
例如:PBX 的
日期显示格式 为
年/月/日,则此参数的有效时间填写格式为
时间格式:
|
detail_time | 此参数仅适用于查询 队列业绩活动报告。 | 是 | String |
指定时间范围以筛选通话详情。 |
ivr_num | 此参数仅适用于查询 IVR 报告。 | 是 | String | IVR 号码。 |
queue_id_list | 此参数仅适用于查询以下类型的通话报告:
|
是 | String | 队列的唯一 ID。 注: 可使用 获取菜单选项 接口查询队列的
ID。 |
queue_id | 此参数仅适用于查询 坐席业绩报告。 | 是 | Integer | 队列的唯一 ID。 注: 可使用 获取菜单选项 接口查询队列的
ID。 |
queue_num | 此参数仅适用于查询以下类型的通话报告:
|
是 | String | 队列号码。 |
agent_num | 此参数仅适用于查询 坐席业绩报告。 | 是 | String | 坐席的分机号码。 |
abandon_time | 此参数仅适用于查询以下类型的通话报告:
|
否 | Integer | 设置一个时间。在指定时间内放弃的通话将不计入报告。(单位:秒) |
talk_time | 此参数仅适用于查询 队列业绩报告。 | 否 | Integer | 设置一个时间。通话时间少于此指定时间的通话将不计入报告。(单位:秒) |
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | Integer | 返回错误码。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
|
errmsg | String | 返回信息。
|
total_number | Integer | 通话详情记录的总数。 |
ivr_report_detail | Array<ivr_call_detail> | IVR 通话报告相关的通话详情。 |
queue_performance_detail | Array<queue_call_detail> | 队列业绩报告相关的通话详情。 |
queue_performance_activity_detail | Array<queue_call_detail> | 队列业绩活动报告相关的通话详情。 |
queue_agent_performance_detail | Array<agent_call_detail> | 坐席业绩报告相关的通话详情。 |
- ivr_call_detail
-
参数 类型 说明 id String 通话记录的唯一 ID。 time String 接收到该通来电的时间。 call_from String 主叫的号码和名称。 press String 通话中被按下的按键。 destination String 按键的目的地。 opr_duration Integer 主叫呼入到 IVR 到退出 IVR 的时间。 reason_partya ~ reason_partyf String 用于组成按键目的地 ( destination
) 信息的内容部分。call_to String 按键目的地 ( destination
) 的号码和名称。注: 如果按键目的地没有号码 (如按键目的地为播放提示音后退出、播放提示音后返回当前 IVR 等),则返回空值。timestamp Integer 接收到该通来电的时间的时间戳。 dst_num String 按键目的地 ( destination
) 的号码。注: 如果按键目的地没有号码 (如按键目的地为播放提示音后退出、播放提示音后返回当前 IVR 等),则返回空值。ivr_num String IVR 号码。
- queue_call_detail
-
参数 类型 说明 id String 通话记录的唯一 ID。 time String 接收到该通来电的时间。 call_from String 主叫的号码和名称。 queue_name String 队列名称。 agent_name String 坐席名称和坐席号码。 status String 来电状态。 abandond
:呼叫者放弃了此通话,在被接听前主动挂断。missed
:来电最终未被队列坐席接听。answered
:队列坐席已接听此来电。
ring_duration Integer 来电响铃到来电被应答的时长。 talk_duration Integer 来电被应答到通话结束的时长。 hold_duration Integer 通话保持的总时长。 reason String 通话未被接听的原因或通话结束的原因。 process_result String 被放弃来电或未接来电的处理结果。 unprocessed
:未处理。processed
:已处理。
polling_attempts Integer 尝试呼叫该坐席的次数。 process_ext String 处理被放弃来电或未接来电的坐席的分机号和名称。 process_time String 坐席更改被放弃来电或未接来电处理状态的时间。 reason_partya ~ reason_partyf String 用于组成通话结束原因 ( reason
) 信息的内容部分。call_to String 被叫的号码和名称。 timestamp Integer 接收到该通来电的时间的时间戳。 queue_num String 队列号码。 agent_num String 坐席号码。
- queue_call_detail
-
参数 类型 说明 id String 通话记录的唯一 ID。 time String 接收到该通来电的时间。 call_from String 主叫的号码和名称。 queue_name String 队列名称。 agent_name String 坐席名称和坐席号码。 status String 来电状态。 abandond
:呼叫者放弃了此通话,在被接听前主动挂断。missed
:来电最终未被队列坐席接听。answered
:队列坐席已接听此来电。
ring_duration Integer 来电响铃到来电被应答的时长。 talk_duration Integer 来电被应答到通话结束的时长。 hold_duration Integer 通话保持的总时长。 reason String 通话未被接听的原因或通话结束的原因。 process_result String 被放弃来电或未接来电的处理结果。 unprocessed
:未处理。processed
:已处理。
polling_attempts Integer 尝试呼叫该坐席的次数。 process_ext String 处理被放弃来电或未接来电的坐席的分机号和名称。 process_time String 坐席更改被放弃来电或未接来电处理状态的时间。 reason_partya ~ reason_partyf String 用于组成通话结束原因 ( reason
) 信息的内容部分。call_to String 被叫的号码和名称。 timestamp Integer 接收到该通来电的时间的时间戳。 queue_num String 队列号码。 agent_num String 坐席号码。
- agent_call_detail
-
参数 类型 说明 id String 通话记录的唯一 ID。 time String 接收到该通来电的时间。 call_from String 主叫的号码和名称。 queue_name String 队列名称。 agent_name String 坐席名称和坐席号码。 status String 来电状态。 abandond
:呼叫者放弃了此通话,在被接听前主动挂断。missed
:来电最终未被队列坐席接听。answered
:队列坐席已接听此来电。
ring_duration Integer 来电响铃到来电被应答的时长。 talk_duration Integer 来电被应答到通话结束的时长。 hold_duration Integer 通话保持的总时长。 reason String 通话未被接听的原因或通话结束的原因。 process_result String 被放弃来电或未接来电的处理结果。 unprocessed
:未处理。processed
:已处理。
polling_attempts Integer 尝试呼叫该坐席的次数。 process_ext String 处理被放弃来电或未接来电的坐席的分机号和名称。 process_time String 坐席更改被放弃来电或未接来电处理状态的时间。 reason_partya ~ reason_partyf String 用于组成通话结束原因 ( reason
) 信息的内容部分。disposition String 来电状态。 注: 此参数针对队列返回该来电的状态。answered
:队列中的坐席已应答此来电。no_answered
:队列中的坐席未应答此来电。
call_to String 被叫的号码和名称。 timestamp Integer 接收到该通来电的时间的时间戳。 queue_num String 队列号码。 agent_num String 坐席号码。
示例
请求示例
查询队列 (ID:"1") 中坐席 1002 在 2024/09/29 00:00:00 - 2024/09/29 23:59:59 期间的通话详情。
GET /openapi/v1.0/call_report/detail?access_token=synJ1EwaEXYvp7fipey7L4mq8E2hrPU8&type=queueagentperformance&start_time=2024/09/01 00:00:00&end_time=2024/09/30 23:59:59&detail_time_begin=2024/09/29 00:00:00&detail_time_end=2024/09/29 23:59:59&agent_num=1002&queue_id=1&abandon_time=5 HTTP/1.1
Host: 192.168.5.150:8088
响应示例
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"total_number": 2,
"queue_agent_performance_detail": [
{
"id": "202409291711030B6DF",
"time": "2024/09/29 17:11:02",
"call_from": "Anna Simmons<2000>",
"queue_name": "Support",
"agent_name": "NONE",
"status": "missed",
"ring_duration": 36,
"talk_duration": 0,
"hold_duration": 0,
"reason": "Anna Simmons<2000> caller_call_callee Terrell Smith<1002> ",
"process_result": "unprocessed",
"polling_attempts": 1,
"process_ext": "",
"process_time": "",
"reason_partya": "src",
"reason_partyb": "caller_call_callee",
"reason_partyc": "dst",
"reason_partyd": "",
"reason_partye": "",
"reason_partyf": "",
"disposition": "no_answered",
"call_to": "Terrell Smith<1002>",
"timestamp": 1727601062,
"queue_num": "6401",
"agent_num": "1002"
},
{
"id": "20240929170007A9523",
"time": "2024/09/29 17:00:06",
"call_from": "Carmen Gordon<2001>",
"queue_name": "Support",
"agent_name": "NONE",
"status": "answered",
"ring_duration": 12,
"talk_duration": 560,
"hold_duration": 0,
"reason": "Terrell Smith<1002> hangup ",
"process_result": "unprocessed",
"polling_attempts": 1,
"process_ext": "",
"process_time": "",
"reason_partya": "dst",
"reason_partyb": "hangup",
"reason_partyc": "",
"reason_partyd": "",
"reason_partye": "",
"reason_partyf": "",
"disposition": "answered",
"call_to": "Terrell Smith<1002>",
"timestamp": 1727600406,
"queue_num": "6401",
"agent_num": "1002"
}
]
}