下载通话记录文件 (v2.0)

下载特定分机或所有分机的通话记录。

注： 本文适用于 API 2.0 版本。

下载步骤

  1. 获取通话记录文件的下载链接
  2. 下载通话记录文件

请求 URL

GET {base_url}/{api_path}/cdr/download?access_token={access_token}

请求参数

注： 如需模糊搜索号码，可通过 编辑通话记录选项 (v2.0) 接口启用模糊搜索功能。
参数 是否必填 类型 说明
time_begin 否 String 设置用于筛选通话记录的起始时间。

如果使用日期时间格式，则填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX 上的 系统 > 日期和时间 > 显示格式 中设置)。

示例：

  • PBX 的 日期显示格式 为 月/日/年，时间显示格式 为 24 小时制，则此参数的有效时间填写格式为 MM/DD/YYYY HH:mm:ss。
  • PBX 的 日期显示格式 为 年/月/日，时间显示格式 为 12 小时制，则此参数的有效时间填写格式为 YYYY/MM/DD HH:mm:ss AM/PM。
time_end 否 String 设置用于筛选通话记录的结束时间。

如果使用日期时间格式，则填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX 上的 系统 > 日期和时间 > 显示格式 中设置)。

示例：

  • PBX 的 日期显示格式 为 月/日/年，时间显示格式 为 24 小时制，则此参数的有效时间填写格式为 MM/DD/YYYY HH:mm:ss。
  • PBX 的 日期显示格式 为 年/月/日，时间显示格式 为 12 小时制，则此参数的有效时间填写格式为 YYYY/MM/DD HH:mm:ss AM/PM。
call_from 否 String 主叫号码。
call_to 否 String 被叫号码。
account_code 否 String 通过受 PIN 码限制的呼出路由进行外呼时所使用的，并被记录在通话记录中的 PIN 码。
注：
ext_group 否 String 分机组的唯一 ID，用于查询分机组内成员的通话。
注：
  • 可使用 获取菜单选项 接口查询分机组 ID。
  • 使用半角逗号 , 分隔多个 ID。
disposition_code_list 否 String 话务标签的唯一 ID。
注：
  • 你可以使用 获取菜单选项 接口查询话务标签的 ID。
  • 使用半角逗号 , 分隔多个 ID。
call_note_remark 否 String 备注。
did 否 String 指定 DID 以筛选通话记录。

取值范围：{did_number}:{trunk_name} 或 {did_name}:{trunk_name}

注：
  • 可使用 搜索特定中继 接口查询中继名称。
  • 使用半角逗号 , 分隔多个 DID。
ai_receptionist_list 否 String AI 接待员的唯一 ID，用于查询指定 AI 接待员的通话。
注：
  • 可使用 获取菜单选项 接口查询 AI 接待员 ID。
  • 使用半角逗号 , 分隔多个 AI 接待员 ID。
ai_receptionist_status 否 String AI 接待员通话的处理结果。

取值范围：

  • resolved：AI 接待员成功解决了来电者的问题，未转接通话。
  • unresolved：AI 接待员将通话转接至其他目的地。
  • transfered：AI 接待员既未解决客户问题，也未转接通话。
  • noprocessingresult：通话因错误或超时异常结束，无法确定处理结果。
ai_transcription 否 String AI 转录内容。
注： 可先从 下载的 AI 通话转写数据 中的 leg_id 参数中获取通话阶段 ID，再通过 获取 AI 通话转写原文 或 获取 AI 通话总结 获取转录内容。
disconnected_by 否 String 挂断通话的对象。
  • Extension：内部分机
  • External：外部号码
  • System：其他方
    注： 当来电在最大等待时长内未被接听、通话因紧急号码抢占而被强制终止等情况时，挂断方记为 System。
dod_number 否 String 被叫话机上显示的号码。
handling_duration 否 String 通话被应答到通话结束的时间，包括保持时长。
注： 支持输入数字、-、=、<、<=、>、>= 或数字范围。
routing_duration 否 String 通话开始到通话被应答的时间。
注： 支持输入数字、-、=、<、<=、>、>= 或数字范围。
last_status 否 String 通话的最终状态。

取值范围：

  • ANSWERED：已接
  • NO ANSWER：未接
  • ABANDONED：放弃
  • BUSY：忙
  • FAILED：失败
  • VOICEMAIL：语音留言
last_participant 否 String 最后一个通话阶段的被叫。
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序
  • desc：降序
org_list 否 String 部门的唯一 ID，用于查询指定部门的通话。
注：
  • 可使用 搜索特定部门 接口查询部门 ID。
  • 使用半角逗号 , 分隔多个部门 ID。
queue_list 否 String 队列的唯一 ID，用于查询指定队列的通话记录。
注：
  • 可使用 搜索特定队列 接口查询队列 ID。
  • 使用半角逗号 , 分隔多个队列 ID。
recording_type 否 Integer 展示所有通话记录、带录音的通话记录、或不带录音的通话记录。

取值范围：

  • 0：全部通话记录
  • 1：带录音的通话记录
  • 2：不带录音的通话记录
second_participant 否 String 第二个通话阶段的被叫。
segments 否 String 通话阶段的数量。
sort_by 否 String 定义排序字段。

取值范围：

  • uid
  • time
  • call_type
  • last_status
  • call_duration
  • routing_duration
  • handling_duration
srcaddr 否 String 主叫设备的 IP 地址。
trunk 否 String 中继名称。
uid 否 String 通话记录的唯一 ID。
call_type 否 String 通讯类型。

取值范围：

  • Inbound：呼入
  • Outbound：呼出
  • Internal：内部

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
file String 通话记录文件。
download_resource_url String 通话记录下载 URL。
注： 下载链接 30 分钟内有效。

示例

请求示例

获取 2026/06/04 00:00:00 - 2026/06/04 23:59:59 期间的通话记录的下载链接。

重要： 如果要通过日期和时间筛选通话记录，time_begin 和 time_end 参数的填写格式必须遵循 PBX 的日期和时间显示格式，否则响应结果中不会返回任何记录。
GET /openapi/v2.0/cdr/download?time_begin=2026/06/04 00:00:00&time_end=2026/06/04 23:59:59&access_token=MDl5yGy9Bq2Jk2BB5ew8ycNk7dHnmhXF HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "file": "P550-Cdr-37.23.0.109-download-20260610193341-35U4OSyeWE6Gqtdg.pdf",
    "download_resource_url": "/api/download/PBX-Cdr-37.23.0.109-download-20260610193341-35U4OSyeWE6Gqtdg.pdf"
}

下载通话记录文件

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

下载链接格式

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

下载链接示例

https://yeastardocs.example.yeastarcloud.com/api/download/P550-Cdr-37.23.0.109-download-20260610193341-35U4OSyeWE6Gqtdg.pdf?access_token=5tQstKGzg0Lt4MGTETC1eDjlzk97IIny