Verifying a Verification Code

Description

This API is used to verify a verification code sent to a mobile number and email address. Up to five verification attempts per minute are allowed.

Debugging

You can debug this API in API Explorer.

Prototype

**Table 1** Prototype
Request Method	POST
Request Address	/v1/usg/dcs/member/verification-code/verify
Transport Protocol	HTTPS

Request Parameters

**Table 2** Parameters
Parameter	Mandatory	Type	Location	Description
X-Access-Token	Yes	String	Header	Authorization token. Use the value of accessToken in the response to the request for Authenticating an App ID.
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.
contact	Yes	String	Body	Mobile number or email address of the user. The backend automatically identifies whether it is a mobile number or an email address. If the value is a mobile number, the mobile number must contain the country or region code. For example, a mobile number in Chinese mainland is +86xxxxxxxxxxxxxxx. This parameter is combined with the country parameter. maxLength: 255 minLength: 1
country	No	String	Body	Country or region that the mobile number belongs to. Default value: chinaPR. The value can contain up to 255 characters.
verificationCode	No	String	Body	Verification code, which must be carried in the verification scenario.

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

None

Example Request

POST /v1/usg/dcs/member/verification-code/verify
Connection: keep-alive
X-Access-Token: stb3te1tKXh5mDfICbiSOP0GOoqwkWEDgfB9
Content-Type: application/json
Content-Length: 68
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "contact": "+86136********",
    "country": "chinaPR",
    "verificationCode": "753927"
}

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 143
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: eed03de09b96dec5643adbbb55acf674

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.

Example cURL Command

curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stb3te1tKXh5mDfICbiSOP0GOoqwkWEDgfB9' -d '{"contact": "+86136********","country": "chinaPR","verificationCode": "753927"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/member/verification-code/verify

Parent topic: Changing the Mobile Number or Email Address

Previous topic: Obtaining a Verification Code

Next topic: Changing the Mobile Number or Email Address