下载通话记录文件

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

下载步骤

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

请求 URL

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

请求参数

表 1.
参数 是否必填 类型 说明
start_time 否 String 设置开始时间以筛选通话记录。
注： 填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX 上的 系统 > 日期和时间 > 显示格式 中设置)。
示例：
  • PBX 的 日期显示格式 为 月/日/年，时间显示格式 为 24 小时制，则此参数的有效时间填写格式为 MM/DD/YYYY HH:mm:ss。
  • PBX 的 日期显示格式 为 年/月/日，时间显示格式 为 12 小时制，则此参数的有效时间填写格式为 YYYY/MM/DD HH:mm:ss AM/PM。
end_time 否 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 被叫号码。
extension_group 否 Integer 分机组的唯一 ID，用于查询分机组内成员的通话。
注： 可使用 获取菜单选项 接口查询分机组 ID。
status 否 String 通话状态。
取值范围：
  • ANSWERED：已接
  • NO ANSWER：未接
  • BUSY：忙
  • FAILED：失败
  • VOICEMAIL：语音留言
enable_fuzzy_search 否 String 是否模糊查询号码。
取值范围：
  • 0：禁用
  • 1：启用

响应参数

表 2.
参数 类型 说明
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
192.168.5.150:8088

响应示例

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 后，你需要将下载 URL 与 {base_url} 整合，组成一个下载请求 URL，并发送请求下载通话记录文件。

下载链接格式

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

下载链接示例

GET https://192.168.5.150:8088/api/download/Cdr-X.7.0.16-download-20220520093856-xdhICiIeubqMAtvP.csv?access_token=5tQstKGzg0Lt4MGTETC1eDjlzk97IIny