Sending a Verification Code

Function

If a customer enters an email address during registration, the system sends a registration verification code to the email address to verify the information.

Constraints

This API can be invoked only by the partner AK/SK or token.

The verification codes are sent only during registration. After invoking this API, you need to invoke the API in Creating a Customer to create the registered customers.

Debugging

You can debug the API in API Explorer which supports automatic authentication. API Explorer can automatically generate and debug example SDK code.

URI

POST /v2/bases/verificationcode/send

Request

Request Parameters

Parameter	Mandatory	Type	Value Range	Description
receiver_type	Yes	Integer	[2]	Verification code type. 2: Send an email verification code.
timeout	No	Integer	[1-3000]	Timeout of sending a verification code. If this parameter is not included in the request parameters or is set to null, the default timeout interval 10 minutes is used. If the value of this parameter is greater than 60, the value is fixed to 5 minutes. Unit: minutes
email	Yes	String	A maximum of 64 characters	Email that receives the verification code.
lang	No	String	A maximum of 16 characters	Language in which the email verification code is sent. zh-cn: Chinese en-us: English If this parameter is not included in the request parameters, is set to "", or is set to null, the default value en-us is used.

Example Request

POST  https://bss-intl.myhuaweicloud.com/v2/bases/verificationcode/send HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

{
    "receiver_type":2,
    "timeout": 5,
    "email":"***@163.com",
    "lang":"en-us"
}

Response

Response Parameters

Parameter	Type	Value Range	Description
error_code	String	A maximum of 16 characters	Error code. For details, see Returned Values. This parameter is returned only when a failure occurs.
error_msg	String	A maximum of 1024 characters	Error description. This parameter is returned only when a failure occurs.

Example Response

HTTP/1.1 204 No Content
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time

Returned Values

4xx: This class of HTTP status code is intended for situations in which the error seems to have been caused by the client, for example, the request contains bad syntax or incorrect parameters. You must ensure the request is correct.
5xx: This class of HTTP status code is intended for cases in which the Huawei Cloud server is aware that it has encountered an error or is otherwise incapable of performing the request. In this case, contact Huawei Cloud customer service.

HTTP Value	Error Code	Description
400	CBC.0100	Parameter error.
400	CBC.99000035	You are not a customer of a partner yet.
400	CBC.99004002	Failed to generate the verification code.
400	CBC.99004003	The verification code is successfully generated but fails to be sent.
400	CBC.99004004	Empty email address./Invalid format.
400	CBC.99004015	The number of verification code sending times has reached the upper limit (15 times per hour, 60 times per day).
401	CBC.0154	Invalid or expired token.
403	CBC.0151	Access denied.
500	CBC.0999	Other errors.