VerifySmsCode

Download PDF

Last updated: 2025-12-07 00:27:06

VerifySmsCode

Last updated: 2025-12-07 00:27:06

Download PDF

1. API Description

Domain name for API request: smh.intl.tencentcloudapi.com.

This API is used to verify the SMS verification code for rebinding the super administrator account of an official cloud disk instance.

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: VerifySmsCode.
Version	Yes	String	Common Params. The value used for this API: 2021-07-12.
Region	No	String	Common Params. This parameter is not required for this API.
Purpose	Yes	String	Captcha target, currently supported: rebind super administrator account, BindSuperAdmin; trial version business upgrade verification, ChannelUpdateVerify.
PhoneNumber	Yes	String	Specifies the mobile number as the super admin account.
Code	Yes	String	Specifies the sms verification code.
InstanceId	No	String	Official cloud disk instance ID.
CountryCode	No	String	Specifies the country code of the mobile number that serves as the super administrator account. defaults to +86.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Verifies the SMS verification code

Input Example

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

{
    "Purpose": "BindSuperAdmin",
    "InstanceId": "n0v9tdme",
    "PhoneNumber": "18999999999",
    "Code": "2261"
}

Output Example

{
    "Response": {
        "RequestId": "98a878b5-8c16-4788-a7e7-4b1a19a461db"
    }
}

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

Tencent Cloud CLI 3.0

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
InvalidParameterValue.CountryCode	The specified country code is invalid.
InvalidParameterValue.PhoneNumber	The specified phone number is invalid.
LimitExceeded.UserLimit	The number of users has been reached. please first upgrade the product spec.
ResourceNotFound.OfficialInstance	The official cloud disk instance does not exist or does not belong to the current account.
UnauthorizedOperation.SmsCode	Incorrect or expired sms verification code.
UnauthorizedOperation.SmsCodeExceeded	SMS verification code verification count exceeded. please resend the sms verification code.
UnsupportedOperation.Purpose	The specified purpose is unsupported.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud