录音下载接口
前置条件
- Gateway已经挂载文件服务器且打开了录音下载开关
- CC-Gateway配置了映射关系
- 配置文件中已配置挂载目录
- 座席已签入
场景描述
下载文件服务器上的录音文件(不建议通过该接口下载超过30MB的录音文件)。
SaaS/OP集成组网下,下载的录音文件编码格式为G711.A-law,请使用合适的播放器播放。
- 此处下载的数据中,包含个人数据,下载后务必谨慎处理,防止个人数据外泄滥用。
- 下载的录音文件格式受CC-Gateway配置项RECORD_AUDIOENCODING控制,已商用环境不支持24K、32K、64K录音格式切换,如果切换会导致历史录音文件下载失败。
配置项路径:/home/elpis/tomcat/webapps/agentgateway/WEB-INF/config/basic.properties
接口方法
设置成“GET”。该接口仅支持GET方法,不支持PUT、POST和DELETE等方法。
接口URI
https://ip:port/agentgateway/resource/recordfile/{agentid}?recordId= xxx&filetype=1
例:https://ip:port/agentgateway/resource/recordfile/102?recordId=y:/1/0/20181217/120/1524488.V3
如果CC-Gateway单机部署,IP地址为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号,默认值为8043;如果CC-Gateway采用集群模式部署,IP请配置为NSLB地址, Port请配置为默认值8043。
NSLB上的CC-Gateway端口号,请以nslb用户登录任意一个NSLB节点,执行./nslbctl l查询,查询结果中,如下端口表示CC-Gateway通过NSLB面向第三方系统开放的端口。

SaaS场景下请咨询运维人员获取IP和Port。
|
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|---|
|
1 |
agentid |
string |
True |
签入的座席id。 |
|
2 |
recordId |
string |
True |
录音文件的路径和名称。 录音文件的路径和名称是在触发了AgentMediaEvent_Record时生成的,在fileName中返回。 录音文件路径格式详见下方说明。 |
|
3 |
filetype |
string |
False |
录音文件类型: 1:座席通话录音 2:IVR留言录音或者第三方留言录音文件
说明:
默认为座席通话录音。 |
|
4 |
locationId |
number |
False |
节点Id(CTI POOL模式下为必选),在触发了AgentMediaEvent_Record时生成。
说明:
受CC-Gateway配置文件basic.properties中的配置项locationautoadaptswitch的影响,当参数值为false时,该参数为必传项;当参数值为true时,该参数为选填项。 |
|
5 |
recordFormat |
string |
False |
要下载的录音格式。 可选值:
SaaS场景下,不传该参数。 |
日志中的方法名
downloadRecordFile
请求说明
- 消息头
表2 请求头参数说明 序号
名称
参数类型
是否必选
说明
1
Content-Type
string
True
消息主体编码方式,缺省值:application/json; charset=UTF-8
2
Guid
string
True
静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。
响应说明
该接口的响应说明体举例如下:
- 下载失败时:
消息头Content-Type: application/json;charset=UTF-8
消息体示例请参见报文样例
表3 消息体参数说明 序号
名称
参数类型
说明
1
message
string
描述
2
retcode
string
错误码。取值如下:
0:成功
非0:失败
3
result
object
预留字段
- 下载成功时:
消息头 Content-Type: application/octet-stream;charset=utf-8
消息体 文件流
触发事件
- 座席签入,调用录音下载接口。
错误结果码
- 104-001
- 104-005
- 104-010
- 104-012