1. 描述

创建验证码. 验证码包含：短信验证吗，邮件验证码，邀请码。

接口 名称 url
AddTvfc 发送短信验证码 /tvfc
AddMvfc 发送邮件验证码 /mvfc
AddIvfc 发送邀请码 /ivfc

2. 调用场景

开发者登录超级控制台后,可以以Zoon验码创建自己的验码。

3. 请求参数

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

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

"inc" "name" "code"
"2" "地球号注册短信验证" "SMS_25335288"
"3" "地球号登录短信验证" "SMS_186395741"
"4" "地球号改密短信验证" "SMS_186360831"
"5" "地球号注册邮件验证" "DMS_VFC4USEREG"
"6" "地球号改密邮件验证" "DMS_VFC4CHGPWD"
"7" "地球号设密邮件验证" "DMS_VFC4RSTPWD"

4. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 创建的验码ID
code result string 365782 只有邀请码机制下才会有这个字段,是生成的邀请码。

[!note|label:返回参数的意义] 在短信验证码和邮件验证码的情况下，验证码直接发送到手机和邮箱，返回值的id仅仅是调试作用。

5. SDK调用

    const xduaClient = await XduaClient({
        LOGIN_TOKEN:"eyJhbGciOiJSUzI1NiIsImtpZCI6ImI1MGIxZWZmZGMwMzVlMjg2OWI2YzQ1ZjMzYmRmNWQ3In0.eyJpYXQiOjE1ODQ5NzUwN
    })

api_name = "创建电码";
const res = await xduaClient.addTvfc({
    addr:"+86-15810419011",
    tmpl:"SMS_25335288",
})
console.log(res);
if(res.error == 0){
    got_vfc_id = res.result.id;
    console.log(api_name+"成功 "+got_vfc_id);
}else{
    got_ugrp_id = res.result.id;
    console.log(api_name+"失败 "+res.reason);
}

</code></pre> </div></div></div># 错误码

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

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

results matching ""

    No results matching ""