查询通话记录下载设置(v2.0)

查询通话记录下载设置。

注: 该接口仅适用于 API 2.0 版本。

请求 URL

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

请求参数

无请求参数。直接发送请求 URL 查询通话记录下载设置。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。
data Object<Download_Setting> 通话记录下载设置。
Download_Setting
参数 类型 说明
range String 通话记录的下载数据范围。
  • list:仅列表数据。
  • transaction:仅通话阶段数据。
  • list_transaction:列表和通话阶段数据。
  • all:列表、通话阶段及时间线数据。
format String 通话记录的下载文件格式。
  • csv
  • xls
  • pdf
  • html
duration_format String 时间相关字段的显示格式。
  • seconds:显示为秒。
  • hhmmss:下载为时分秒 HH:MM:SS。
export_column String 需要导出的字段范围。
  • all:下载全部字段。
  • selected:下载所选字段。

示例

请求示例

GET /openapi/v2.0/cdr/getdownloadoption?access_token=IzmC16oK0Z9loUCnZoYgIXnCSEU4VYR2 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "range": "list_transaction",
        "format": "pdf",
        "duration_format": "hhmmss",
        "export_column": "all"
    }
}