1. 描述

进行一次人机验证,AddVbot是: 创建一次Verify Bot（验证机器人）的动作。

其后台是对滑动验证服务端代码集成文档的后端代码的封装。

2. SDK调用

const api_param = {
    session:"+86-15810419011",
    token:"SMS_25335288",
    sig:"SMS_25335288",
    scene:"SMS_25335288",
}
let api_res = await xduaClient.addVbot(api_param)
</div></div># 调用场景

地球号里的任何登录，注册，短信操作用到的验证码。

3. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name AddVbot
Url https://api.xdua.com/vbot
Method POST
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod ADD
XduaApiColor X 只有持有神验码，才可以创建验码
XduaApiAudience ConsoleX 只有vbot_id为ConsoleX的验码，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 验码直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 需要登录
XduaApiRoles Zoon Zoon可以创建验码
XduaApiResource vbot
XduaApiKparam name
XduaApiAction CreateVbot
XduaApiRule CreateVbot
XduaApiAstates 0
XduaApiEnable true 接口使能

4. 请求参数

名称 位置 类型 必填 默认值 示例 说明
addr body String 是 无 foo@bar.com 验证码地址,电话或者邮箱,格式是+86-1581041901,邮箱是jiaosit@gmail.com格式. 必选
tmpl body String 是 无 SMS_244723 验证码模板

[!note|label:如何两个参数维护整个接口] 验证码的模板在数据库里附带了足够多的信息，帮助做验证码鉴权。所以在创建验证码接口，一个tmpl就足够了。

"inc" "name" "code" "brief" "sign" "app_id" "sap_id" "shop_id" "action" "state" "stato" "expire" "valot" "delay" "cstamp" "ustamp"
"2" "地球号注册短信验证" "SMS_25335288" "地球号注册短信验证模板" "地球号" "ConsoleX" "SvKerneL" "XdUaXduA" "CreateLoginx" "0" "AutoGenerated" "0" "900" "60" "2020-03-18 18:52:25" "2020-03-23 03:47:55"
"3" "地球号登录短信验证" "SMS_186395741" "地球号登录短信验证模板" "地球号" "ConsoleX" "SvKerneL" "XdUaXduA" "CreateLoginx" "0" "AutoGenerated" "0" "900" "60" "2020-03-18 18:52:25" "2020-03-23 03:47:55"
"4" "地球号改密短信验证" "SMS_186360831" "地球号改密短信验证模板" "地球号" "ConsoleX" "SvKerneL" "XdUaXduA" "CreateLoginx" "0" "AutoGenerated" "0" "900" "60" "2020-03-18 18:52:25" "2020-03-23 03:47:55"
"5" "地球号注册邮件验证" "DMS_vbot4USEREG" "地球号注册邮件验证模板" "地球号" "ConsoleX" "SvKerneL" "XdUaXduA" "CreateLoginx" "0" "AutoGenerated" "0" "900" "60" "2020-03-18 18:52:25" "2020-03-23 03:47:55"
"6" "地球号改密邮件验证" "DMS_vbot4CHGPWD" "地球号改密邮件验证模板" "地球号" "ConsoleX" "SvKerneL" "XdUaXduA" "CreateLoginx" "0" "AutoGenerated" "0" "900" "60" "2020-03-18 18:52:25" "2020-03-23 03:47:55"
"7" "地球号设密邮件验证" "DMS_vbot4RSTPWD" "地球号设密邮件验证模板" "地球号" "ConsoleX" "SvKerneL" "XdUaXduA" "CreateLoginx" "0" "AutoGenerated" "0" "900" "60" "2020-03-18 18:52:25" "2020-03-23 03:47:55"

5. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 创建的验码ID

6. 错误码

错误码来自于error字段,通用错误码参考地球号通用错误码

错误码 错误码名 可能原因
2001 验码访问过于频繁 同一个电话只能在5分钟后发送验码访问 失败
2002 验码生成失败 在生成验证码入库时发生错误
2003 发送短信验证码失败 通过运营商发送短信验证码错误
2004 发送邮件验证码失败 发送邮件验证码错误

results matching ""

    No results matching ""