下载预约通话报告

下载特定的预约通话报告。

下载预约报告步骤

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

请求 URL

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

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

请求参数

参数 适用范围 是否必填 类型 说明
id 此参数适用于查询所有类型的通话报告 是 Integer 预约通话报告的唯一 ID。
注： 可使用 查询预约通话报告列表 接口查询预约通话报告的 ID。
need_detail 此参数仅适用于查询以下类型的通话报告：
  • IVR 报告
  • 队列业绩报告
  • 队列业绩活动报告
  • 坐席业绩报告
 否 Integer 是否包含相关通话详情。
取值范围：
  • 0：排除通话详情。
  • 1：包含通话详情。
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。

示例

重要： 请根据要获取的数据使用正确的 API 路径。
  • 获取 83.21.0.117 或更高版本生成的通话报告数据，使用 openapi/v2.0。
  • 获取 83.21.0.66 或更低版本生成的通话报告数据，使用 openapi/v1.0。

请求示例

GET /openapi/v1.0/call_schedule_report/download?id=5&access_token=FZCqUJucsaaUYikWHJA7sCEBjo0z8k5C HTTP/1.1
192.168.5.150:8088

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "file": "Support.csv",
    "download_resource_url": "/api/download/Support.csv"
}

下载预约通话报告

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

下载链接格式

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

下载链接示例

https://192.168.5.150:8088/api/download/Support.csv?access_token=WQMR0cuirhX264oZMa9pV03T9li924NS