上传语音通知的文字转语音模板文件（createVoiceTemplate）

1

Authorization

string

True

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

2

X-APP-Key

string

False

appKey字段，用户标识，请联系运营人员获取appKey

1

requestBody

object

False

-

1.1

name

string

True

文字转语音模板文件名称，支持填写中文，数字，大小写英文字母。长度不超过50字符。

1.2

scene

string

False

使用场景。

取值范围：3，表示语音通知

1.3

speed

number

False

转成语音的播放语速，取值范围[-200，500]，若不填则默认值：0

1.4

volume

number

False

转成语音的播放音量，取值范围[0，100]，若不填则默认值：50

1.5

voicename

string

False

转成语音的播放音色，取值范围：

• cn_kefuman_common，表示客服曼
• cn_chengshuxing_common，表示成熟型
• cn_roumeiqian_common，表示柔美倩
• cn_ziranzhen_common，表示自然真
• cn_tianmeiru_common，表示甜美茹

若不填则给默认值：cn_kefuman_common

1.6

voicecontent

object

True

需要转为语音的文本内容。

1.6.1

textcontent

string

True

文本内容，最大长度500字节。

具体模板内容由固定文本和变量组成。模板采用UTF-8编码格式，汉字和中文符号为3个字节，字母、数字和英文符号为1个字节。

• 模板内容不能以变量开头。
• 模板内容长度不超过500字节。
• 单个变量长度不超过32字节（如果单个变量长度超过32字节，建议拆分成多变量）。

  支持的变量格式有：

  • ${TXT_数字}：表示变量为定义相应长度的字符串，数字表示该字符串的最大长度，如${TXT_9}表示最大长度为9字节的字符串。
  • ${NUM_数字}：表示变量只能为数字（0～9）的组合，数字表示该变量的最大个数，如${NUM_6}表示最大6个数字的组合。
  • ${DATE}表示变量为日期，格式要求为“YYYY/MM/DD”，其中，“YYYY”代表年，“MM”代表月，“DD”代表日，如2022/07/16。
  • ${TIME}表示变量为时间，支持两种格式，一种格式精确到分钟，格式为“HH:MM”，“HH”代表时，“MM”代表分，如14:30；另一种格式精确到秒，格式为“HH:MM:SS”，“HH”代表时，“MM”代表分，“SS”代表秒，如：14:30:30。

模板样例：

• 样例一：尊敬的${TXT_8}您的初始密码为${NUM_6}。
• 样例二：请于${DATE}，${TIME}前领取您的快递。
  说明：

  ${DATE}和${TIME}必须用逗号隔开。

1.6.2

language

string

True

语种。

• zh_CN(中文)
• en_US(英文)
• pt_BR(葡萄牙语)
• th_TH(泰语)

1.7

callBackUrl

string

False

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

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

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

请求参数

1.7.1

fileUrl

string

True

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

1.7.2

fileId

string

True

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

1.7.3

status

string

True

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

1.7.4

comment

string

False

审核状态备注。

响应参数

1.7.5

returnCode

string

True

1

schema

object

True

-

1.1

returnCode

string

True

0：成功，其他为失败。

1.2

description

string

True

描述。

1.3

templateId

string

False

模板ID