V-SMS

什么是V-SMS?

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

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

短信补贴条款

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

接口引入

方式一.网站自己生成验证码
方式二.V-SMS代为生成验证码
方式三.自定义短信模板调用方法
接口说明由网站自己生成验证码,V-SMS发送短信,由网站自己验证。
短信模板【{label}】你当前操作验证码为:{code},{expiretime}分钟内有效。
调用方法 由网站后端发起
方法:HttpPost
接口地址:http://smsapi.vaptcha.com/sms/sendcode
请求参数
参数 说明 类型
vid 验证单元Id string
smskey 用户后台V-SMS页面获取的smskey将用于短信发送, 请妥善保管,若泄露请及时重新生成。 string
token 由vaptcha验证码验证成功后返回的token(一键通过或绘制图形) string
label 希望显示的验证码来源名称 string
code 验证码内容,只能包含数字和大小写英文字母 string
phone 要发送的手机号码,只能包含数字,不带国别码 string
countrycode 手机国别码,只能包含数字,不包括+号 string
time 当前unix时间戳 string
version 当前版本(1.0) string
expiretime 验证码过期时间(单位分钟) string
返回码释义:
200 成功,其他返回码请到https://github.com/VAPTCHA/vsms-sample/blob/master/ReturnCode.txt中查看
接口说明由V-SMS生成验证码,V-SMS验证。
短信模板【{label}】你当前操作验证码为:{code},十分钟内有效。
Step1.请求验证码
方法:HttpPost
接口地址:http://smsapi.vaptcha.com/sms/verifycode
请求参数
参数 说明 类型
vid 验证单元Id string
smskey 用户后台V-SMS页面获取的smskey将用于短信发送, 请妥善保管,若泄露请及时重新生成。 string
token 由vaptcha验证码验证成功后返回的token(一键通过或绘制图形) string
label 希望显示的验证码来源名称 string
phone 要发送的手机号码,只能包含数字,不带国别码 string
countrycode 国别码 string
time 当前unix时间戳 string
version 当前版本(1.0) string
返回码释义:
  200 成功,其他返回码请到https://github.com/VAPTCHA/vsms-sample/blob/master/ReturnCode.txt中查看
Step2.验证
方法:HttpPost
接口地址:http://smsapi.vaptcha.com/sms/verify
请求参数
参数 说明 类型
vid 验证单元Id string
smskey 用户后台V-SMS页面获取的smskey将用于短信发送, 请妥善保管,若泄露请及时重新生成。 string
code 验证码内容,只能包含数字和大小写英文字母 string
phone 要发送的手机号码,只能包含数字,不带国别码 string
countrycode 国别码 string
time 当前unix时间戳 string
version 当前版本(1.0) string
返回码释义:
  200 成功,其他返回码请到https://github.com/VAPTCHA/vsms-sample/blob/master/ReturnCode.txt中查看
接口说明V-SMS自定义短信模板调用方法。
请求接口参数
方法:HttpPost
接口地址:https://smsapi/sms/sendsms
请求参数
参数 说明 类型
username 用户名 string
smskey 短信密钥 string
data 数据,按顺序 string[]
countrycode 国别码 固定86 string
phone 要发送的手机号码,只能包含数字,不带国别码 string
templateid 模板id string
version 当前版本(1.0) string
time unix时间戳 long
返回码释义:
  200 成功,其他返回码请到https://github.com/VAPTCHA/vsms-sample/blob/master/ReturnCode.txt中查看

代码示例

  详细Demo请到https://github.com/VAPTCHA/vsms-sample中查看