更新时间:2023-09-27 GMT+08:00

下载IVR留言

场景描述

下载IVR留言录音文件。

使用说明

  • 前提条件
    • 已通过鉴权(Authorization)、获取接入地址。
  • 使用限制

    开发者只能下载自己帐号下的文件,开发者帐号(appId)所对应的vdnId中必须包含IVR留言录音文件名称(fileName)中的vdnId。

接口方法

POST

接口URI

https://ip:port/CCFS/resource/ccfs/downloadIVRRecordFile?locationId={locationId}

其中,ip为CC-FS安装的服务器IP地址,port为CC-FS的HTTPS端口号。

如果经过NSLB路由,ip为NSLB的服务器IP地址,port为CC-FS服务在NSLB映射的HTTPS端口号。

表1 URL中携带的参数说明

序号

名称

参数类型

是否必选

说明

1

locationId

int

False

节点Id,通过调用会话记录查询接口(https://IP:PORT/oifde/rest/api/queryRecordHistory)查询locationId。

请求说明

表2 请求Headers参数说明

序号

名称

参数类型

是否必选

默认值

说明

1

Content-Type

String

True

固定填 application/json; charset=UTF-8。

2

Authorization

String

True

生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式

表3 请求Body中request参数说明

序号

名称

参数类型

是否必选

默认值

说明

1

version

String(1-32)

True

2.0

协议版本。当前固定值为2.0。

表4 请求Body中msgBody参数说明

序号

名称

参数类型

是否必选

默认值

说明

1

fileName

String(1-225)

True

IVR留言录音文件名称

参数格式:{录音盘符}:/{vdnId}/record/{yyyymmdd}/{文件主名}.wav

例如:Y:/39/record/20201015/10233946082696733.wav

说明:{vdnId}为vdn编号,{yyyymmdd}为生成IVR留言录音文件的日期,{文件主名}为录音文件的名称。vdnId后续字段需要与系统级参数“IVR留言录音文件中vdnId后的目录”保持一致,请联系系统管理员获取,获取路径:配置中心 > 系统参数配置 > 系统参数 > 文件存储服务 > 路径配置 > IVR留言录音文件中vdnId后的目录。默认值为:record。

响应说明

当调用本接口响应成功,则从httpresponse消息中获取文件的二进制数据生成录音文件,文件后缀名为.wav,响应中content-type字段为Application/Octet-stream;charset=UTF-8。

当调用本接口响应失败,则返回相应的错误码信息,错误码响应数据结构请查看下表,resultData为保留字段,默认为空字符串。

表5 响应消息参数说明

序号

名称

参数类型

说明

1

resultCode

String

请求返回的结果码,详见错误码参考

2

resultDesc

String

请求结果描述。

3

resultData

Object

请求响应数据

报文样例

  • 请求头
    POST /CCFS/resource/ccfs/downloadRecordFile HTTP/1.1
    Authorization: auth-v2/ak/2018-07-02T02:45:50Z/content-length;content-type;host/
    eb453f68e858******************196c509c4913
    Accept: */*
    Content-Type: application/json;charset=UTF-8
    Content-Length: 193
  • 请求参数
    {
        "request": {
            "version": "2.0"
        },
        "msgBody": {
            "fileName": "Y:/39/record/20201015/10233946082696733.wav"
        }
    }