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

请求回放录音文件

场景描述

调用该API,后台会校验录音文件名称,成功则返回token,用于“回放录音文件”。

使用说明

  • 前提条件
    • 已调用“下载话单和录音索引”获取录音索引文件。
    • 已通过鉴权(Authorization)、获取接入地址。
  • 使用限制

    开发者只能播放自己帐号下的录音文件,开发者帐号(appId)和录音文件名称(fileName)必须对应。

    开发者账号(appId)包含在鉴权认证字符串中,详见C2 监控/系统外呼/话单/知识库类接口鉴权方式

接口方法

POST

接口URI

https://ip:port/CCFS/resource/ccfs/requestPlayVoice

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

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

请求说明

表1 请求Headers参数说明

序号

名称

参数类型

是否必选

默认值

说明

1

Content-Type

String

True

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

2

Authorization

String

True

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

表2 请求Body中request参数说明

序号

名称

参数类型

是否必选

默认值

说明

1

version

String(1-32)

True

2.0

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

表3 请求Body中msgBody参数说明

序号

名称

参数类型

是否必选

默认值

说明

1

fileName

String

True

录音文件相对路径名称,从调用“下载话单和录音索引”时返回的录音索引文件字段“original_file_name”中获取。

注意:fileName中“\”需改为“/”。

响应说明

当调用本接口响应成功,则返回相应的响应信息,并且响应信息中resultCode值为0,resultMsg值为success;

响应数据结构请查看表4,resultData携带参数token;

当调用本接口响应失败,则返回相应的错误码信息,resultData默认为null。

表4 响应消息参数说明

序号

名称

参数类型

说明

1

resultCode

String

请求返回的结果码,

2

resultDesc

String

请求结果描述。

3

resultData

Object

请求响应数据,参数说明详见表5

4

response

Object

请求结果对象,参数说明详见表6

不推荐使用,为兼容老版本保留字段。

表5 响应消息resultData参数说明

序号

名称

参数类型

说明

3.1

token

String

调用本接口成功后,用于“回放录音文件”鉴权,失效时间30分钟。

表6 响应消息response参数说明

序号

名称

参数类型

说明

4.1

version

String(1-32)

协议版本,如2.0。

4.2

resultCode

String(1-32)

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

4.3

resultMsg

String

请求结果描述。

报文样例

  • 请求头
    POST /CCFS/resource/ccfs/requestPlayVoice HTTP/1.1
    Authorization: auth-v2/taikang/2018-07-02T02:42:49Z/content-length;content-type;host /7a8fb9d6******************5df0cce3c6a253
    Accept: */*
    Host: 10.154.198.164:18084
    Content-Type: application/json;charset=UTF-8
  • 请求参数
    {
        "request": {
            "version": "2.0"
        },
        "msgBody": {
            "fileName": "Y:/1/0/20180309/108/2022318.V3"
        }
    }
  • 响应头
    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 02 Jul 2018 02:43:03 GMT
  • 响应参数
    {
        "resultData": {
            "token": "DC45F******************6D46F90"
        },
        "resultCode": "0",
        "resultDesc": "success"
    }