Help Center/ Meeting/ Server API Reference/ User Password Management/ APIs/ Resetting a Forgotten Password/ Verifying an SMS/Email Verification Code
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Verifying an SMS/Email Verification Code

Description

This API is used to verify a verification code. After receiving a request, the server returns the result.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

PUT

Request Address

/v1/usg/acs/verifycode/check

Transport Protocol

HTTPS

Request Parameters

Table 2 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.

code

Yes

String

Body

Verification code.

maxLength: 32

minLength: 1

user

Yes

String

Body

The value must be the same as the user identity information contained in the request for sending the verification code.

Status Codes

Table 3 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

Table 4 Response parameters

Parameter

Type

Description

token

String

Access token, a string.

expire

Integer

Validity period, in seconds.

Example Request

PUT /v1/usg/acs/verifycode/check 
Connection: keep-alive 
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "code": "374104",
    "user": "+86136****9209"
}

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 

{
    "token":"hYRlErvNnuqEuseSo0PoDBLMvol71wJm7",
    "expire":180
}

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.