竹云IDaaS•开放平台
客户身份(CIAM)

手机号+短信验证码登录

短信登录接口调用过程中，需要先通过图形验证码校验，调用成功会返回用户的session_token，失败则会返回失败信息。可根据企业中心开启注册配置支持自动注册。

# 请求说明

POST https://{your_domain}/api/v2/sdk/login/mobile-verify-code

# 请求头

参数名 中文名称 必须 类型 示例
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":"11012345678",
    "verify_code":"232326"
}
1
2
3
4

# 请求参数

参数名 中文名称 必须 类型 描述
mobile 手机号 是 String 接收验证码的手机号
verify_code 验证码 是 String 接收到的验证码
获取验证码请参考发送短信验证码接口 type=LOGIN_SMS

# 返回示例

成功示例：
HTTP/1.1 200 OK
Content-Type: application/json
{
    "session_token": "btsiBjx85prcZu6I6Ki057Tmw3nSF2VO",
    "expire": 432000,
    "status": "SUCCESS",
    "id_token": "eyJ0NiJ9.eyJ1cI6IjIifX0.DeWt4QuZXso"
}


错误示例：
HTTP/1.1 400 Bad Request
{
    "error_code": "IDAAS.SDK.CAPTCHA.0007",
    "error_msg": "Incorrect verification code"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# 返回参数

参数名 中文名称 类型 描述
status 登录流程状态标识 String 该字段可能返回的值如下：SUCCESS登录成功
expire session_token有效期 Number Session_token有效期，有效期内可使用session_token获取ticket
session_token 用户session_token String 用户session_token，可使用该token调用IDaaS接口获取新的id_token
id_token 短期有效，接口调用令牌 String 该字段为jwt格式，包含用户身份信息。可参考根据id_token获取用户信息获取用户信息。令牌有效期默认为5分钟，支持可配置

# 错误码

状态码 错误码 错误信息 处理措施
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.PARAM.0009 Verification code cannot be empty 请检查输入的验证码是否为空
验证码不能为空
400 IDAAS.SDK.USER.0004 Mobile number cannot be empty 请检查输入的手机号是否为空
手机号不能为空
400 IDAAS.SDK.CAPTCHA.0007 Incorrect verification code 请检查输入的验证码是否正确
验证码不正确
400 IDAAS.SDK.USER.0001 User not found 请先注册后再试
用户未找到
400 IDAAS.SDK.USER.0039 User is disabled 请联系管理员
用户已被禁用
500 IDAAS.SDK.COM.0002 System busy, please try again later 请重新调用或联系竹云工作人员
系统繁忙，请稍后再试

邮箱+邮件验证码登录