Send SMS Verification Code API

This document describes how to call the send SMS verification code API. Before calling the SMS verification code API, human-machine verification must be completed through the image captcha. For details, see Get Image Captcha.

Request Description

Request Headers

Parameter Name	Name	Required	Type	Description
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 Example

{
    "mobile": "15201657315",
    "type": "BIND_MOBILE_SMS",
    "captcha_token":"71dd26999e314f9abb0c635336976635---{\"x\":237.0,\"y\":5.0}"
}

Request Parameters

Parameter Name	Name	Required	Type	Description
mobile	Mobile number	Yes	String	Mobile number
type	Sending scenario	Yes	String	Scenario type LOGIN_SMS: Mobile + SMS verification code login API REGISTER_SMS: Social account registration and binding mobile/email API, Mobile + SMS verification code registration API MFA_AUTH_SMS: Mobile + SMS verification code secondary authentication API FORGET_PWD_SMS: Retrieve password by mobile API CHANGE_PWD_SMS: Force password update by mobile when expired API, Change password by mobile API BIND_MOBILE_SMS: Bind mobile/email after social account login API UPDATE_MOBILE_SMS: Update personal mobile API
captcha_token	Image captcha credential	Yes	String	Token issued after image captcha verification passes. To obtain the captcha, see Get Image Captcha.

Response 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."
}

Response Parameters

None