这是短信验证码发送接口,使用场景为用户进行注册流程,先输入手机号码,并且接收注册短信验证码。前端提交手机号码和相关参数,请求成功后FEAT服务以短信形式发送6位数字验证码到目标手机。验证码有效时间为15分钟。
Request
HTTP request
POST https://www.featapi.com/api/auth/phone/code/
Parameters
无需添加参数。
Authorization
该请求需要授权以下scopes访问权限:
无
Request body
必填参数:
Property name | Value | Description | Notes |
---|---|---|---|
country_code | string | 手机号码所属国家的国家代码 | 比如中国的手机号,则为“CHN” |
phone | string | 手机号码,格式为 +{国际拨号代码}-{手机号码} 范例:+86-12345678 | https://en.wikipedia.org/wiki/List_of_country_calling_codes |
form_id | string | form-130或login | 值为form-130时,手机号必须不存在;值为login时,则为快速登录或注册流程,跳过手机号是否存在的检查 |
Response
如果请求成功,返回成功信息并且FEAT服务向参数中的目标手机发送短信。
{
"error": false,
"message": "Verification code sent",
"data": {
"country_code": "CHN",
"phone": "+86-15915719111",
"time": 1660269366.4595578
}
}
phone参数的手机账号已存在(当form_id
为form-130时)
{
"error": true,
"code": "PHONE_ALREADY_EXISTS",
"message": "Mobile exists."
}
发送短信失败,请检查请求参数是否正确或者短信内部服务异常请稍后再试。
{
"error": true,
"code": "SEND_MSG_ERROR",
"message": "Sending message error, please try it again."
}
目标手机号码在短时间以内已请求了多次短信验证码(具体的请求限制取决于运维的设置,默认是2小时以内至多请求3次)。
{
"error": true,
"code": "SEND_VCODE_LIMIT_ERROR",
"message": "Sending vcode count cannot more than 3 times within 7200 seconds."
}