- Release Notes and Announcements
- Product Introduction
- Review Standards
- Global SMS
- Console Guide
- Best Practice
- API Documentation
- SDK Documentation
- FAQ
- Service Agreement
- Contact Us
- Release Notes and Announcements
- Product Introduction
- Review Standards
- Global SMS
- Console Guide
- Best Practice
- API Documentation
- SDK Documentation
- FAQ
- Service Agreement
- Contact Us
1. API Description
Domain name for API request: sms.tencentcloudapi.com.
⚠️ Note: individual users cannot use this API to query SMS body templates. For more information, please see Identity Verification Overview.
- Note: because of the improved security of TencentCloud API 3.0, API authentication is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK.
- You can run this API directly in API 3.0 Explorer, which eliminates the signature calculation steps. After it is executed successfully, API Explorer can automatically generate SDK code samples.
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: DescribeSmsTemplateList. |
| Version | Yes | String | Common Params. The value used for this API: 2021-01-11. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| International | Yes | Integer | Whether it is Global SMS: 0: Mainland China SMS. 1: Global SMS. |
| TemplateIdSet.N | No | Array of Integer | Array of template IDs. If the array is empty, the template list information will be queried by default. You need to use the Limit and Offset fields to set the query range.The max array length is 100 by default. |
| Limit | No | Integer | Upper limit. Maximum value: 100. Note: it is 0 by default and is enabled when TemplateIdSet is empty. |
| Offset | No | Integer | Offset. Note: it is 0 by default and is enabled when TemplateIdSet is empty. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| DescribeTemplateStatusSet | Array of DescribeTemplateListStatus | Response for getting SMS template information |
| 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 Sample request
Input Example
POST / HTTP/1.1
Host: sms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSmsTemplateList
<Common request parameters>
{
"International": 0,
"TemplateIdSet": [
1110,
1111
]
}
Output Example
{
"Response": {
"DescribeTemplateStatusSet": [
{
"TemplateName": "Verification code",
"TemplateId": 1110,
"International": 0,
"ReviewReply": "xxxx",
"CreateTime": 1617379200,
"TemplateContent": "Your verification code is {1}",
"StatusCode": 0
},
{
"TemplateName": "Notification",
"TemplateId": 1111,
"International": 0,
"ReviewReply": "xxxx",
"CreateTime": 1617508800,
"TemplateContent": "Please join the {1} meeting as soon as possible",
"StatusCode": 0
}
],
"RequestId": "f36e4f00-605e-49b1-ad0d-bfaba81c7325"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| FailedOperation.FailResolvePacket | Failed to parse the request packet. Usually, this is because that the API specification was not followed. Please see Detailed Explanation of Request Body Parsing Error 1004. |
| FailedOperation.ForbidAddMarketingTemplates | Individual users cannot apply for sending marketing SMS messages. |
| FailedOperation.JsonParseFail | Failed to parse the request body. |
| FailedOperation.MissingTemplateToModify | This template ID has not been submitted for approval or does not exist, so it cannot be modified. Please check whether the TemplateId is entered correctly. |
| FailedOperation.NotEnterpriseCertification | Individual users cannot use the APIs related to signatures and templates. You can change your account identity type to enterprise as instructed here. The change will take effect in about one hour. |
| FailedOperation.OtherError | Other error. Usually, this is because that the carried parameter is non-compliant. For more information, see the API description. If necessary, you can contact SMS Helper for assistance. |
| FailedOperation.ProhibitSubAccountUse | Non-Root accounts cannot use the template list pull feature. You can use the TencentCloud API key of your root account to call the API. |
| FailedOperation.TemplateNumberLimit | The number of templates has reached the maximum value. |
| InternalError.RequestTimeException | The request was initiated in an exceptional time. Usually, this is because that the difference between your server time and Tencent Cloud server time exceeds 10 minutes. Please check whether the server time and the time field in the API are correct. |
| InternalError.RestApiInterfaceNotExist | This RESTful API does not exist. Please check the RESTful API description. |
| InternalError.SendAndRecvFail | The API timed out or SMS packet sending/receiving timed out. You need to check whether your network jitters or contact SMS Helper for assistance. |
| InternalError.SigVerificationFail | Backend check of Sig failed. |
| InternalError.Timeout | The request to deliver an SMS message timed out. Please see Detailed Explanation of Error 60008. |
| InternalError.UnknownError | Unknown error. |
| InvalidParameterValue.InvalidInternational | International field check failed. See the description of this field in the API description. If necessary, you can contact SMS Helper for assistance. |
| InvalidParameterValue.InvalidTemplateFormat | The template format is incorrect. For more information, please see Body Template Review Standards. |
| InvalidParameterValue.LimitVerifyFail | Limit parameter check failed. |
| InvalidParameterValue.TemplateWithDirtyWords | The template content contains sensitive words. For more information, please see Body Template Review Standards. |
| UnauthorizedOperation.RequestIpNotInWhitelist | The requesting IP is not in the allowlist. You have configured the verification of request source IP, but the current requesting IP is not in the configured allowlist. If necessary, you can contact SMS Helper. |
| UnauthorizedOperation.RequestPermissionDeny | The request does not have permission. You can contact SMS Helper. |
| UnauthorizedOperation.SdkAppIdIsDisabled | This SdkAppId is forbidden to provide services. If necessary, you can contact SMS Helper. |
| UnauthorizedOperation.ServiceSuspendDueToArrears | |
| UnsupportedOperation. | The request is not supported. |
Yes
No
Was this page helpful?