语音验证码接口


功能说明:

  • 通过电话直呼到用户手机并语音播放验证码,默认最多播放 3 次。如:您的验证码是 1234。 系统已提供的默认模板。
  • 为防止骚扰用户,每天0:00至7:00禁止发送语音验证码。


特别说明:验证码短信,请在手机验证环节,加入图片验证码, 以免被恶意攻击。


HTTP 头信息:


Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;


请求


URL:https://voice.yunpian.com/v2/voice/send.json
访问方式:POST


请求参数

参数名类型是否必须描述示例
apikeystring

用户唯一标识,在"账号设置"-"子帐号管理"中查看

9b11127a9701975c734b8aee81ee3526
mobilestring接收的手机号、固话(需加区号),只支持国内号码15205201314
codestring验证码,支持 4~6 位阿拉伯数字1234
uidstring该条短信在您业务系统内的 ID,如订单号或者短信发送记录流水号。默认不开放,如有需要请联系客服申请。10001
callback_urlstring本条语音验证码状态报告推送地址。 如推送地址固定,建议在"数据推送与获取”做批量设置。http://your_receive_url_address


附注:该接口加密时,需对手机号和验证码同时加密。


响应

名称类型描述
countinteger成功发送的语音呼叫次数
feeinteger扣费金额,一次语音验证码呼叫扣一条短信
sidstring记录 id,32 位的唯一字符串


Json 返回示例:


调用成功的返回示例:


{
  "count": 1,
  "fee": 1,
  "sid": "931ee0bac7494aab8a422fff5c6be3ea"
}


调用失败的返回示例:


{
  "http_status_code": 400,
  "code": 8,
  "msg": "同一手机号30秒内重复提交相同的内容",
  "detail": "同一个手机号 15840685236 30秒内重复提交相同的内容"
}


防骚扰过滤


过滤规则:同一个手机号码,30 秒内最多发送 1 次,1小时内最多发送 3 次,24小时内最多发送 5次。