客户身份(CIAM)
发送短信验证码
本文档为您介绍人机校验通过后，调用发送短信验证码接口相关内容。
# 请求说明
POST https://{your_domain}/api/v2/sdk/sms/send
# 请求头
| 参数名 | 中文名称 | 必须 | 类型 | 示例 |
|---|---|---|---|---|
| X-operating-sys-version | 调用方客户端操作系统版本 | 是 | String | windows10.1.1 |
| X-device-fingerprint | 调用方客户端设备指纹 | 是 | String | 156aysdna213sc50 |
| X-device-ip | 调用方客户端IP | 否 | String | 192.168.1.2 |
| X-agent | User-Agent信息 | 是 | String | Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X) |
| X-L | 用于国际化语言设置 | 否 | String | zh |
| X-client-id | 应用授权ID | 是 | String | nTo1eRIub60vPb54WeE6aojPwYwImtl4 |
| content-type | 内容格式类型 | 是 | String | application/json |
# 请求示例
{
"mobile": "15200000000",
"type": "BIND_MOBILE_SMS",
"captcha_token":"71dd26999e314f9abb0c635336976635---{\"x\":237.0,\"y\":5.0}"
}
1
2
3
4
5
6
2
3
4
5
6
# 请求参数
| 参数名 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| mobile | 手机号 | 是 | String | 手机号 |
| type | 发送场景 | 是 | String | 场景类型 REGISTER_SMS: 手机验证码注册、手机绑定或注册用户 LOGIN_SMS: 手机验证码登录 FORGET_PWD_SMS: 忘记密码 UPDATE_PWD_SMS: 通过手机号修改个人密码（mobile携带完整区号） UPDATE_MOBILE_SMS: 修改手机号 BIND_MOBILE_SMS: 手机绑定用户 |
| captcha_token | 图形验证码校验通过令牌 | 是 | String | 图形验证码校验通过令牌 获取验证码请参考获取图形验证码 |
# 返回示例
成功示例：
HTTP/1.1 200 OK
错误示例：
HTTP/1.1 400 Bad Request
{
"error_code": "IDAAS.SDK.CAPTCHA.0006",
"error_msg": "Failed to send verification code"
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
# 返回参数
无
# 错误码
| 状态码 | 错误码 | 错误信息 | 处理措施 |
|---|---|---|---|
| 400 | IDAAS.SDK.PARAM.0001 | Device information is incomplete | 请检查输入的设备信息是否完整 |
| 设备信息不完整 | |||
| 400 | IDAAS.SDK.PARAM.0002 | clientId cannot be empty | 请检查输入的clientId是否为空 |
| clientId不能为空 | |||
| 400 | IDAAS.SDK.PARAM.0003 | The app is not registered, please register the app first | 请检查输入的clientId是否正确 |
| 应用未注册，请先注册应用 | |||
| 400 | IDAAS.SDK.USER.0004 | Mobile number cannot be empty | 请检查输入的手机号是否为空 |
| 手机号不能为空 | |||
| 400 | IDAAS.SDK.PARAM.0007 | Send scene cannot be empty | 请检查输入的发送场景是否为空 |
| 发送场景不能为空 | |||
| 400 | IDAAS.SDK.PARAM.0008 | Graphic verification code verification pass token cannot be empty | 请检查输入的图形验证码校验通过令牌是否为空 |
| 图形验证码校验通过令牌不能为空 | |||
| 400 | IDAAS.SDK.CAPTCHA.0003 | Graphic verification code verification passed the token has been invalid | 请重新获取和校验图形验证码后再调用 |
| 图形验证码校验通过令牌已失效 | |||
| 400 | IDAAS.SDK.CAPTCHA.0004 | Graphic verification code verification passed token verification failed | 输入的令牌和校验图形验证码中返回的令牌不一致 |
| 图形验证码校验通过令牌校验失败 | |||
| 400 | IDAAS.SDK.CAPTCHA.0005 | Unknown sending scenario | 请检查输入的发送场景是否正确 |
| 未知的发送场景 | |||
| 400 | IDAAS.SDK.CAPTCHA.0006 | Failed to send verification code | 请检查输入项是否正确并重新调用 |
| 验证码发送失败 |