语音通话 VoiceCall-语音通知API:请求参数

表6 PlayContentInfo定义

参数名称

是否必选

参数类型

默认值

说明

notifyVoice

否

String(1-128)

无

通知语音的放音文件名。需要先通过页面上传放音文件并通过审核才能使用。

当前系统只支持Wave格式的音频文件，文件如“notifyvoice.wav”。

该参数和templateId是二选一的关系，即两个参数必须携带其中一个。

templateId

否

String(1-32)

无

语音通知模板ID，用于唯一标识语音通知模板。语音通知模板为TTS文本的模板，需要先通过页面提交模板并通过审核才能使用，并获取对应的模板ID。

该参数和notifyVoice是二选一的关系。需要与templateParas参数配合使用。

templateParas

否

String(1-32)[1-10]

无

语音通知模板的变量值列表，用于依次填充templateId参数指定的模板内容中的变量。

该参数需填写为JSONArray格式。具体可参考变量规则。

参数内容必须是“UTF-8”编码，不能包含以下3个字符：“$”手机您请求的网址url无法获取，“{”，“}”。

当接口中携带“templateId”参数时，必须携带此参数，若未携带此参数系统将返回“非法请求”错误。

列表中变量值的个数及长度必须和templateId对应模板内容中定义的变量个数及长度保持一致；例如templateId对应的模板内容有2个变量且变量长度分别为5和6，则此处需要设置2个变量值且内容长度分别小于等于5和6。

如模板内容为“您有${NUM_2}件快递请到${TXT_32}领取”时，该参数可填写为["3","人民公园正门"]。

collectInd

否

Integer(1-32)

0

是否进行收号。若进行收号，请在语音通知内容播放完毕后的5秒之内进行按键操作手机您请求的网址url无法获取，系统会将用户输入的号码通过语音通知呼叫状态通知API发送给SP。

取值范围：

0：不收号

1~32：收号，并且取值表示收号位长，最大支持32位。

若不携带该参数，则默认不收号。

replayAfterCollection

否

String(枚举)

false

当collectInd字段设置为非0时此参数有效。

此字段用于设置是否在收号后重新播放notifyVoice、ttsContent或templateId指定的放音。

默认值：false。

collectContentTriggerReplaying

否

String(1-32)

无

当replayAfterCollection字段设置为true时此参数有效。

此字段用于设置触发重新放音的收号内容。只有实际收号内容与该参数值一致时，才重新放音。例如：该参数设置为1，当用户根据收号语音提示按1，两者一致，则重复放音。