查询通话报告列表
查询不同对象的呼叫统计数据,如分机、中继、队列、响铃组等。
请求 URL
GET {base_url}/{api_path}/call_report/list?access_token={access_token}
请求参数
参数 | 适用范围 | 是否必填 | 类型 | 说明 |
---|---|---|---|---|
type | 此参数适用于查询所有类型的通话报告。 | 是 | String | 通话报告类型。 取值范围:
|
start_time | 此参数仅适用于查询以下类型的通话报告:
|
否 | String | 指定起始时间以筛选报告 注: 填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX
上的 中设置)。
示例:
|
end_time | 此参数仅适用于查询以下类型的通话报告:
|
否 | String | 指定结束时间以筛选报告。 注: 填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX
上的 中设置)。
示例:
|
time | 此参数仅适用于查询以下类型的通话报告:
|
是 | String |
指定时间范围以筛选报告。 注: 时间格式取决于 PBX 的日期显示格式。
例如:PBX 的
日期显示格式 为
年/月/日,则此参数的有效时间填写格式为
时间格式:
|
ext_id_list | 此参数仅适用于查询以下类型的通话报告:
|
此参数在查询以下类型的通话报告时必填:
|
String | 要查询的分机/分机组的唯一 ID。 注:
|
trunk_id | 此参数仅适用于查询 DID /去电号码活动报告。 | 是 | String | 单个中继的唯一 ID。 注: 可使用 获取菜单选项 接口查询中继 ID。 |
trunk_id_list | 此参数仅适用于查询以下类型的通话报告:
|
是 | String | 中继的唯一 ID。 注:
|
ivr_id_list | 此参数仅适用于查询 IVR 报告。 | 是 | String | IVR 的唯一 ID。 注:
|
ring_group_id_list | 此参数仅适用于查询 响铃组统计报告。 | 是 | String | 响铃组的唯一 ID。 注:
|
queue_id | 此参数仅适用于查询以下类型的通话报告:
|
是 | String | 单个队列的唯一 ID。 注: 可使用 获取菜单选项 接口查询队列的
ID。 |
queue_id_list | 此参数仅适用于查询以下类型的通话报告:
|
是 | String | 队列的唯一 ID。 注:
|
agent_id_list | 此参数仅适用于查询以下类型的通话报告:
|
否 | String | 队列坐席的唯一 ID。 注:
|
abandon_time | 此参数仅适用于查询以下类型的通话报告:
|
否 | String | 设置一个时间。在指定时间内放弃的电话将不计入报告。(单位:秒) |
talk_time | 此参数仅适用于查询 队列业绩报告。 | 否 | Integer | 设置一个时间。通话时间少于此指定时间的通话将不计入报告。(单位:秒) |
include_internal | 此参数仅适用于查询 PBX 通话活动报告。 | 否 | Integer | 是否在报告中包含内部通话的数据。 取值范围:
|
callback_result | 此参数仅适用于查询 队列回拨报告。 | 否 | String | 队列回拨结果。 取值范围:
|
reason | 此参数仅适用于查询 坐席暂停报告。 | 否 | String | 坐席切换为暂停状态的原因。 取值范围:在 PBX 管理网页上设置的暂停原因 (路径: )。 |
communication_type | 此参数仅适用于查询以下类型的通话报告:
|
否 | String | 通讯类型。 注: 如果不传递此参数,则会查询并返回所有通讯类型的记录。 分机相关报告取值范围:
中继相关报告取值范围:
|
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | Integer | 返回错误码。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
|
errmsg | String | 返回信息。
|
total_number | Integer | 报告总数。 |
is_12hour | Integer | 时间格式是否为 12 小时制。
|
ext_call_statistics_list | Array<ext_call_statistics_list> | 分机通话统计报告列表。 |
ext_call_activity_list | Array<ext_call_activity_list> | 分机通话活动报告列表 |
trunk_activity_list | Array<trunk_activity_list> | PBX 通话活动报告列表。 |
trunk_did_dod_activity_list | Array<trunk_did_dod_activity_list> | DID /去电号码活动报告列表 |
ivr_list | Array<ivr_list> | IVR 报告列表。 |
queue_avg_wait_talk_time_list | Array<queue_avg_wait_talk_time_list> | 队列平均等待和通话时间报告列表。 |
queue_performance_list | Array<queue_performance_list> | 队列业绩报告列表。 |
queue_performance_activity_list | Array<queue_performance_activity_list> | 队列业绩活动报告列表。 |
queue_callbacks_summary_list | Array<queue_callbacks_summary_list> | 队列回拨摘要报告列表。 |
queue_callbacks_activity_list | Array<queue_callbacks_activity_list> | 队列回拨报告列表。 |
queue_satisfaction | Array<queue_satisfaction> | 满意度报告列表。 |
queue_satisfaction_detail_list | Array<queue_satisfaction_detail_list> | 满意度调查详情报告列表。 |
queue_agent_login_time_list | Array<queue_agent_login_time_list> | 坐席签入报告列表。 |
queue_agent_pause_time_list | Array<queue_agent_pause_time_list> | 坐席暂停报告列表。 |
queue_agent_miss_calls_list | Array<queue_agent_miss_calls_list> | 坐席未接通报告列表。 |
queue_agent_performance_list | Array<queue_agent_performance_list> | 坐席业绩报告列表。 |
queue_agent_in_out_calls_list | Array<queue_agent_in_out_calls_list> | 坐席呼叫摘要报告列表。 |
ring_group_statistics_list | Array<ring_group_statistics_list> | 响铃组统计报告列表。 |
ext_call_billing_list | Array<ext_call_billing_list> | 分机通话计费报告列表。 |
ext_call_billing_details_list | Array<ext_call_billing_details_list> | 分机通话计费详情报告列表。 |
callback_result | String | 队列回拨结果。 |
- ext_call_statistics_list
-
表 3. 参数 类型 说明 ext_num String 分机号码。 ext_name String 分机名称。 answered_calls Integer 分机应答的来电总数。 no_answer_calls Integer 分机未接的来电总数。 busy_calls Integer 分机忙时的来电总数。 failed_calls Integer 分机呼叫失败的去电总数。 voicemail_calls Integer 分机收到的语音留言总数。 total_holding_time Integer 分机接到来电到来电被应答的总时间。 total_talking_time Integer 来电被应答到通话结束的总时间。 - ext_call_activity_list
-
表 4. 参数 类型 说明 time Integer 报告的时间。 - 如果按小时查询报告,
time
返回值为一天中的第几个小时。例如,报告时间为 10:00-10:59,则
time
显示为10
。 - 如果按天查询报告,
time
返回值为一个月中的第几天。例如,报告时间为 4月13日,则
time
显示为13
。 - 如果按月查询报告,
time
返回值为一年中的第几个月。例如,报告时间为 四月,则
time
显示为4
。
answered_calls Integer 分机应答的来电总数。 no_answer_calls Integer 分机未接的来电总数。 busy_calls Integer 分机忙时的来电总数。 failed_calls Integer 分机呼叫失败的去电总数。 voicemail_calls Integer 分机收到的语音留言总数。 total_holding_time Integer 分机接到来电到来电被应答的总时间。 total_talking_time Integer 来电被应答到通话结束的总时间。 - 如果按小时查询报告,
- trunk_activity_list
-
表 5. 参数 类型 说明 time Integer 报告的时间。 - 如果按小时查询报告,
time
返回值为一天中的第几个小时。例如,报告时间为 10:00-10:59,则
time
显示为10
。 - 如果按天查询报告,
time
返回值为一个月中的第几天。例如,报告时间为 4月13日,则
time
显示为13
。 - 如果按月查询报告,
time
返回值为一年中的第几个月。例如,报告时间为 四月,则
time
显示为4
。
trunk_list Array<call_statistics> PBX 通话活动数据。 - 如果按小时查询报告,
- trunk_did_dod_activity_list
-
表 7. 参数 类型 说明 time Integer 报告的时间。 - 如果按小时查询报告,
time
返回值为一天中的第几个小时。例如,报告时间为 10:00-10:59,则
time
显示为10
。 - 如果按天查询报告,
time
返回值为一个月中的第几天。例如,报告时间为 4月13日,则
time
显示为13
。 - 如果按月查询报告,
time
返回值为一年中的第几个月。例如,报告时间为 四月,则
time
显示为4
。
did_dod_list Array<did_dod_list> 中继 DID /去电号码活动信息。 - 如果按小时查询报告,
- ivr_list
-
参数 类型 说明 detail Array<ivr_call_detail> IVR 通话详情列表。 ivr_name String IVR 名称。 ivr_num String IVR 号码。 press_count Object IVR 中的按键事件和对应的次数。 此参数以
"press_keypress_event":count
的形式返回按键事件信息。例如:- "press_0": 2
- "press_invalid": 1
- "press_timeout": 1
- queue_avg_wait_talk_time_list
-
表 9. 参数 类型 说明 time Integer 报告的时间。 - 如果按小时查询报告,
time
返回值为一天中的第几个小时。例如,报告时间为 10:00-10:59,则
time
显示为10
。 - 如果按天查询报告,
time
返回值为一个月中的第几天。例如,报告时间为 4月13日,则
time
显示为13
。 - 如果按月查询报告,
time
返回值为一年中的第几个月。例如,报告时间为 四月,则
time
显示为4
。
avg_wait_time Integer 已应答队列来电在被坐席接听前的平均等待时间。 avg_talk_time Integer 坐席与呼叫者通话的平均时间。 all_call_avg_wait_time Integer 所有队列来电 (包括已接来电和未接来电) 在队列中排队等待的平均时间。 answered_calls Integer 坐席接听的来电数量。 total_calls Integer 队列接收的来电总数。 answered_waiting_time Integer 已接来电的总等待时长。 total_waiting_time Integer 所有队列来电的总等待时长。 total_talking_time Integer 所有队列已接来电的总通话时长。 - 如果按小时查询报告,
- queue_performance_list
-
表 10. 参数 类型 说明 queue String 队列名称。 total_calls Integer 队列接收的来电总数。 answered_calls Integer 队列应答的来电总数。 missed_calls Integer 队列未接的来电总数。 abandoned_calls Integer 呼叫者在坐席应答前主动放弃的呼叫总数。 average_waiting_time Integer 已应答来电在被坐席接听前的平均等待时间。 average_talking_time Integer 坐席与呼叫者通话的平均时间。 max_waiting_time Integer 坐席应答前呼叫者在队列中等待的最长时间。 answered_rate number 已应答来电数占来电总数的百分比。 missed_rate number 未接来电数占来电总数的百分比。 abandoned_rate number 已放弃来电数占来电总数的百分比。 sla number 队列在一段时间周期内的服务水平。SLA 表示在规定时间内应答来电数占来电总数的百分比。 average_handle_time Integer 坐席处理已应答来电的平均时间。 注: 此参数的值由 “已应答来电中从来电开始响铃坐席到通话结束之间的总时长” 除以 “已应答来电的总数” 进行计算。all_call_average_waiting_time Integer 所有队列来电 (包括已接来电和未接来电) 在队列中排队等待的平均时间。 detail Array<queue_call_detail> 队列通话详情列表。 answered_call_time Integer 已应答来电的通话总时长。 total_ring_time Integer 所有来电的响铃总时长。 answered_hold_time Integer 已应答来电中坐席保持通话的总时长。 queue_num String 队列号码。
- queue_performance_activity_list
-
参数 类型 说明 id Integer 返回记录的编号。 time Integer 报告的时间。 - 如果按小时查询报告,
time
返回值为一天中的第几个小时。例如,报告时间为 10:00-10:59,则
time
显示为10
。 - 如果按天查询报告,
time
返回值为一个月中的第几天。例如,报告时间为 4月13日,则
time
显示为13
。 - 如果按月查询报告,
time
返回值为一年中的第几个月。例如,报告时间为 四月,则
time
显示为4
。
total_calls Integer 查询时间内的来电总数量。 answered_calls Integer 队列应答的来电总数。 missed_calls Integer 队列未接的来电总数。 abandoned_calls Integer 呼叫者在坐席应答前主动放弃的呼叫总数。 average_waiting_time Integer 已应答来电在被坐席接听前的平均等待时间。 max_waiting_time Integer 坐席应答前呼叫者在队列中等待的最长时间。 answered_rate number 已应答来电数占来电总数的百分比。 missed_rate number 未接来电数占来电总数的百分比。 abandoned_rate number 已放弃来电数占来电总数的百分比。 sla number 队列在一段时间周期内的服务水平。SLA 表示在规定时间内应答来电数占来电总数的百分比。 sla_calls Integer 在小于 SLA 时间内接听的来电数量。 total_waiting_time Integer 所有队列来电的总等待时长。 average_handle_time Integer 坐席处理已应答来电的平均时间。 注: 此参数的值由 “已应答来电中从来电开始响铃坐席到通话结束之间的总时长” 除以 “已应答来电的总数” 进行计算。all_call_average_waiting_time Integer 所有队列来电 (包括已接来电和未接来电) 在队列中排队等待的平均时间。 average_talking_time Integer 坐席与呼叫者通话的平均时间。 average_hold_time Integer 已应答来电中坐席保持通话的平均时长。 detail Array<queue_call_detail> 队列来电详情列表。 answered_waiting_time Integer 已接来电的总等待时长。 answered_call_time Integer 已应答来电的通话总时长。 answered_hold_time Integer 已应答来电中坐席保持通话的总时长。 total_talk_time Integer 来电被应答到通话结束的总时长。 - 如果按小时查询报告,
- queue_callbacks_summary_list
-
表 11. 参数 类型 说明 id Integer 返回记录的编号。 queue String 队列号码。 failed_callback Integer 队列回拨失败的总数。 succ_callback Integer 队列成功回拨的总数。 request_callback Integer 呼叫者成功请求队列回拨的总数。 total_received Integer 队列接收的来电总数。
- queue_callbacks_activity_list
-
表 12. 参数 类型 说明 id Integer 返回记录的编号。 time String 呼叫者呼入队列的时间。 call_from String 呼叫者的来电号码。 callback_time String 系统执行回拨的时间。 call_back_number String 呼叫者登记的回拨号码。 waiting_time Integer 呼叫者发起呼叫到接听回拨的时间。 callback_result String 回拨结果。 failed_reason String 回拨失败的原因。
- queue_satisfaction
-
表 13. 参数 类型 说明 queue_name String 队列名称。 queue_num String 队列号码。 satisfaction_list Array<satisfaction_list> 满意度详情。 agent_list Array<agent_list> 队列中的坐席列表。
- queue_satisfaction_detail_list
-
参数 类型 说明 id Integer 返回记录的编号。 agent_num String 坐席号码。 agent_name String 坐席名称。 time String 接收到该通来电的时间。 call_from String 主叫的号码和名称。 key String 呼叫者按下的按键。 point Integer 按键对应的分值。
- queue_agent_login_time_list
-
表 16. 参数 类型 说明 agent_name String 坐席名称。 agent_number String 坐席号码。 login String 坐席签入到队列的日期和时间。 logout String 坐席从队列中签出的日期和时间。 total_login_time Integer 从签入到签出之间经过的时间。 单位:秒
- queue_agent_pause_time_list
-
表 17. 参数 类型 说明 agent_name String 坐席名称。 agent_number String 坐席号码。 pause String 坐席暂停接收队列来电的日期和时间。 unpause String 坐席恢复接收队列来电的日期和时间。 total_pause_time Integer 从暂停到恢复接收队列来电之间经过的时间。 单位:秒
total_pause Integer 坐席暂停接收队列来电的总次数,更改暂停原因不计数。 - queue_agent_miss_calls_list
-
表 18. 参数 类型 说明 agent_name String 坐席名称。 agent_num String 坐席号码。 time String 呼叫者呼入到队列的日期和时间。 total_wait_time Integer 呼叫者在队列中等待的时间。 单位:秒
src_name String 来电者的显示名称。 src_num String 来电者的显示号码。 queue_status String 未接来电的最终状态,指示未接来电最终是否由队列中的其他坐席应答。 polling_attempts Integer 尝试呼叫该坐席的次数。 calls Integer 未接来电数量,表示这是一通未接来电,值固定为 1。 - queue_agent_performance_list
-
参数 类型 说明 queue String 队列名称。 total_calls Integer 队列接收的来电总数。 answered_calls Integer 队列应答的来电总数。 missed_calls Integer 队列未接的来电总数。 abandoned_calls Integer 呼叫者在坐席应答前主动放弃的呼叫总数。 average_waiting_time Integer 已应答来电在被坐席接听前的平均等待时间。 average_talking_time Integer 坐席与呼叫者通话的平均时间。 max_waiting_time Integer 坐席应答前呼叫者在队列中等待的最长时间。 answered_rate number 已应答来电数占来电总数的百分比。 missed_rate number 未接来电数占来电总数的百分比。 abandoned_rate number 已放弃来电数占来电总数的百分比。 sla number 队列在一段时间周期内的服务水平。SLA 表示在规定时间内应答来电数占来电总数的百分比。 answered_waiting_time Integer 已接来电的总等待时长。 total_talking_time Integer 所有队列已接来电的总通话时长。 average_handle_time Integer 坐席处理已应答来电的平均时间。 注: 此参数的值由 “已应答来电中从来电开始响铃坐席到通话结束之间的总时长” 除以 “已应答来电的总数” 进行计算。all_call_average_waiting_time Integer 所有队列来电 (包括已接来电和未接来电) 在队列中排队等待的平均时间。 answered_hold_time Integer 已应答来电中坐席保持通话的总时长。 answered_call_time Integer 已应答来电的通话总时长。 total_waiting_time Integer 所有队列来电的总等待时长。 answered_hold_time Integer 已应答来电中坐席保持通话的总时长。 detail Array<agent_performance_detail> 坐席业绩详情列表。 queue_num String 队列号码。 - queue_agent_in_out_calls_list
-
表 19. 参数 类型 说明 agent_name String 坐席名称。 agent_num String 坐席号码。 inbound_calls Integer 坐席应答的来电数量。 inbound_duration Integer 坐席应答的来电通话时长。 outbound_calls Integer 坐席呼出的去电数量。 outbound_duration Integer 坐席的呼出通话时长。 total_calls Integer 坐席处理的来电通话和去电通话的总数。 total_duration Integer 坐席呼入和呼出通话所用时间的总和。 average_talk_duration Integer 呼叫者与坐席通话的平均一通通话的时间。 average_handle_duration Integer 坐席处理已应答来电的平均时间。 注: 此参数的值由 “已应答来电中从来电开始响铃坐席到通话结束之间的总时长” 除以 “已应答来电的总数” 进行计算。average_waiting_duration Integer 已应答来电在被坐席接听前的平均等待时间。 average_hold_duration Integer 来电在队列中排队等待空闲坐席接听的平均时间。
- ring_group_statistics_list
-
表 20. 参数 类型 说明 group_name String 响铃组名称。 group_num String 响铃组号码。 answered_calls Integer 应答的来电总数。 total_calls Integer 接收的来电总数。 member_list Array<member_list> 响铃组成员统计。 - ext_call_billing_list
-
表 22. 参数 类型 说明 id Integer 返回记录的编号。 extension String 呼叫者的分机号码和分机名称。 total_call Integer 适用此费率规则的外线去电的总数。 total_talk_duration Integer 通话被应答到通话结束的总时间。 average_talk_duration Integer 通话被应答到通话结束的平均时间。 amount number 通话费用。 - ext_call_billing_details_list
-
表 23. 参数 类型 说明 id Integer 返回记录的编号。 extension String 呼叫者的分机号码和分机名称。 time String 发起外线呼叫的时间。 call_to String 被叫号码。 talk_duration Integer 来电被应答到通话结束的总时间。 amount number 通话费用。
示例
请求示例
查询分机组 (ID:"34") 中所有分机在 2022/04/01 12:00:00 AM-2022/04/15 11:59:59 PM 期间的来电通话统计数据。
GET /openapi/v1.0/call_report/list?type=extcallstatistics&start_time=2022/04/01 12:00:00 AM&end_time=2022/04/15 11:59:59 PM&ext_id_list=34&access_token=yzp2Ty69tJTZxKtoYWMZOyvmrcbDKm5S&communication_type=Inbound HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com
响应示例
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"total_number": 2,
"ext_call_statistics_list": [
{
"ext_num": "2002",
"ext_name": "Terrell Smith",
"answered_calls": 40,
"no_answer_calls": 10,
"busy_calls": 3,
"failed_calls": 0,
"voicemail_calls": 7,
"total_holding_time": 472,
"total_talking_time": 588
},
{
"ext_num": "2005",
"ext_name": "Kristin Hale",
"answered_calls": 16,
"no_answer_calls": 0,
"busy_calls": 0,
"failed_calls": 0,
"voicemail_calls": 0,
"total_holding_time": 111,
"total_talking_time": 141
}
]
}