下载通话记录文件

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

下载步骤

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

请求 URL

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

请求参数

注： 如需模糊搜索号码，可通过 编辑通话记录选项 接口启用模糊搜索功能。
参数 是否必填 类型 说明
start_time 否 String 设置开始时间以筛选通话记录。
注：
  • 时间可以使用 ISO 8601 日期时间字符串 或 以秒为单位的 Unix 时间戳 的格式传递。
  • 如果使用日期时间格式，则填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX 上的 系统 > 日期和时间 > 显示格式 中设置)。
    示例：
    • PBX 的 日期显示格式 为 月/日/年，时间显示格式 为 24 小时制，则此参数的有效时间填写格式为 MM/DD/YYYY HH:mm:ss。
    • PBX 的 日期显示格式 为 年/月/日，时间显示格式 为 12 小时制，则此参数的有效时间填写格式为 YYYY/MM/DD HH:mm:ss AM/PM。
end_time 否 String 设置结束时间以筛选通话记录。
注：
  • 时间可以使用 ISO 8601 日期时间字符串 或 以秒为单位的 Unix 时间戳 的格式传递。
  • 如果使用日期时间格式，则填写的时间格式取决于 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 被叫号码。
extension_group 否 Integer 分机组的唯一 ID，用于查询分机组内成员的通话。
注： 可使用 获取菜单选项 接口查询分机组 ID。
disposition_code_list 否 String 话务标签的唯一 ID。
注：
  • 你可以使用 获取菜单选项 接口查询话务标签的 ID。
  • 使用半角逗号 , 分隔多个 ID。
call_note_remark 否 String 备注。
status 否 String 通话状态。
取值范围：
  • ANSWERED：已接
  • NO ANSWER：未接
  • BUSY：忙
  • FAILED：失败
  • VOICEMAIL：语音留言
did 否 String 指定 DID 以筛选通话记录。

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

注：
  • 可使用 搜索特定中继 接口查询中继名称。
  • 使用半角逗号 , 分隔多个 DID。

响应参数

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

示例

请求示例

获取 05/19/2022 00:00:00-05/19/2022 23:59:59 期间的 CDR 的下载链接。

重要： 如果要通过日期和时间筛选 CDR，start_time 和 end_time 参数的填写格式必须遵循 PBX 的日期和时间显示格式，否则响应结果中不会返回任何记录。
GET /openapi/v1.0/cdr/download?access_token=5tQstKGzg0Lt4MGTETC1eDjlzk97IIny&start_time=05/19/2022 00:00:00&end_time=05/19/2022 23:59:59 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "file": "Cdr-X.7.0.16-download-20220520093856-xdhICiIeubqMAtvP.csv",
    "download_resource_url": "/api/download/Cdr-X.7.0.16-download-20220520093856-xdhICiIeubqMAtvP.csv"
}

下载通话记录文件

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

下载链接格式

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

下载链接示例

https://yeastardocs.example.yeastarcloud.com/api/download/Cdr-X.7.0.16-download-20220520093856-xdhICiIeubqMAtvP.csv?access_token=5tQstKGzg0Lt4MGTETC1eDjlzk97IIny