文档首页/ 云客服/ API参考/ 呼叫中心配置类/ IVR流程管理/ 上传IVR语音文件（importVoiceFile/upload）
更新时间：2023-12-19 GMT+08:00
查看PDF
分享

上传IVR语音文件（importVoiceFile/upload）

场景描述

上传IVR语音文件。

该接口有性能限制：每秒请求10次之后会进行流量控制（超过限制后请求会失败）。

接口方法

POST

接口URI

https://域名/apiaccess/rest/cc-management/v1/importVoiceFile/upload，例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

Authorization

string

True

鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）

2

X-APP-Key

string

False

appKey字段，用户标识，请联系运营人员获取appKey
表2 请求体参数

序号

名称

参数类型

是否必选

说明

1

body

object

False

-

1.1

fileInfo

string

True

Base64编码后的录音文件信息，限制8MB。上传文件大小会相应增加上传时间

1.2

locale

string

True

录音文件的语种，zh_CN(中文)、en_US(英文)、pt_BR(葡萄牙语)、th_TH(泰语)

1.3

voiceType

string

True

语音类型，比如0 是IVR，1提示音，2故障音，3语音通知

1.4

fileType

string

True

文件类型，支持wav格式和MP3格式

wav格式和MP3格式均会使用ffmpeg工具转码为平台所支持的音频文件格式（A-law压缩算法、单声道、采样位数:8bit、采样频率:8000HZ），转换后音质可能会有影响，音频文件数据可能会丢失，建议使用符合平台支持的音频文件格式。

1.5

callBackUrl

string

False

回调URL，系统审核后，系统会通过这个url返回审核的结果信息。

回调URL为客户自定义接口，用于接收系统审核结果信息，其中请求参数与响应参数可参考表3。

回调URL已通过系统管理员加入IVR语音上传回调的地址白名单中。

URL格式参考如下：https://support.huaweicloud.com/productdesc-cec/cec_01_0001.html

1.6

voiceFileName

string

False

IVR语音名称，长度不能超过50字符，只能包含中文、大小写字母，数字。
表3 回调URL参数说明

序号

名称

参数类型

是否必选

说明

请求参数

1.5.1

fileUrl

string

True

审核文件地址，文件地址全称，包括文件后缀。

1.5.2

fileId

string

True

审核文件ID，具体值可参考表4中的fileId字段设置。

1.5.3

status

string

True
  • 文件审核状态，取值范围：
    • 2：审核通过。
    • 3：审核不通过。

1.5.4

comment

string

False

审核状态备注。

响应参数

1.5.5

returnCode

string

True
响应代码，取值范围：
  • 0：审核结果接收成功。
  • 其他：审核结果接收失败。
    说明：

    审核结果接收失败后会重复调用回调接口继续返回文件上传审核结果，超过6次后同一文件的上传审核结果不再继续响应。

响应说明

  • 响应状态码: 200
    表4 响应体参数

    序号

    名称

    参数类型

    是否必选

    说明

    1

    schema

    object

    True

    -

    1.1

    returnCode

    string

    True

    0，成功，其他为失败

    1.2

    description

    string

    True

    描述。

    1.3

    fileId

    string

    False

    上传后的语音文件后生成的id，用于关联云客服的录音
  • 响应状态码: 404

    请求的内容未找到：请检查请求的路径。

  • 响应状态码: 500

    业务失败：请依次确认您请求中各参数的取值

错误码

无。

报文样例

请求头:

Content-Type:application/json
Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX
X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX

请求参数:

{
	"locale" : "zh_CN",
	"voiceType" : "0",
	"fileType" : "wav",
	"callBackUrl" : "http://10.130.40.194:18133/upload",
	"fileInfo" : 
"UklGRjJ+AABXQVZFZm10IBIAAAAGAAEAQB8AAEAfAAABAAgAAABkYXRhAH4AANXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1"
}

响应参数:

{
  "returnCode": "0",
  "description": "File uploaded successfully.",
  "fileId": "1182733043937561608"
}

回调URL样例报文：

//请求参数
{
    "fileUrl": "Y:/IVR/147/voice/0/nPqV9vU3_1666706957559.wav",
    "fileId": "1323606152730207249",
    "status": "2",
    "comment": "审核通过"
}
//响应参数
{
    "returnCode": "0"
}
父主题： IVR流程管理