Help Center/ Partner Center/ API Reference/
Updated on 2024-01-02 GMT+08:00
View PDF
Share
Sending a Verification Code(Old)

Sending a Verification Code(Old)

Function

If customers enter email addresses for registration, this API is used to send a registration verification code to the email addresses to verify the registration information.

Note:

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

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

This API will be brought offline. For details about the new API for sending a verification code, see Sending a Verification Code.

URI

POST /v1.0/{partner_id}/partner/common-mgr/verificationcode

The following table describes the parameters.

Parameter

Mandatory

Value Range

Description

partner_id

Yes

A maximum 64 characters

Partner ID (assigned by Huawei).

For details about how to obtain partner IDs, see How Do I Check the Partner ID?

Request

Request Parameters

Parameter

Mandatory

Type

Value Range

Description

receiverType

Yes

Integer

[2]

Settings.

2: Send an email verification code

timeout

No

Integer

[0- Maximum allowed integer]

Timeout duration of a verification code.

If this parameter is not included in the request parameters, is set to "", or is set to null, the default timeout interval 10 minutes is used.

If the value of this parameter exceeds 60 minutes, a fixed value 5 minutes will be used.

Unit: minutes

email

Yes

String

A maximum 64 characters

The sender email address.

lang

No

String

A maximum of 128 characters

If no template information is found for the selected language, the template information for the default language is used.

  • 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 language is used.

Example Request

POST  https://bss-intl.myhuaweicloud.com/v1.0/{partner_id}/partner/common-mgr/verificationcode HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

{
    "receiverType":2,
    "email":"xxxxxx@xxxxxxx",
    "lang":"xxx"
}

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

Invalid input parameter.

401

CBC.0154

Invalid or expired token.

403

CBC.0151

Access denied.

500

CBC.0999

Other errors.

500

CBC.4002

Failed to generate the verification code.

500

CBC.4003

The verification code is successfully generated but fails to be sent.

500

CBC.4004

Empty email address./Invalid format.

500

CBC.4015

The number of verification code sending times has reached the upper limit (15 times per hour, 60 times per day).