- 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
Feature Description
If there is an Error field in the response, it means that the API call failed. For example:
{
"Response": {
"Error": {
"Code": "AuthFailure.SignatureFailure",
"Message": "The provided credentials could not be validated. Please check your signature is correct."
},
"RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"
}
}
Code in Error indicates the error code, and Message indicates the specific information of the error.
Error Code List
Common Error Codes
| Error Code | Description |
|---|---|
| ActionOffline | This API has been deprecated. |
| AuthFailure.InvalidAuthorization | Authorization in the request header is invalid. |
| AuthFailure.InvalidSecretId | Invalid key (not a TencentCloud API key type). |
| AuthFailure.MFAFailure | MFA failed. |
| AuthFailure.SecretIdNotFound | Key does not exist. Check if the key has been deleted or disabled in the console, and if not, check if the key is correctly entered. Note that whitespaces should not exist before or after the key. |
| AuthFailure.SignatureExpire | Signature expired. Timestamp and server time cannot differ by more than five minutes. Please ensure your current local time matches the standard time. |
| AuthFailure.SignatureFailure | Invalid signature. Signature calculation error. Please ensure you’ve followed the signature calculation process described in the Signature API documentation. |
| AuthFailure.TokenFailure | Token error. |
| AuthFailure.UnauthorizedOperation | The request is not authorized. For more information, see the CAM documentation. |
| DryRunOperation | DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidAction | The API does not exist. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Invalid parameter value. |
| InvalidRequest | The multipart format of the request body is incorrect. |
| IpInBlacklist | Your IP is in uin IP blacklist. |
| IpNotInWhitelist | Your IP is not in uin IP whitelist. |
| LimitExceeded | Quota limit exceeded. |
| MissingParameter | A parameter is missing. |
| NoSuchProduct | The product does not exist. |
| NoSuchVersion | The API version does not exist. |
| RequestLimitExceeded | The number of requests exceeds the frequency limit. |
| RequestLimitExceeded.GlobalRegionUinLimitExceeded | Uin exceeds the frequency limit. |
| RequestLimitExceeded.IPLimitExceeded | The number of ip requests exceeds the frequency limit. |
| RequestLimitExceeded.UinLimitExceeded | The number of uin requests exceeds the frequency limit. |
| RequestSizeLimitExceeded | The request size exceeds the upper limit. |
| ResourceInUse | Resource is in use. |
| ResourceInsufficient | Insufficient resource. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | Resource is unavailable. |
| ResponseSizeLimitExceeded | The response size exceeds the upper limit. |
| ServiceUnavailable | Service is unavailable now. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter. |
| UnsupportedOperation | Unsupported operation. |
| UnsupportedProtocol | HTTP(S) request protocol error; only GET and POST requests are supported. |
| UnsupportedRegion | API does not support the requested region. |
Service Error Codes
| Error Code | Description |
|---|---|
| FailedOperation.ContainSensitiveWord | The SMS message contains sensitive words. You can contact SMS Helper for assistance. |
| 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.InsufficientBalanceInSmsPackage | The package balance is insufficient. Please purchase an SMS package. |
| FailedOperation.JsonParseFail | Failed to parse the request body. |
| FailedOperation.MarketingSendTimeConstraint | Marketing SMS messages can only be sent between 8:00 and 22:00 in order not to disturb recipients. |
| FailedOperation.MissingSignature | You cannot apply for a template before you apply for a signature. Please create a signature first as instructed in Creating Signatures. |
| FailedOperation.MissingSignatureList | Unable to identify the signature. Please check whether the signature has been approved. For more information, see the signature approval section in Getting Started. |
| FailedOperation.MissingSignatureToModify | This signature ID has not been submitted for approval or does not exist, so it cannot be modified. Please check whether the SignId is entered correctly. |
| FailedOperation.MissingTemplateList | Unable to identify the template. Please check whether the template has been approved. For more information, see the template approval section in Getting Started. |
| 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.ParametersOtherError | Unknown error. If necessary, you can contact SMS Helper for assistance. |
| FailedOperation.PhoneNumberInBlacklist | The mobile number is in the blocklist. Usually, this is because that the user unsubscribed or the carrier's blocklist was hit. You can contact SMS Helper for assistance. |
| FailedOperation.PhoneNumberParseFail | Failed to parse the mobile number. Please check whether it meets the E.164 standard. |
| 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.SignNumberLimit | The number of signatures has reached the maximum value. |
| FailedOperation.SignatureIncorrectOrUnapproved | The signature is not approved or in an incorrect format. (1) Log in to the SMS console and check whether the signature has been approved; (2) Check whether the signature is in compliance with the format specification, that is, it can contain 2–12 letters and digits. If you have any questions, contact SMS Helper for assistance. |
| FailedOperation.TemplateAlreadyPassedCheck | This template has been approved and cannot be modified again. |
| FailedOperation.TemplateIdNotExist | The template ID or signature ID does not exist. |
| FailedOperation.TemplateIncorrectOrUnapproved | The template is not approved or in wrong format. (1) Log in to the SMS console and check whether the template has been approved; (2) Check whether the template is in compliance with the format specification. If you have any questions, you can contact SMS Helper for assistance. |
| FailedOperation.TemplateNumberLimit | The number of templates has reached the maximum value. |
| InternalError.JsonParseFail | Failed to parse the user parameter. You can contact SMS Helper for assistance. |
| InternalError.OtherError | Other error. You can contact SMS Helper and provide the failed mobile number for assistance. |
| 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.SigFieldMissing | The request body in the backend body does not have a Sig field or the Sig field is empty. |
| 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. |
| InvalidParameter.AppidAndBizId | The account does not match the application ID. |
| InvalidParameter.DirtyWordFound | There are sensitive words. |
| InvalidParameter.InvalidParameters | Incorrect International or SmsType parameter. If necessary, you can contact SMS Helper for assistance. |
| InvalidParameterValue.BeginTimeVerifyFail | BeginTime parameter check failed. |
| InvalidParameterValue.ContentLengthLimit | The content of the requested SMS message is too long. For message length calculation rule, please see Mainland China SMS Length Calculation Rule. |
| InvalidParameterValue.EndTimeVerifyFail | EndTime parameter check failed. |
| InvalidParameterValue.ImageInvalid | The format of the uploaded transcoded image is incorrect. See the description of this field in the API description. If necessary, you can contact SMS Helper for assistance. |
| InvalidParameterValue.IncorrectPhoneNumber | The format of the mobile number is incorrect, Please see Detailed Explanation of Error 1016. |
| InvalidParameterValue.InvalidDocumentType | DocumentType field check failed. See the description of this field in the API description. If necessary, you can contact SMS Helper for assistance. |
| 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.InvalidSignPurpose | SignPurpose field check failed. See the description of this field in the API description. If necessary, you can contact SMS Helper for assistance. |
| InvalidParameterValue.InvalidStartTime | Invalid start time or end time. The reason may be that the requested SendDateTime is later than EndDateTime. |
| InvalidParameterValue.InvalidTemplateFormat | The template format is incorrect. For more information, please see Body Template Review Standards. |
| InvalidParameterValue.InvalidUsedMethod | UsedMethod field check failed. See the description of this field in the API description. If necessary, you can contact SMS Helper for assistance. |
| InvalidParameterValue.LimitVerifyFail | Limit parameter check failed. |
| InvalidParameterValue.OffsetVerifyFail | Offset parameter check failed. |
| InvalidParameterValue.ProhibitedUseUrlInTemplateParameter | URLs are not allowed in template variables. |
| InvalidParameterValue.SdkAppIdNotExist | The SdkAppId does not exist. |
| InvalidParameterValue.SignAlreadyPassedCheck | This signature has been approved and cannot be modified again. |
| InvalidParameterValue.SignExistAndUnapproved | The same signature pending review already exists. |
| InvalidParameterValue.TemplateParameterFormatError | The parameter format of the verification code template is incorrect. For a verification code template, only 0–6 digits can be passed in as the template variable. |
| InvalidParameterValue.TemplateParameterLengthLimit | There are more than 12 characters in a single template variable. There is no upper limit of variable characters for enterprise users. You can change your account identity type to enterprise as instructed here. The limit change will take effect in about one hour. |
| InvalidParameterValue.TemplateWithDirtyWords | The template content contains sensitive words. For more information, please see Body Template Review Standards. |
| LimitExceeded.AppCountryOrRegionDailyLimit | The number of SMS messages delivered on the current day for the specified country/region exceeds the configured upper limit. You can adjust the SMS delivery rate limit policy in the console. |
| LimitExceeded.AppCountryOrRegionInBlacklist | The specified country/region for the SMS message is in the blocklist. You can adjust the SMS delivery limit policy in the console. |
| LimitExceeded.AppDailyLimit | The number of SMS messages delivered on the current day exceeds the set upper limit. You can adjust the SMS delivery rate limit policy in the console. |
| LimitExceeded.AppGlobalDailyLimit | The number of Global SMS messages delivered on the current day exceeds the configured upper limit. You can adjust the SMS delivery rate limit policy in the console. |
| LimitExceeded.AppMainlandChinaDailyLimit | The number of Chinese Mainland SMS messages delivered on the current day exceeds the configured upper limit. You can adjust the SMS delivery rate limit policy in the console. |
| LimitExceeded.DailyLimit | The number of SMS messages delivered on the current day exceeds the set upper limit (for Global SMS). If you want to adjust the limit, you can contact SMS Helper for assistance. |
| LimitExceeded.DeliveryFrequencyLimit | The SMS delivery hits the delivery rate limit policy. You can adjust the policy in the console. If you have other requirements, you can contact SMS Helper for assistance. |
| LimitExceeded.PhoneNumberCountLimit | The number of mobile numbers you query at a time exceeds 200. Please refer to the input parameter PhoneNumberSet. |
| LimitExceeded.PhoneNumberDailyLimit | The number of SMS messages delivered to a single mobile number on the current day exceeds the set upper limit. You can adjust the SMS delivery rate limit policy in the console. |
| LimitExceeded.PhoneNumberOneHourLimit | The number of SMS messages delivered to a single mobile number within 1 hour exceeds the set upper limit. You can adjust the SMS delivery rate limit policy in the console. |
| LimitExceeded.PhoneNumberSameContentDailyLimit | The number of identical SMS messages delivered to a single mobile number exceeds the set upper limit. You can adjust the SMS delivery rate limit policy in the console. |
| LimitExceeded.PhoneNumberThirtySecondLimit | The number of SMS messages delivered to a single mobile number within 30 seconds exceeds the set upper limit. You can adjust the SMS delivery rate limit policy in the console |
| MissingParameter.EmptyPhoneNumberSet | The list of mobile numbers passed in is empty. Please check whether numbers are present in your parameters. |
| UnauthorizedOperation.IndividualUserMarketingSmsPermissionDeny | Individual users do not have permission to send marketing SMS messages. Please see Differences in Rights. |
| 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.SerivceSuspendDueToArrears | The service has been suspended due to overdue payments. You can log in to Tencent Cloud to make the payments. |
| UnauthorizedOperation.SmsSdkAppIdVerifyFail | Failed to verify SmsSdkAppId. Please check whether SmsSdkAppId is under the account associated with the TencentCloud API key. |
| UnsupportedOperation. | The request is not supported. |
| UnsupportedOperation.ContainDomesticAndInternationalPhoneNumber | The group message request contains both Chinese mainland numbers and international numbers. Please check: (1) whether the message is sent to international numbers with a Chinese mainland signature or template; (2) whether the message is sent to Chinese mainland numbers with an international signature or template. |
| UnsupportedOperation.UnsuportedRegion | SMS delivery to this region is not supported. |
Yes
No
Was this page helpful?