Error Codes

Last updated: 2020-04-30 15:16:17

PDF

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
UnsupportedOperation Unsupported operation.
ResourceInUse Resource is in use.
InternalError Internal error.
RequestLimitExceeded The number of requests exceeds the frequency limit.
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.
LimitExceeded Quota limit exceeded.
NoSuchVersion The API version does not exist.
ResourceNotFound The resource does not exist.
AuthFailure.SignatureFailure Invalid signature. Signature calculation error. Please ensure you’ve followed the signature calculation process described in the Signature API documentation.
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.
UnsupportedRegion API does not support the requested region.
UnauthorizedOperation Unauthorized operation.
InvalidParameter Incorrect parameter.
ResourceUnavailable Resource is unavailable.
AuthFailure.MFAFailure MFA failed.
AuthFailure.UnauthorizedOperation The request is not authorized. For more information, see the CAM documentation.
AuthFailure.InvalidSecretId Invalid key (not a TencentCloud API key type).
AuthFailure.TokenFailure Token error.
DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
FailedOperation Operation failed.
UnknownParameter Unknown parameter.
UnsupportedProtocol HTTP(S) request protocol error; only GET and POST requests are supported.
InvalidParameterValue Invalid parameter value.
InvalidAction The API does not exist.
MissingParameter A parameter is missing.
ResourceInsufficient Insufficient resource.

Service Error Codes

Error Code Description
FailedOperation.ContainSensitiveWord The SMS message contains sensitive words. Please contact SMS Helper for assistance.
FailedOperation.FailResolvePacket Failed to parse the request packet. Generally, this is because that the API specification was not followed. Please see Detailed Explanation of Request Body Parsing Error 1004.
FailedOperation.InsufficientBalanceInSmsPackage The package balance is insufficient. Please purchase a package.
FailedOperation.JsonParseFail Failed to parse the request packet.
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.
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.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.
FailedOperation.OtherError Other error. Generally, this is because that the carried parameter is non-compliant. For more information, please see the API description. If necessary, please contact SMS Helper for assistance.
FailedOperation.PhoneNumberInBlacklist The mobile number is in the blacklist. Generally, this is because that the recipient has unsubscribed or the carrier's blacklist was hit. You can contact SMS Helper for assistance.
FailedOperation.PhoneNumberOnBlacklist The mobile number is in the blacklist. Usually, this is because that the user unsubscribed or the carrier's blacklist was hit. You can contact SMS Helper for assistance.
FailedOperation.SignatureIncorrectOrUnapproved The signature is in incorrect format or has not been approved. A signature can only contain 2–12 letters and digits. If the signature format is correct, please check whether it has been approved.
FailedOperation.TemplateAlreadyPassedCheck This template has been approved and cannot be modified again.
FailedOperation.TemplateIncorrectOrUnapproved The template content has not been approved or does not match the content of the approved template. Please see Detailed Explanation of Error 1014.
InternalError.OtherError Other error. Please contact SMS Helper and provide the failed mobile number for assistance.
InternalError.RequestTimeException The request was initiated in an exceptional time. Generally, 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.SigFieldMissing The request packet in the backend packet does not have a Sig field or the Sig field is empty.
InternalError.SigVerificationFail Sig check on backend 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.InvalidParameters Incorrect International or SmsType parameter. If necessary, please contact SMS Helper for assistance.
InvalidParameterValue.ContentLengthLimit The content of the requested SMS message is too long.
InvalidParameterValue.ImageInvalid The format of the uploaded transcoded image is incorrect. Please see the description of this field in the API description. If necessary, please 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. Please see the description of this field in the API description. If necessary, please contact SMS Helper for assistance.
InvalidParameterValue.InvalidInternational International field check failed. Please see the description of this field in the API description. If necessary, please contact SMS Helper for assistance.
InvalidParameterValue.InvalidUsedMethod UsedMethod field check failed. Please see the description of this field in the API description. If necessary, please contact SMS Helper for assistance.
InvalidParameterValue.MissingSignatureList Unable to identify the signature. Generally, this is because that the signature has not been approved. Please check whether the signature has been approved.
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.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.
LimitExceeded.AppDailyLimit The number of SMS messages delivered on the current day exceeds the set upper limit. You can adjust the SMS frequency 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, please contact SMS Helper for assistance.
LimitExceeded.DeliveryFrequencyLimit The SMS delivery hit the frequency limit policy. You can adjust the policy in the console. If you have other requirements, please contact SMS Helper for assistance.
LimitExceeded.PhoneNumberCountLimit There are more than 200 mobile numbers submitted in a single call of the SMS delivery API. Please follow the requirements in API Description.
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 frequency 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 frequency 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 frequency 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 frequency 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.
UnauthorizedOperation.RequestIpNotInWhitelist The requesting IP is not in the whitelist. You have configured verification of request source IP, but the current requesting IP is not in the configured whitelist. If necessary, please contact SMS Helper for assistance.
UnauthorizedOperation.RequestPermissionDeny You do not have permission to make the request. Please contact SMS Helper for assistance.
UnauthorizedOperation.SdkAppidIsDisabled This sdkappid is forbidden to provide services. If necessary, please contact SMS Helper for assistance.
UnauthorizedOperation.SerivceSuspendDueToArrears The service has been suspended due to arrears. You can log in to Tencent Cloud to top up your account.
UnauthorizedOperation.SmsSdkAppidVerifyFail SmsSdkAppid check failed.
UnsupportedOperation. This request is not supported.
UnsupportedOperation.ContainDomesticAndInternationalPhoneNumber The bulk SMS request contains both Mainland China and global mobile numbers.
UnsupportedOperation.UnsuportedRegion SMS delivery to this region is not supported.