When an API operation fails, an error code is returned. This topic describes the error codes for card text messages.
General classes
Error code | Error description | Description |
OK | Success | Success |
SYSTEM_ERROR | System error | A system error occurred. |
FORBIDDEN_ACTION | Illegal operation | The operation is not allowed. The Action parameter is incorrect. |
Get media resources
Error code | Error message | Description |
MissingParameter | param res must be not empty | Input parameters are required. |
MissingParameter | param resUrl must be not empty | The resource URL (`resUrl`) parameter, which is the OSSKey, cannot be empty. |
InvalidParameter | param pid must be not empty | The PID parameter cannot be empty. |
InvalidParameter | param resUrl (OSSKey) be not exist | The resource URL (OSSKey) does not exist. |
InvalidParameter | param resType must be not empty | The resource type parameter cannot be empty. |
MissingParameter | param fileSize must be not empty | The file size parameter cannot be empty. |
InnerError | can not find any vendor | No valid vendor was found. |
InnerError | save vendor resource fail | The media resource service returned an abnormal status. |
Create a template
Error code | Error message | Description |
InvalidParameter | param partner id must be not empty or < 0 | The partner ID (PID) parameter cannot be empty or less than 0. |
MissingParameter | param template content must be not empty | The template content cannot be empty. |
MissingParameter | param template name must be not empty | The template name cannot be empty. |
MissingParameter | param template must be not empty | The template parameter cannot be empty. |
InvalidParameter | param templateName length must < 20 | The template name must be less than 20 characters. |
MissingParameter | param TemplateContent's pages must be not empty | The `pages` field in the template content cannot be empty. |
InvalidParameter | param cardType invalid | The card template type is invalid. |
MissingParameter | param extendInfo must be not empty | The extension information in the template content cannot be empty. |
MissingParameter | param scene must be not empty | The `scenario` field in the extension information cannot be empty. |
InvalidParameter | param scene must < 10 | The scenario in the extension information must be less than 10 characters. |
InvalidParameter | param factory is invalid, factory | The vendor data in the input parameters is invalid. |
MissingParameter | param cardSignName must be not empty | The signature cannot be empty. |
InvalidParameter | srcType need 1 or 2, but srcType | In the template content, the value of `srcType` must be 1 or 2. |
InvalidParameter | Action & actionType required | The `action` and `actionType` parameters are required for image and button types. |
InvalidParameter | image or video type,src required | The `src` parameter is required for image and video types. |
InvalidParameter | src is required | If the resource address type is 2, the `src` parameter is required. |
InvalidParameter | srcType is 2. src must start with http or https | If the resource address type is 2, the value of `src` must start with `http` or `https`. |
InvalidParameter | srcType is 2. src length too long, it need < 1000 | If the resource address type is 2, the `src` address must be less than 1,000 characters. |
InvalidParameter | srcType is 2. video cover is required | If the resource address type is 2 and the resource is a video, a thumbnail is required. |
InvalidParameter | srcType is 2. cover must start with http or https, src | If the resource address type is 2 and the resource is a video, the thumbnail `src` must start with `http` or `https`. |
InvalidParameter | srcType is 2. cover length too long, it need < 1000 | If a resource is a video with an address type of 2, the src address must be less than 1000 characters. |
InvalidParameter | srcType is 1. can not find res resId | If the resource address type is 1, the resource specified by `resId` cannot be found. |
InvalidParameter | srcType is 1. resource unknown type | If the resource address type is 1, the resource is of an unknown type. |
InvalidParameter | The src attribute does not point to an image as expected. | The specified resource type is incorrect. The resource must be an image. |
InvalidParameter | The src attribute does not point to a video as expected. | The specified resource type is invalid because the resource is a video. |
InvalidParameter | video cover is required | A thumbnail is required for the video. |
InvalidParameter | can not find res cover | The thumbnail was not found in the resource. |
InvalidParameter | resource unknown type | The video resource is of an unknown type. |
InvalidParameter | The cover attribute does not point to an image as expected. | The resource specified by the `cover` attribute is not an image. |
InvalidParameter | The isTextTitle field is missing from the text object. | If the resource type is text, the `isTextTitle` field is required. |
InnerError | can not find any vendor | No available vendors were found. |
InnerError | custom factory not match tmpType factory. factory | Custom vendors without a matching templatetype. |
InnerError | factory not match tmpType. factories | The custom vendor does not match the vendor of the template type. |
InnerError | save tmp fail | Failed to save the template. |
InvalidParameter | param cardType must be 1-20 | The value of the `cardType` parameter must be from 1 to 20. |
ThreeAbnormal | call MW upload resource interface fail: + Mobi abnormal return | The call to the Mobi API operation to submit the template failed. Mobi returned an error message. |
AddTemplateError | add partner template error | An unknown error occurred. Failed to add the template. |
Query template status
Error code | Error description | Description |
MissingParameter | param tmpInfo must be not empty | The `TmpInfo` parameter cannot be empty. |
InvalidParameter | param pid must not be < 1 | The PID is invalid. |
Query performance statistics
Error code | Error description | Description |
InvalidParameter | param pid must be not < 1 | The PID is invalid. |
InvalidParameter | param tmpCode is empty | The `TmpCode` cannot be empty. |
InvalidParameter | param tmpCode size max 100 | The length of `tmpCode` must be less than 100 characters. |
InvalidParameter | param startDate is null | The `startDate` cannot be empty. |
InvalidParameter | Time span no more than 90 days | The query range cannot exceed 90 days. |
Send card text messages (batch sending)
Error code | Error message | Description |
InvalidParameter | cardTemplateParamJson.size not equal phoneNumberJson.size | The number of elements in `cardTemplateParamJson` and `phoneNumberJson` must be the same. |
InvalidParameter | smsUpExtendCodeJson.size not equal phoneNumberJson.size | The number of elements in `smsUpExtendCodeJson` and `phoneNumberJson` must be the same. |
InvalidParameter | duplicate phoneNumber | A duplicate mobile phone number was found. |
card template NotFound | The resource of "card template " is not found | The card template resource was not found. |
card template+size NotFound | The resource of "card template + size " is not found | The card template resource was not found. |
InvalidParameter card template state | The specified parameter " card template state" is not valid | The card template is not active. |
card template ext NotFound | The resource of "card template ext " is not found | The card template extension information was not found. |
sms_tmp_code ext NotFound | The resource of "sms_tmp_code " is not found | The text message template code was not found. |
InvalidParameter | param tmpCode must be not empty | The template code parameter cannot be empty. |
InvalidParameter | param cardMobiles must be not empty and cardMobiles size <10000 | The `cardMobiles` parameter cannot be empty, and the number of mobile phone numbers cannot exceed 10,000. |
InvalidParameter | param cardMobiles extData size must <320 | The size of the extension data for each mobile phone number must be less than 320. |
InvalidParameter | can not find anything tmpOp by tmpCode:" + tmpCode + " or the template is disabled" | No vendor information was found for the specified template code, or the template is not active. |
InvalidParameter | can not find anything vendorConfig by vendorIds | No vendor configuration was found. |
InvalidParameter | can not find tmpOp by vendorId | The vendor template information was not found for the specified vendor ID. |
ThreeAbnormal | call MW cardSmsSupportCheckUrl interface fail: + Mobi abnormal return | The call to the Mobi API operation to check for card text message support failed. Mobi returned an error message. |
Get short links for card text messages
Error code | Error message | Description |
MissingParameter | getShortUrl params is required | Parameters for retrieving a short link are required. |
InvalidParameter | cardTemplateParamJson.size not equal phoneNumberJson.size | The number of elements in `cardTemplateParamJson` and `phoneNumberJson` must be the same. |
InvalidParameter | smsUpExtendCodeJson.size not equal phoneNumberJson.size | The number of elements in `smsUpExtendCodeJson` and `phoneNumberJson` must be the same. |
InvalidParameter | param signs must be not empty and size not > 10 and every sign length <18 | The `signs` parameter cannot be empty. The number of signatures cannot exceed 10, and each signature must be less than 18 characters. |
InvalidParameter | param customUrl must start with http or https | The value of the `customUrl` parameter must start with `http` or `https`. |
InvalidParameter | param customUrl length need < 128 | The length of the `customUrl` parameter must be less than 128 characters. |
InvalidParameter | param mobile is required | The `mobile` parameter is required. |
InvalidParameter | mobile length range 1-64 | The length of the `mobile` parameter must be between 1 and 64 characters. |
InvalidParameter | param tmpOpId must be >1 | The value of the `tmpOpId` parameter must be greater than 1. |
InvalidParameter | cardCodeType value is 1 or 2 | The value of the `cardCodeType` parameter must be 1 or 2. |
InvalidParameter | generationType value is 1 or 2 | The value of the `generationType` parameter must be 1 or 2. |
InvalidParameter | generationType is 2 ,domain is required | If the value of `generationType` is 2, the `domain` parameter is required. |
InvalidParameter | generationType is 2 ,domain is too long ,domain length need < 100 | If the value of `generationType` is 2, the length of the `domain` parameter must be less than 100 characters. |
InvalidParameter | generationType is 2 ,customShortCode is required | If the value of `generationType` is 2, the `customShortCode` parameter is required. |
InvalidParameter | generationType is 2 ,The value of customShortCode ranges from 4 to 8 characters | If the value of `generationType` is 2, the length of the `customShortCode` parameter must be between 4 and 8 characters. |
InvalidParameter | The value of expireTimes ranges from 1 to 7 | The value of the `expireTimes` parameter must be between 1 and 7. |
InvalidParameter | param tmpOpId can not find or tmp is disabled | The vendor template information for the specified `tmpOpId` was not found, or the template is not active. |
InvalidParameter | vendor not supported | Not supported by the vendor |
InvalidParameter | domain is not in pid domain whitelist | The domain name is not in the PID whitelist. |
InvalidParameter | param outId or channel too long | The value of the `outId` or `channel` parameter is too long. |
ThreeAbnormal | call MW getVendorShortUrl interface fail: + Mobi abnormal return | The call to the Mobi API operation to retrieve the vendor short link failed. Mobi returned an error message. |
Verify card text message capabilities
Error code | Error message | Description |
MissingParameter | param tmpCode must be not empty | The template code cannot be empty. |
InvalidParameter | can not find anything tmpOp by tmpCode | No vendor template information was found for the specified template code. |
InvalidParameter | param cardMobiles must be not empty and cardMobiles size <10000 | The `cardMobiles` parameter cannot be empty, and the number of mobile phone numbers cannot exceed 10,000. |
InvalidParameter | param cardMobiles extData size must <320 | The size of the extension data for each mobile phone number must be less than 320. |
InvalidParameter | can not find anything vendorConfig by vendorIds | No vendor configuration was found for the specified vendor IDs. |
ThreeAbnormal | call MW cardSmsSupportCheckUrl interface fail: + Mobi abnormal return | The call to the Mobi API operation to check for card text message support failed. Mobi returned an error message. |