tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateIntlPhoneEmail

Last updated: 2023-03-28 10:53:04

1. API Description

Domain name for API request: domain.tencentcloudapi.com.

This API is used to verify a mobile number or an email address via a verification code.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateIntlPhoneEmail.
Version Yes String Common Params. The value used for this API: 2018-08-08.
Region No String Common Params. This parameter is not required for this API.
Type Yes Integer The type. Valid values: 1 (mobile number), 2 (email address).
Code Yes String The mobile number or email address.
VerifyCode Yes String The verification code.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Verifying a mobile number or an email address via a verification code

Input Example

POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateIntlPhoneEmail
<Common request parameters>

{
    "Type": 1,
    "Code": "18766554433",
    "VerifyCode": "123456"
}

Output Example

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459398"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError.AddPhoneEmailErr Failed to add the mobile number or email address.
InternalError.CheckVerifyCodeErr Failed to verify the verification code.
InternalError.ForbiddenRequest Forbidden request.
InternalError.JsonMarshal Error in converting to JSON.
InternalError.MethodNotMatch Method mismatch.
InternalError.NeedLogin Login is required.
InternalError.ReadBodyError Failed to read the body.
InternalError.VerifiedPhoneEmailErr The mobile number or email address has already been verified.
InternalError.VerifyCodeErr Incorrect verification code.
InvalidParameterValue.InvalidParameterFormat Invalid parameter value.
MissingParameter.ActionNotFound The route is not defined.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy