SendSmsCode

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

SendSmsCode

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

1. API Description

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

This API is used to send SMS verification codes for changing the admin account of a super 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: SendSmsCode.
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, ChannelUpdateVerify.
PhoneNumber	Yes	String	Specifies the mobile number as the super admin account.
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 Sending SMS Verification Code

Input Example

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

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

Output Example

{
    "Response": {
        "RequestId": "37c3c855-caee-4c44-9778-bdec5998e5f1"
    }
}

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
InternalError.SendSms	Error occurs when sending sms verification code.
InvalidParameterValue.CountryCode	The specified country code is invalid.
InvalidParameterValue.NotModified	The specified phone number is the same as the current one.
InvalidParameterValue.NotSuperAdmin	The specified phone number is not the super administrator of the enterprise.
InvalidParameterValue.PhoneNumber	The specified phone number is invalid.
RequestLimitExceeded.SendSms	The sms verification code sent to the designated mobile number has reached the rate limit.
ResourceNotFound.OfficialInstance	The official cloud disk instance does not exist or does not belong to the current account.
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