- 语音验证码接口
- 请求
- 请求参数
- 响应
- Json返回示例:
语音验证码接口
功能说明:通过电话直呼到用户手机并语音播放验证码,默认最多播放3次。如:您的验证码是1234。 系统已提供的默认模板。
特别说明:验证码短信,请在手机验证环节,加入图片验证码, 以免被恶意攻击。
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
请求参数
参数名 | 类型 | 是否必须 | 描述 | 示例 |
---|---|---|---|---|
apikey | string | 是 | 用户唯一标识 | 9b11127a9701975c734b8aee81ee3526 |
mobile | string | 是 | 接收的手机号、固话(需加区号) | 15205201314 |
code | string | 是 | 验证码,支持4~6位阿拉伯数字 | 1234 |
uid | string | 否 | 该条短信在您业务系统内的ID,如订单号或者短信发送记录流水号。默认不开放,如有需要请联系客服申请。 | 10001 |
callback_url | string | 否 | 本条语音验证码状态报告推送地址。 如推送地址固定,建议在"数据推送与获取”做批量设置。 | http://your_receive_url_address |
附注:该接口加密时,需对手机号和验证码同时加密。
响应
名称 | 类型 | 描述 |
---|---|---|
count | integer | 成功发送的语音呼叫次数 |
fee | integer | 扣费金额,一次语音验证码呼叫扣一条短信 |
sid | string | 记录id,32位的唯一字符串 |
Json返回示例:
{
"count": 1,
"fee": 1,
"sid": "931ee0bac7494aab8a422fff5c6be3ea"
}
防骚扰过滤:默认开启。过滤规则:同1个手机发相同内容,30秒内最多发送1次,5分钟内最多发送3次。