竹云IDaaS•开放平台
员工身份(EIAM)

发送短信验证码接口

接口

本文档为您介绍调用发送短信验证码接口相关内容。调用短信验证码接口前必须通过图形验证码完成人机校验，详情请查看获取图形验证码

# 请求说明

POST https://{your_domain}/api/v2/sdk/sms/send

请求类型：application/json

# 请求Header参数

参数名 中文名称 必须 类型 示例
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) AppleWebKit/605.1.15(KHTML, like Gecko)
Mobile/15E148/HuaWei-AnyOffice/2.6.1802.0010/com.huawei.cloudlink.workplace
X-L 用于国际化语言设置 否 String zh
X-client-id 应用授权ID 是 String nTo1eRIub60vPb54WeE6aojPwYwImtl4

# 请求包体示例

{
    "mobile": "15201657315",
    "type": "BIND_MOBILE_SMS",
    "captcha_token":"71dd26999e314f9abb0c635336976635---{\"x\":237.0,\"y\":5.0}"
}
1
2
3
4
5

# 请求参数

参数名 中文名称 必须 类型 描述
mobile 手机号 是 String 手机号
type 发送场景 是 String 场景类型
  • LOGIN_SMS: 手机号+短信验证码登录接口
  • REGISTER_SMS: 社交账号注册并绑定手机号或邮箱接口、手机号+短信验证码注册接口
  • MFA_AUTH_SMS: 手机号+短信验证码二次认证接口
  • FORGET_PWD_SMS: 通过手机号找回密码接口
  • CHANGE_PWD_SMS: 密码过期通过手机号强制修改密码接口、通过手机号修改密码接口
  • BIND_MOBILE_SMS: 社交账号登录后绑定手机号或邮箱接口
  • UPDATE_MOBILE_SMS: 修改个人手机号接口
    • captcha_token 图形验证码凭证 是 String 图形验证码校验通过令牌
    获取验证码请参考获取图形验证码

    # 返回示例

    成功示例：
HTTP/1.1 200 OK
错误示例：
HTTP/1.1 400 Bad Request
{
    "error_code": "SDK.COMMON.1001",
    "error_msg": "Parameter X-client-id cannot be left blank."
}
    1
    2
    3
    4
    5
    6
    7
    8

    # 返回参数

    无

    发送邮件验证码接口