这是短信验证码检验接口,使用场景为用户进行注册流程,已经调用过“短信验证码发送接口”,并且收到了短信验证码。用户输入短信验证码,前端提交参数到该接口进行验证,验证成功后,根据form_id不同,进行不同的操作。
目前支持的操作包括:
- FEAT服务返回注册许可Token,前端使用许可Token调用注册账户接口完成注册流程。
- FEAT服务返回用户登录key和uid。
Request
HTTP request
POST https://www.featapi.com/api/auth/phone/verification/
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:登录、免密注册 |
vcode | string | 6位字符长度 |
Response
如果请求成功,当
- form_id为form-130时
- form_id为login且该phone未注册账号时
返回有“token”字段的数据,该字符串为注册许可Token,提交Token到“账户注册接口”,完成用户账户的创建。
{
"error": false,
"message": "exchange vcode to token",
"data":{
"token": "e6zJa90LD6tz4Mu8SWSqqi3Zz2uZRCh2ucI5VuY47V4GAnTO0u4KxpeHZDKp72oi"
}
}
当
- form_id为login且该phone已有账号时
返回key和uid。key可用于Authorization
头Token {key}
。
{
"error": false,
"message": "exchange vcode to token",
"data":{
"key": "e6zJa90LD6tz4Mu8SWSqqi3Zz2uZRCh2u",
"uid": 1234567890
}
}
请求失败,短信验证码不正确或不存在。
{
"error": true,
"message": "Vcode verification failed. Please check it again or regain it.",
"code": "VCODE_VERIFY_FAILED"
}