语音通话 VOICECALL-语音验证码场景API:请求参数
下载语音通话 VOICECALL用户手册完整版
请求参数
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
Content-Type |
是 |
String |
固定填写为application/json;charset=UTF-8。 |
Authorization |
是 |
String |
固定填写为AKSK realm="SDP",profile="UsernameToken",type="Appkey"。 |
X-AKSK |
是 |
String |
取值为UsernameToken Username="APP_Key的值", PasswordDigest="PasswordDigest的值", Nonce="随机数", Created="随机数生成时间"。
|
编程语言 |
时间格式 |
|---|---|
Java |
yyyy-MM-dd'T'HH:mm:ss'Z' |
PHP |
Y-m-d\TH:i:s\Z |
Python |
%Y-%m-%dT%H:%M:%SZ |
C# |
yyyy-MM-ddTHH:mm:ssZ |
Node.js |
toISOString().replace(/.[0-9]+\Z/, 'Z') 注：Node.js中，使用toISOString()转换后的时间格式去除毫秒后即为本接口要求的时间格式。 |
参数名称 |
是否必选 |
参数类型 |
默认值 |
说明 |
|---|---|---|---|---|
displayNbr |
是 |
String(4-31) |
无 |
固话号码，被叫终端上显示的主叫号码，需要提前在订购号码页面申请该号码。 号码格式（固话）：国家码+区号+固话，与号码管理页面的“号显号码”保持一致。 若该号码为“暂停”状态，语音通话平台会从该应用下随机选取一个其他可用的固话号码进行外呼。 |
calleeNbr |
是 |
String(4-31) |
无 |
被叫号码。
|
languageType |
是 |
Integer |
无 |
验证码播放的语言类型。 取值范围： 2：中文 |
preTone |
是 |
String(1-128) |
无 |
播放语音验证码之前需要播放的放音文件名，放音文件需要提前通过放音文件管理页面上传并审核通过才能使用。 当前系统只支持Wave格式的音频文件，文件名如“pretone.wav”。 |
verifyCode |
是 |
String(2-9) |
无 |
验证码：只支持0～9的数字，最大8位。 如“12345678”。 |
posTone |
否 |
String(1-128) |
无 |
播放语音验证码之后需要播放的放音文件名。 如果携带该参数，放音文件需要提前通过放音文件管理页面上传并审核通过才能使用。 当前系统只支持Wave格式的音频文件，文件名如“postone.wav”。 如果不携带该参数，系统将在语音验证码播放完毕后结束通话。 |
times |
否 |
Integer |
3 |
播放次数：0～9。 0表示无限循环。 如果不携带该参数，默认播放3次。 |
statusUrl |
否 |
String(1-128) |
无 |
此参数请采用BASE64编码进行加密。 此字段用于设置SP接收状态上报的URL。 语音通话平台将业务触发过程中通话的状态信息（包括呼出、振铃、摘机和挂机信息）推送至此服务器，SP根据通话状态信息确定用户状态。 URL可填写为http://IP:Port或 域名 ，推荐使用域名，支持http和https。且该域名对应多个服务器，避免单点故障无法接收通知。 URL只能由大小写字母（a-z、A-Z），数字（0-9），中划线（-），英文冒号（:），英文点号（.），以及英文斜杠（/）组成，不支持其它字符。 |
feeUrl |
否 |
String(1-128) |
无 |
此参数请采用BASE64编码进行加密。 此参数用于设置SP接收话单上报的URL。 语音通话平台将业务产生的话单推送至此服务器。 URL可填写为http://IP:Port或域名，推荐使用域名，支持http和https。且该域名对应多个服务器，避免单点故障无法接收话单。 URL只能由大小写字母（a-z、A-Z），数字（0-9），中划线（-），英文冒号（:），英文点号（.），以及英文斜杠（/）组成，不支持其它字符。 |
returnIdlePort |
否 |
String(枚举) |
false |
指示是否需要返回空闲端口数量。
如果不携带该参数，系统默认该参数为false。 |
userData |
否 |
String(1-256) |
无 |
用户附属信息，此标识由第三方服务器定义，会在后续的通知消息中携带此信息。 不允许携带以下字符：“{”，“}”（即大括号）。 不允许包含中文字符，如果包含中文字符请采用Base64编码。 |
