下载通话记录

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

下载步骤

  1. 获取通话记录文件的随机串。
  2. 使用随机串,组合成通话记录文件的下载链接
注: 随机串的有效时长为30秒,并且每个随机串使用过一次则失效。

Endpoint

POST /api/v1.1.0/cdr/get_random?token={token}

请求参数

名称 是否必需 类型 描述
extid String 设置分机。
  • 所有分机:设置 extidall,表示下载所有分机的通话记录。
  • 单个分机:设置 extid 为分机号码。
  • 多个分机:设置 extid 为分机号码,多个分机号码之间用 , 隔开。例如:"extid": "1000,1001,1002"
starttime String 查询通话记录的起始时间。

时间格式:yyyy-mm-dd hh:mm:ss

endtime String 查询通话记录的结束时间。

时间格式:yyyy-mm-dd hh:mm:ss

allowedip String

设置允许下载通话记录的设备 IP 地址。

  • 不填写allowedip:只能通过第三方服务器可以下载文件。
  • allowedip 值为空:只能通过第三方服务器可以下载文件。
  • allowedip 填写 IP 地址:只能通过该 IP 地址或第三方服务器可以下载文件。
注:
  • allowedip 只能填写一个 IP 地址。

响应参数

名称 类型 描述
extid String 分机。
starttime String 查询通话记录的起始时间。
endtime String 查询通话记录的结束时间。
random String 通话记录文件的随机串。使用这个随机串组合成该通话录音文件的下载链接。

实际示例

请求示例

获取所有分机的通话记录的随机码。

POST /api/v1.1.0/cdr/get_random?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
{
    "extid": "all",
    "starttime": "2018-11-07 00:00:00",
    "endtime": "2019-02-18 23:59:59"
}
响应示例
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success",
    "extid": "all",
    "starttime": "2018-11-07 00:00:00",
    "endtime": "2019-02-18 23:59:59",
    "random": "0cbcf8917c41c61c6e9fd3e57ecdd467"
}

通话记录下载链接

使用随机串(random)组合成通话记录的下载链接。

通话记录文件的格式为CSV。查看通话记录参数说明

通话记录下载链接格式

https://{pbx domain}/api/v1.1.0/cdr/download?extid={extid}&starttime={starttime}&endtime={endtime}&token={token}&random={random}

通话记录下载链接示例

https://yeastarcloudpbx.com/api/v1.1.0/api/v1.1.0/cdr/download?extid=all&starttime=2018-11-27 00:00:00&endtime=2019-02-18 23:59:59&token=48400f35207bb9c330a0bdaf4a5633e2&random=0cbcf8917c41c61c6e9fd3e57ecdd467