请求验证码(RequestVerifyCode)
requestVerifyCode
API 用于向用户的电子邮件或电话发送验证码。任何与验证码有关的用例,请调用此 API。
请求参数
参数 | 类型 | 描述 | 备注 |
---|---|---|---|
account | string | 账号 邮箱或手机号(暂不支持手机) | 必填 |
account_type | number | 账号类型 1:邮件 2:电话号码(暂时不支持) | 必填 |
phone_area_code | string | 手机区号 | account_type 为 2 时必填 |
code_type | number | 生成的验证码类型 0:注册 1:修改密码 2:登录、验证码注册 3:修改主体注册账号 | |
only_login_type | number | 0:账号不存在时自动注册 1:仅登录 | Optional |
machine_check_type | number | CAPTCHA 类型 3:腾讯 Captcha | 在 Player Network 设置开启人机校验时需要 |
tencent_response | string | 腾讯 Captcha 返回值 需要转成字符串,如: JSON.stringify({"appid":"xxx","ret":0, "ticket":"t030...ECE*","randstr":"@BHo"}) | machine_check_type 为 3 时必填 |
请求示例
accountApi.requestVerifyCode(
{
account:'xxx@gmail.com',
account_type:1,
code_type:0
}
).then((res) => {
console.log(res);
});
返回参数
参数 | 类型 | Description |
---|---|---|
ret | number | 返回代码 0:请求成功,解析相关返回的字段信息。 !=0:请求失败,检查 msg 查看详细的退货信息。 |
msg | string | 结果说明 |
seq | string | 数据流消息序号 |
expire | int64 | 令牌过期时间 Unix 时间 |
返回示例
{
expire_time: 179998
msg: "Success"
ret: 0
seq: "1638242466-0180225865-009373-0000004742"
}