下载通话报告

下载特定的通话报告。

下载步骤

  1. 获取通话报告的下载链接
  2. 下载通话报告

请求 URL

GET {base_url}/{api_path}/call_report/download?access_token={access_token}
注： 为提升系统性能，Yeastar 在 84.21.0.117 版本中对通话记录模块进行了升级，采用全新的数据结构，以提供更清晰的展示和更完整的通话信息。系统会根据 通话记录自动清理 规则逐步清理历史通话记录及相关报告数据。

在历史报告数据清理完成前，新旧数据分开管理 - 新生成的通话报告数据通过 openapi/v2.0 获取，历史数据通过 openapi/v1.0 获取。请根据要获取的数据使用正确的 API 路径。

请求参数

参数 适用范围 是否必填 类型 说明
type 此参数适用于查询默认报告。 是 String 通话报告类型。
取值范围：
  • extcallstatistics：分机通话统计报告
  • extcallactivity：分机通话活动报告
  • trunkactivity：PBX 通话活动报告
  • trunkdiddodactivity：DID /去电号码活动报告
  • ivr：IVR 报告
  • aisttusage：转录使用量详情报告
  • aireceptionistcallactivity：AI 接待员通话活动报告
    注： 此报告仅可通过 API 2.0 接口查询。
  • unreturnmisscall：未回电报告
  • queueavgwaittalktime：队列平均等待和通话时间报告
  • queueperformance：队列业绩报告
  • queueperformanceactivity：队列业绩活动报告
  • queuecallbackssummary：队列回拨摘要报告
  • queuecallbacksactivity：队列回拨报告
  • queuesatisfaction：满意度报告
  • queuesatisfactiondetail：满意度调查详情报告
  • queueagentlogintime：坐席签入报告
  • queueagentpausetime：坐席暂停报告
  • queueagentmisscalls：坐席未接通报告
  • queueagentperformance：坐席业绩报告
  • queueagentinoutcalls：坐席呼叫摘要报告
  • ringgroupstatistics：响铃组统计报告
  • extcallbilling：分机通话计费报告
  • extcallbillingdetails：分机通话计费详情报告
my_report_id

此参数适用于查询用户创建的报告。

 是 Integer 用户自建报告的 ID。
注： 可使用 查询我的报告列表 接口查询报告 ID。
start_time 此参数仅适用于查询以下类型的通话报告：
  • 分机通话统计报告
  • IVR 报告
  • 转录使用量详情
  • 未回电报告
  • 队列业绩报告
  • 队列回拨摘要报告
  • 队列回拨报告
  • 满意度报告
  • 满意度调查详情报告
  • 坐席签入报告
  • 坐席暂停报告
  • 坐席未接通报告
  • 坐席业绩报告
  • 坐席呼叫摘要报告
  • 响铃组统计报告
  • 分机通话计费报告
  • 分机通话计费详情报告
  • 呼入队列活动分析
  • 呼入队列记录
  • 坐席的呼入队列记录
  • 坐席活动分析
 否 String 指定起始时间以筛选报告。
注： 填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX 上的 系统 > 日期和时间 > 显示格式 中设置)。
示例：
  • PBX 的 日期显示格式 为 月/日/年，时间显示格式 为 24 小时制，则此参数的有效时间填写格式为 MM/DD/YYYY HH:mm:ss。
  • PBX 的 日期显示格式 为 年/月/日，时间显示格式 为 12 小时制，则此参数的有效时间填写格式为 YYYY/MM/DD HH:mm:ss AM/PM。
end_time 此参数仅适用于查询以下类型的通话报告：
  • 分机通话统计报告
  • IVR 报告
  • 转录使用量详情
  • 未回电报告
  • 队列业绩报告
  • 队列回拨摘要报告
  • 队列回拨报告
  • 满意度报告
  • 满意度调查详情报告
  • 坐席签入报告
  • 坐席暂停报告
  • 坐席未接通报告
  • 坐席业绩报告
  • 坐席呼叫摘要报告
  • 响铃组统计报告
  • 分机通话计费报告
  • 分机通话计费详情报告
  • 呼入队列活动分析
  • 呼入队列记录
  • 坐席的呼入队列记录
  • 坐席活动分析
 否 String 指定结束时间以筛选报告。
注： 填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX 上的 系统 > 日期和时间 > 显示格式 中设置)。
示例：
  • PBX 的 日期显示格式 为 月/日/年，时间显示格式 为 24 小时制，则此参数的有效时间填写格式为 MM/DD/YYYY HH:mm:ss。
  • PBX 的 日期显示格式 为 年/月/日，时间显示格式 为 12 小时制，则此参数的有效时间填写格式为 YYYY/MM/DD HH:mm:ss AM/PM。
time 此参数仅适用于查询以下类型的通话报告：
  • 分机通话活动报告
  • PBX 通话活动报告
  • DID/去电号码活动报告
  • AI接待员通话活动
  • 队列平均等待和通话时间报告
  • 队列业绩活动报告
  • 呼入队列活动分析
  • 坐席活动分析
 是 String

指定时间范围以筛选报告。

注： 时间格式取决于 PBX 的日期显示格式。

例如：PBX 的 日期显示格式 为 年/月/日，则此参数的有效时间填写格式为 YYYY/MM/DD。

时间格式：
  • 要按小时查询报告，输入格式为 YYYY/MM/DD。
  • 要按天查询报告，输入格式为 YYYY/MM。
  • 要按月查询报告，输入格式为 YYYY。
ring_duration_range 此参数仅适用于查询 呼入队列活动分析 报告。 此参数仅适用于查询 呼入队列活动分析 报告。 String

指定呼叫者在接通坐席前的等待时长统计区间。

取值范围：

  • per_30s：每 30 秒
  • per_60s：每 60 秒
  • per_5m：每 5 分钟
  • per_10m：每 10 分钟
ext_id_list 此参数仅适用于查询以下类型的通话报告：
  • 分机通话统计报告
  • 分机通话活动报告
  • 分机通话计费报告
  • 分机通话计费详情报告
 此参数在查询以下类型的通话报告时必填：
  • 分机通话统计报告
  • 分机通话活动报告
 String 要查询的分机/分机组的唯一 ID。
注：
  • 可使用 获取菜单选项 接口查询所需的 ID。
  • 使用半角逗号 , 分隔多个 ID。
trunk_id 此参数仅适用于查询 DID /去电号码活动报告。 是 String 单个中继的唯一 ID。
注： 可使用 获取菜单选项 接口查询中继 ID。
trunk_id_list 此参数仅适用于查询以下类型的通话报告：
  • PBX 通话活动报告
  • 分机通话计费报告
  • 分机通话计费详情报告
 是 String 中继的唯一 ID。
注：
  • 可使用 获取菜单选项 接口查询中继的 ID。
  • 使用半角逗号 , 分隔多个 ID。
ivr_id_list 此参数仅适用于查询 IVR 报告。 是 String IVR 的唯一 ID。
注：
  • 可使用 获取菜单选项 接口查询 IVR 的 ID。
  • 使用半角逗号 , 分隔多个 ID。
ring_group_id_list 此参数仅适用于查询 响铃组统计报告。 是 String 响铃组的唯一 ID。
注：
  • 可使用 获取菜单选项 接口查询响铃组的 ID。
  • 使用半角逗号 , 分隔多个 ID。
queue_id 此参数仅适用于查询以下类型的通话报告：
  • 满意度报告
  • 满意度调查详情报告
  • 坐席签入报告
  • 坐席暂停报告
  • 坐席未接通报告
  • 坐席业绩报告
  • 坐席呼叫摘要报告
 是 String 单个队列的唯一 ID。
注： 可使用 获取菜单选项 接口查询队列的 ID。
queue_id_list 此参数仅适用于查询以下类型的通话报告：
  • 队列平均等待和通话时间报告
  • 队列业绩报告
  • 队列业绩活动报告
  • 队列回拨摘要报告
  • 队列回拨报告
  • 呼入队列活动分析
  • 呼入队列记录
  • 坐席的呼入队列记录
  • 坐席活动分析
 是 String 队列的唯一 ID。
注：
  • 可使用 获取菜单选项 接口查询队列的 ID。
  • 使用半角逗号 , 分隔多个 ID。
agent_id_list 此参数仅适用于查询以下类型的通话报告：
  • 满意度调查详情报告
  • 坐席签入报告
  • 坐席暂停报告
  • 坐席未接通报告
  • 坐席业绩报告
  • 坐席呼叫摘要报告
  • 坐席的呼入队列记录
  • 坐席活动分析
 否 String 队列坐席的唯一 ID。
注：
  • 可使用 获取菜单选项 接口查询坐席的 ID。
  • 使用半角逗号 , 分隔多个 ID。
abandon_time 此参数仅适用于查询以下类型的通话报告：
  • 未回电报告
  • 队列业绩报告
  • 队列业绩活动报告
  • 坐席未接通报告
  • 坐席业绩报告
  • 呼入队列活动分析
  • 坐席活动分析
 否 String 设置一个时间。在指定时间内放弃的电话将不计入报告。(单位：秒)
talk_time 此参数仅适用于查询以下类型的通话报告：
  • 队列业绩报告
  • 呼入队列活动分析
  • 呼入队列记录
  • 坐席活动分析
 否 Integer 设置一个时间。通话时间少于此指定时间的通话将不计入报告。(单位：秒)
include_internal 此参数仅适用于查询 PBX 通话活动报告。 否 Integer 是否在报告中包含内部通话的数据。
取值范围：
  • 0：排除内部通话的数据。
  • 1：包含内部通话的数据。
callback_result 此参数仅适用于查询 队列回拨报告。 否 String 队列回拨结果。

取值范围：

  • success：成功
  • fail：失败
reason 此参数仅适用于查询 坐席暂停报告。 否 String 坐席切换为暂停状态的原因。

取值范围：在 PBX 管理网页上设置的暂停原因 (路径：呼叫功能 > 队列 > 暂停原因)。
communication_type 此参数仅适用于查询以下类型的通话报告：
  • 分机通话统计报告
  • 分机通话活动报告
  • PBX 通话活动报告
  • DID /去电号码活动报告
  • 呼入队列记录
  • 坐席的呼入队列记录
 否 String 通讯类型。
注： 如果不传递此参数，则会查询并返回所有通讯类型的记录。
分机相关报告取值范围：
  • Inbound：呼入
  • Outbound：呼出
  • Internal：内部
中继相关报告取值范围：
  • Inbound：呼入
  • Outbound：呼出
call_from 此参数仅适用于查询以下类型的通话报告：
  • 未回电报告
  • 呼入队列记录
  • 坐席的呼入队列记录
 否 String 主叫号码。
call_to 此参数仅适用于查询 未回电报告。 否 String 被叫号码。
call_to_type 此参数仅适用于查询 未回电报告。 否 String 来电的目的地类型。
取值范围：
  • Extension：分机
  • Queue：队列
  • RingGroup：响铃组
miss_call_type 此参数仅适用于查询 未回电报告。 否 String

未接来电类型。

取值范围：
  • no_answer：被叫未应答
  • busy：被叫忙
  • abandoned：主叫主动放弃
unreturn_status 此参数仅适用于查询 未回电报告。 否 Integer 未接来电的回电状态。
取值范围：
  • 1：已回电。
  • 2：未回电。
ai_receptionist_id_list 此参数仅适用于查询 AI接待员通话活动 报告。 否 String AI 接待员的 ID。
注：
  • 可使用 获取菜单选项 接口查询 ID (menu=ai_receptionist)。
  • 使用半角逗号 , 分隔多个 ID。
status 此参数仅适用于查询以下类型的通话报告：
  • 呼入队列记录
  • 坐席的呼入队列记录
 否 String 队列通话状态。
取值范围：
  • ANSWERED：已接
  • NO ANSWER：未接
  • ABANDONED：放弃
agent_speed_to_answer 此参数仅适用于查询 呼入队列记录 报告。 否 String

坐席接听队列来电的响应时间。 (单位：秒)
talk_time_range 此参数仅适用于查询以下类型的通话报告：
  • 呼入队列记录
  • 坐席的呼入队列记录
 否 String 坐席与主叫之间的通话时间，包括保持时间。 (单位：秒)
pure_talk_time 此参数仅适用于查询以下类型的通话报告：
  • 呼入队列记录
  • 坐席的呼入队列记录
 否 String 坐席的通话时间，不包括保持时间。 (单位：秒)
hold_time 此参数仅适用于查询以下类型的通话报告：
  • 呼入队列记录
  • 坐席的呼入队列记录
 否 String 坐席保持队列通话的时间。 (单位：秒)
agent_last_status 此参数仅适用于查询 坐席的呼入队列记录 报告。 否 String 坐席的最后通话状态。
取值范围：
  • answered：已接。
  • abandoned：放弃。
  • busy：忙。
  • no_answer：未接。
process_result 此参数仅适用于查询 坐席的呼入队列记录 报告。 否 String 放弃或未接队列来电的处理状态。
取值范围：
  • unprocessed：未处理。
  • processing：处理中。
  • processed：已处理。
waiting_time_in_queue 此参数仅适用于查询 坐席的呼入队列记录 报告。 否 String

呼叫者在队列中等待坐席接听的时间。(单位：秒)
waiting_time_in_agent 此参数仅适用于查询 坐席的呼入队列记录 报告。 否 String 坐席接听队列来电的响应时间。 (单位：秒)
did_num_list 此参数仅适用于查询 DID/去电号码活动 报告。 否 String 呼叫者拨打的 DID 号码。
注： 使用半角逗号 , 分隔多个 DID 号码。
dod_num_list 此参数仅适用于查询 DID/去电号码活动 报告。 否 String 呼叫者拨打的 DOD 号码。
注： 使用半角逗号 , 分隔多个 DOD 号码。
pin_list 此参数仅适用于查询 分机通话统计 报告。 否 String 通过受限呼出路由发起外呼时使用的 PIN 码。
注： 使用半角逗号 , 分隔多个 PIN 码。
need_detail 此参数仅适用于查询以下类型的通话报告：
  • IVR 报告
  • 队列业绩报告
  • 队列业绩活动报告
  • 坐席业绩报告
  • 未回电报告
  • AI 接待员通话活动
 否 Integer 是否包含相关通话详情。
取值范围：
  • 0：排除通话详情。
  • 1：包含通话详情。
detail_type 此参数适用于查询所有报告。 否 String 通话详情的显示方式。
取值范围：
  • same_list：同个列表错行显示。
  • diff_list：分为多个表格/文件下载。
format 此参数适用于查询所有报告。 否 String 下载格式。
取值范围：
  • csv
  • xls
  • pdf
  • html
duration_format 此参数适用于查询所有报告。 否 String 时间相关字段的显示格式。

取值范围：

  • seconds：显示为秒
  • hhmmss：显示为时分秒 HH:MM:SS
is_async 此参数适用于查询所有类型的通话报告。 否 Integer

是否异步获取数据和通话报告的下载 URL。

取值范围：
  • 0：同步
  • 1：异步
    注： 当数据检索完成并生成下载 URL 时，PBX 会向第三方应用发送事件报告 30027。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注：
  • 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
  • 如果你选择异步检索数据，会返回错误码 2 和错误信息 PROCESSING。当数据检索完成并生成下载 URL 时，PBX 会向第三方应用发送事件报告 30027。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
file String 通话报告文件。
download_resource_url String 通话报告下载 URL。

示例

请求示例

获取 2025/12/01 00:00:00 - 2025/12/31 23:59:59 期间某 IVR 报告的下载 URL（IVR ID 为 “1”）。
重要：
  • 如果要通过日期和时间筛选通话报告，start_time 和 end_time 参数的填写格式必须遵循 PBX 的日期和时间显示格式，否则响应结果中不会返回任何记录。
  • 请根据要获取的数据使用正确的 API 路径。
    • 获取 84.21.0.117 或更高版本生成的通话报告数据，使用 openapi/v2.0。
    • 获取 84.21.0.66 或更低版本生成的通话报告数据，使用 openapi/v1.0。
GET openapi/v2.0/call_report/download?access_token=5qcixSatPqNQfjsepgFdUsQBID1ZWnu8&type=ivr&start_time=2025/12/01 00:00:00&end_time=2025/12/31 23:59:59&ivr_id_list=1&need_detail=1&is_async=0&detail_type=same_list&format=pdf&duration_format=seconds HTTP/1.1  

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "file": "QueueSatisfaction-X.7.0.7-download-20220608094753-ejP6Z6htIfhsCQbP.csv",
    "download_resource_url": "/api/download/QueueSatisfaction-x.7.0.7-download-20220608094753-ejP6Z6htIfhsCQbP.csv"
}

下载通话报告

在获取通话报告下载 URL 后，你需要将其与 {base_url} 结合，并添加 {access_token} 参数，然后使用此完整的下载链接获取通话报告。

下载链接格式

{base_url}/{download_resource_url}?access_token={access_token}

下载链接示例

https://yeastardocs.example.yeastarcloud.com/api/download/QueueSatisfaction-x.7.0.7-download-20220608094753-ejP6Z6htIfhsCQbP.csv?access_token=MB1OklPar5hnDfhi4srZa8FrZ4znFSzr