Sending an SMS or Email Verification Code
Description
This API is used to send a verification code. A user requests to obtain a verification code after passing the verification of the puzzle piece CAPTCHA on the GUI. After receiving a request, the server sends a verification code to the email address or mobile number.
Debugging
You can debug this API in API Explorer.
Prototype
Request Method |
POST |
---|---|
Request Address |
/v1/usg/acs/verifycode/send |
Transport Protocol |
HTTPS |
Request Parameters
Parameter |
Mandatory |
Type |
Location |
Description |
---|---|---|---|---|
Content-Type |
Yes |
String |
Header |
Media format of the body. Example: application/json; charset=UTF-8 |
X-Request-Id |
No |
String |
Header |
Request ID, which is used for fault tracing and locating. You are advised to use a UUID. If this parameter is not carried, a request ID is automatically generated. |
Accept-Language |
No |
String |
Header |
Language. Values: zh-CN for Chinese (default) and en-US for English. |
sendMethod |
No |
String |
Body |
Mode for sending the verification code. This parameter is mandatory when the user type is a real user account. The default value is sms.
|
token |
No |
String |
Body |
Access token. Obtain the value by calling the API for Verifying a Puzzle Piece CAPTCHA. |
user |
Yes |
String |
Body |
User identity information (mobile number, email address, or user account).
NOTE:
The value must be the same as the user identity information contained in the request for sending the puzzle piece CAPTCHA. |
Status Codes
HTTP Status Code |
Description |
---|---|
200 |
Operation successful. |
400 |
Invalid parameters. |
401 |
Authentication is not performed or fails. |
403 |
Insufficient permissions. |
500 |
Server exception. |
Response Parameters
Parameter |
Type |
Description |
---|---|---|
bindEmail |
String |
If the verification code is sent to an email address, set this parameter to the email address bound to the user. (The email address is processed to mask some middle characters, for example, tes****ount@huawei.com.) |
bindPhone |
String |
If a verification code is sent to a mobile number, set this parameter to the mobile number bound to the user. (The mobile number is processed to mask some middle characters, for example, +86181****2345.) |
expire |
Integer |
Validity period, in seconds. |
Example Request
POST /v1/usg/acs/verifycode/send Connection: keep-alive Content-Type: application/json Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "token": "R7PE9vsaEUHjiLsraWTF3WQhmBet16SbI", "user": "+86136********" }
Example Response
HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache http_proxy_id: c94f64967745b0670c299c0688479078 { "expire":180, "bindPhone":"+8618*********", "bindEmail":null }
Error Codes
If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot