V-SMS

什么是V-SMS?

V-SMS是由VAPTCHA官方提供的触发类普惠短信接口。与传统短信接口相比它具备以下优点:

速度快不需要中转,直接通过运营商网关进行发送,到达率高。
价格补贴 VAPTCHA对全网进行价格补贴,单条国内短信价格低至2分以内,远远低于市场价。
部署简单不再需要繁琐的接口开发与部署流程,仅仅调用公开方法即可发送。
短信防刷整合VAPTCHA智能人机验证策略,彻底杜绝短信库存被恶意刷爆的风险。

短信补贴条款

享受补贴对象
  • 所有接入VAPTCHA人机验证服务的网站或APP。
补贴规则
  • 注册即送10条测试短信,超过部分先充值后消费,不同的充值金额享受不同的补贴价格,请根据网站需求购买。
  • 充值短信为基础短信,国内短信单次消耗1条,国际短信扣除方法:美国单次10条,其他国家和地区单次25条。
  • 仅对触发类短信进行补贴,短信模板:你的{网站名称}验证码:{123456},{10}分钟内有效("{}"为变量)。
  • 调用短信接口必须回传VAPTCHA验证通过的有效token,不传则按正常价格计费,单次加倍扣除基础短信。
其他
  • 验证单元key将用于短信发送加密验证,请妥善保管,若泄露请及时重新生成。
  • 充值短信无使用期限限制,充值后不可提现,请根据网站需求购买短信条数。

接口引入

方式一.网站自己生成验证码
方式二.V-SMS代为生成验证码
接口说明由网站自己生成验证码,V-SMS发送短信,由网站自己验证。
短信模板你的{label}验证码:{code},{expiretime}分钟内有效。
调用方法 由网站后端发起
方法:HttpPost
接口地址:api.vaptcha.com/sms/send
请求参数
参数 说明 类型
vid 验证单元Id string
token 获取的token值 string
label 希望显示的验证码来源名称 string
code 验证码内容,只能包含数字和大小写英文字母 string
expiretime 验证码有效时间,单位为分钟 int
countrycode 手机国别码,只能包含数字,不包括+号 string
phone 要发送的手机号码,只能包含数字,不带国别码 string
time 当前时间 long
version 当前版本 string
signature 验证签名,前端对参数的签名 string
返回参数:
{“code”:2001} 成功 ; {“code”:2023,"data":100} 发送时间在2分钟内,data为剩余时间秒数; 其余参照返回码对照表。
接口说明由V-SMS生成验证码,V-SMS验证。
短信模板你的{label}验证码:{code},十分钟内有效。
Step1.请求验证码
方法:HttpPost
接口地址:api.vaptcha.com/sms/sendsmscode
请求参数
参数 说明 类型
vid 验证单元Id string
token 获取的token值 string
label 希望显示的验证码来源名称 string
countrycode 手机国别码,纯数字,不包括+号,可不填默认86 string
phone 要发送的手机号码,只能包含数字,不带国别码 string
time 当前时间 long
version 当前版本 string
signature 验证签名,前端对参数的签名 string
返回参数: {“code”:2001} 成功 ; {“code”:2023,"data":100} 发送时间在2分钟内,data为剩余时间秒数; 其余参照返回码对照表。
Step2.验证
方法:HttpPost
接口地址:api.vaptcha.com/sms/verify
请求参数
参数 说明 类型
vid 验证单元Id string
token 获取的token值 string
phone 接受验证码的手机号码,纯数字,不包含国别码 string
time 当前时间 long
version 当前版本 string
signature 验证签名,前端对参数的签名 string
返回参数: {“code”:2001} 成功 ; {“code”:2023,"data":100} 发送时间在2分钟内,data为剩余时间秒数; 其余参照返回码对照表。

返回码释义

返回码 说明
2001 成功
2002 token为空
2003 签名为空
2004 没有用户缓存
2005 验证码格式错误
2006 手机国别码格式错误
2007 手机格式错误
2008 无法找到密钥
2009 签名错误
2010 token过期
2011 找不到用户信息
2012 短信余量不足
2013 系统维护
2023 发送时间在2分钟内
2024 验证次数上限
2025 验证码过期
2026 验证码不匹配