发送短信、邮箱验证码
POST/auth/v1/verification
接口说明
发送手机号、邮箱验证码,手机号、邮箱根据验证场景传入,不支持同时传入
前置条件
- 需要在云开发平台开启手机号或邮箱登录
- 邮箱登录需配置好SMTP服务器配置
后续登录流程
- is_user为true,直接调用登录接口
- is_user为空或false,调用注册接口进行注册后再登录
Request
Header Parameters
x-captcha-token string
验证码token,从验证图片验证码/auth/v1/captcha/data/verify接口获取,接口报错captcha_required时需传入
- application/json
Body
phone_number 手机号 (string)
有效的国内手机号,需加上"+86 "前缀,如"+86 15588665555"
email 邮箱 (string)
有效的邮箱,格式abc@xxx
target 发送验证码的目标 (string)required
传入ANY,其余可选值USER(账号必须在系统中存在)、NOT_USER(账号必须在系统中不存在)
Responses
- 200
Response Headers
- application/json
- Schema
- Example (from schema)
- Example
Schema
verification_id 验证码id (string)
用于传入验证短信、邮箱验证码/auth/v1/verification/verify接口进行验证码的验证
expires_in 验证码过期时间,单位为秒 (integer)
is_user 用户是否存在 (boolean)
判断这个手机号或邮箱是否已经注册为用户,已注册返回true
{
"verification_id": "string",
"expires_in": 0,
"is_user": true
}
{
"verification_id": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjlkMWRjMzFlLWI0ZDAtNDQ4Yi1hNzZmLWIwY2M2M2Q4MTQ5OCJ9.eyJlIjoidG9wc29ud2FuZzE2M0AxNjMuY29tIiwiZXhwIjoxNzQ3OTc0MjUxLCJraWQiOiJmY2JlMzBlZC1mNTc3LTRhMDQtOWIyZi05YTI4ZTc0NjA5MzQiLCJwaiI6Imxvd2NvZGUtNWc5YWMyMHUyYTI3ZGE0NiIsInQiOiJBR055Y0hRT0F3NjN4MUhBIn0.lZ_HWAsLDKKswTQONNY1DP9KlvYZK17gFM5ViubWzQDbHyLnOB-H0CtQgDXeDIqN_qKD82HEIst-IpQXefhEjQY1rD1bhUwYxD23MRjl_fQVt-rYbcrM7Ibls0-by6Rqlso7-wR6VrG_TRujHg_ueecw6KbKB5kCfqGXG5AMcjYJFDMQyL1gpNvrJ50lJQdIlBn6S-Hkch_5qGJBnLO9EVtfkmqoPo7-MemiptsyLcN8adWMuhVOG-60NwaF6nLJob62YdV7NTfTfcgAoPB2VKpbITrZvq7LKLA3J2mMz_LDiARl0DcdcxDJOjejgxpWgnz9vvRsmVlcjK8xuoyeZg",
"expires_in": 600
}
Loading...