Mobile Number + SMS Verification Code Login API

During the SMS login API call process, it is necessary to first pass a CAPTCHA verification. A successful call will return the user's session_token, while a failure will return error information. Automatic registration can be supported based on the registration configuration enabled in the Enterprise Center.

Request Specification

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

Request Method POST

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	For Internationalization Language Setting	No	String	zh
X-client-id	Application Authorization ID	Yes	String	nTo1eRIub60vPb54WeE6aojPwYwImtl4

Request Body Example

{
    "mobile":"11012345678",
    "verify_code":"232326"
}

Request Parameters

Parameter Name	Chinese Name	Required	Type	Description
mobile	Mobile Number	Yes	String	The mobile number receiving the verification code
verify_code	SMS Verification Code	Yes	String	The received verification code To get the verification code, please refer to the Send SMS Verification Code API type = LOGIN_SMS

Return Example

Success Example 1 (Successfully matched user returns session_token):
HTTP/1.1 200 OK
Content-Type: application/json
{
    "session_token": "btsiBjx85prcZu6I6Ki057Tmw3nSF2VO",
    "expire": 604800,
    "status": "SUCCESS",
    "id_token": "eyJraWQiOiJrMSIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJJc3N1ZXIiLCJhdWQiOiJBdWRpZW5jZSIsImV4cCI6MTY1MzQ4NDQxMiwianRpIjoieUxSVGZXY1VkYk9PeUFpbHdZU0ZqZyIsImlhdCI6MTY1MzQ2NjQxMiwibmJmIjoxNjUzNDY2MjkyLCJzdWIiOiJzdWJqZWN0IiwiYXBpIjoie1wibmFtZVwiOlwiXCIsXCJtb2JpbGVcIjpcIis4Ni0xNTkwNzEzMjg1MlwiLFwiaWRcIjpcIjIwMjIwNDI1MTQwMTM4NTE5LUJGMUItNTI4QjA1NTFCXCIsXCJ1c2VyTmFtZVwiOlwibG91eGlcIixcImVtYWlsXCI6XCIxMUBxcS5jb21cIn0ifQ.al79knH1fKa4aT4AFr_FMjqBKu2pV_g-lKzzgHzmor5X-dHwSBUtjH38KOzjIqHvkcRMjXQuBnWmjRI7-0Djn2LuWVueaf3wRXLscCWiSDC7chjUyTRXMatYINxdvW-oSWFYGFqqbdsavLqOnvehd7ahEaTuiL9yZolvslZIkIxjxBJJu7A9Ln2sk3wf9pxXU83jIJ8ubPQBoVS-ilerTTJOKDZ9XsL2ftJsaqdTJK_mYbvKaVpLIVyHHJ2NcF6f-Al4N4kc8cgxtSgSKFDcR7Bz7dYlOcfUXCPAzJ3NZInm8UaksiWU02tvlvTRvRdoxZNnvD5vamZ5hjFc-cW5jA"
}
Success Example 2 (Returns multi-factor authentication flow):
HTTP/1.1 200 OK
Content-Type: application/json
{
    "status": "MFA_AUTH",
    "state_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJqZWN0Ijoie1wic3RhdGVcIjpcIlBBU1NXT1JEX1dBUk5cIixcInVzZXJJZFwiOlwiMjAyMTA3MjYxNzQwNTgxNDUtOTFCQy0xM0UwMTRBQkJcIn0iLCJpZCI6IjIwMjEwNzI2MTc0MDU4MTQ1LTkxQkMtMTNFMDE0QUJCIiwiZXhwIjoxNjI43MTkwLCJpYXQiOjEasd2Mjg4NDY1OTB9.-egHWNfNPIxNnM540_wTYMtFwB4C9ymznEPRiIC4we0",
    "data": "[\"EMAIL\"]"
}
Success Example 3 (Returns access denied flow):
HTTP/1.1 200 OK
Content-Type: application/json
{
    "status": "ACCESS_DENIED",
    "state_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJqZWN0Ijoie1wic3RhdGVcIjpcIlBBU1NXT1JEX1dBUk5cIixcInVzZXJJZFwiOlwiMjAyMTA3MjYxNzQwNTgxNDUtOTFCQy0xM0UwMTRBQkJcIn0iLCJpZCI6IjIwMjEwNzI2MTc0MDU4MTQ1LTkxQkMtMTNFMDE0QUJCIiwiZXhwIjoxNjI43MTkwLCJpYXQiOjEasd2Mjg4NDY1OTB9.-egHWNfNPIxNnM540_wTYMtFwB4C9ymznEPRiIC4we0",
    "data": "Access Denied"
}
Error Example:
HTTP/1.1 400 Bad Request
{
    "error_code": "SDK.COMMON.1001",
    "error_msg": "Parameter X-client-id cannot be left blank."
}

Return Parameters

Parameter Name	Chinese Name	Type	Description
status	Login Process Status Identifier	String	This field may return the following values: SUCCESS = Login Successful MFA_AUTH = Multi-Factor Authentication ACCESS_DENIED = Access Denied
expire	session_token Validity Period	Number	session_token validity period, within which the session_token can be used to obtain a ticket
session_token	User session_token	String	User session_token, can be used to call IDaas interfaces to obtain a ticket, which can be exchanged for user information
state_token	User Stateful Token	String	User Stateful Token
data	Return Description	String	Return Description: status = MFA_AUTH, returns the multi-factor authentication method status = ACCESS_DENIED, returns access denied
id_token	Short-term Effective, Interface Call Credential	String	This field is a JWT, containing user information and application scope information, requires verification after signing to obtain, valid for 2 hours by default, configurable

I am ready. Please provide the Markdown content you need translated.