IDaaS Open Platform
Employee Identity (EIAM)

Send SMS Verification Code API

API

This document describes the content related to calling the Send SMS Verification Code API. Before calling the SMS verification code API, human-machine verification must be completed through a graphical captcha. For details, please refer to Get Graphical Captcha.

# Request Specification

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

Content-Type: application/json

# Request Header Parameters

Parameter Name Chinese Name Required Type Example
X-operating-sys-version Caller Operating System Version Yes String windows10.1.1
X-device-fingerprint Caller Device Fingerprint Yes String 156aysdna213sc50
X-device-ip Caller IP No String 192.168.1.2
X-agent User-Agent Information Yes 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 Used for Internationalization Language Setting No String zh
X-client-id Application Authorization ID Yes String nTo1eRIub60vPb54WeE6aojPwYwImtl4

# Request Body Example {/examples/}

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

# Request Parameters {/examples/}

Parameter Name Chinese Name Required Type Description
mobile Mobile Number Yes String Mobile Number
type Send Scenario Yes String Scenario Type
  • LOGIN_SMS: Mobile Number + SMS Verification Code Login API
  • REGISTER_SMS: Social Account Registration and Binding Mobile Number or Email API、Mobile Number + SMS Verification Code Registration API
  • MFA_AUTH_SMS: Mobile Number + SMS Verification Code Secondary Authentication API
  • FORGET_PWD_SMS: Retrieve Password via Mobile Number API
  • CHANGE_PWD_SMS: Force Password Change via Mobile Number When Password Expired API、Change Password via Mobile Number API
  • BIND_MOBILE_SMS: Bind Mobile Number or Email After Social Account Login API
  • UPDATE_MOBILE_SMS: Update Personal Mobile Number API
    • captcha_token Captcha Token Yes String Captcha Verification Pass Token
    To get the captcha, please refer to Get Captcha

    # Return Example

    Success Example:
HTTP/1.1 200 OK
Error Example:
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

    # Return Parameters

    None

    Send Email Verification Code