Response Code Description
Authentication Related
| Response Code | Description |
|---|---|
| InvalidAuthHeader | Authorization is empty or value verification error. Value verification error troubleshooting steps: 1. Check if Filez Document Platform has configured Open API key. See 1.4.2 Filez Document Platform Open API Key Configuration 2. Check Content-Type. Value needs to be application/json 3. Check if request body is sent. If calculating Authorization request header includes request body, then request body needs to be sent when requesting 4. Check if the request body used when calculating Authorization is consistent with the actual sent content. Possible affecting reasons: line breaks, tabs, request body encoding (requires UTF-8 encoding) 5. Check if all values used when calculating token are consistent with the values sent in the request, requires both to be exactly the same |
| InvalidAuthRepoID | Third-party repoId is not configured in zOffice, or the corresponding repo has not enabled publicapi function, need to check application configuration |
| InvalidAuthTimestamp | The timestamp represented by request header timeStamp differs from zOffice server current timestamp by more than 30s, check |
| TokenIsInvalid | Authorization value does not conform to specification repoId:publicApi:token |
| Header_{HeaderName}_IsNull | Missing request header {HeaderName} |
| PublicApiIsDisable | The publicApi function of the application corresponding to repoId in Document Platform is not enabled |
| SecretIsNull | The application corresponding to repoId in Document Platform has not configured publicApi key |
License Related
| Response Code | Description |
|---|---|
| LicenseNotFound | License not configured |
| InvalidLicense | Configured license is invalid |
| LicenseIsExpire | Configured license is expired |
Common Request Body Check Related
Common Basic Request Parameters
| Response Code | Description |
|---|---|
| FilenameIsNull | fileName in request is empty (note case sensitivity) |
| TargetFilenameIsNull | targetFilename in parameters is empty |
| SourceInfoIsNull | fileUrl in parameters is empty |
| CallbackIsNull | callback in request is empty, callback is the callback address for third-party application to receive task results |
| ThirdPartyTokenIsNull | tokenValue in request is empty |
| TokenTypeIsNull | tokenType in request is empty |
| FileUrlNotAllowed | File download address domain needs to match the domain in the third-party application interface address prefix in configuration |
| CallbackUrlNotAllowed | File download address domain needs to match the domain in the third-party application interface address prefix in configuration |
| TaskQueueCongestion | Task queue is full, try again later |
| ServerBusy | Server is busy, try again later |
| ParamTypeError | Parameter value type error |
| ParamOutOfRange | Parameter value is out of range or not passed according to given parameters |
| UriNotFound | API request path error |
| DownloadErr | Download file error, please confirm the file download link in request parameters can download files normally, or if tokenType, tokenValue are correct |
| NotSupportTask | Initiated task is not supported, please check if request parameters meet the requirements of the corresponding API, for example if file type, operation type are supported |
Watermark Related
| Response Code | Description |
|---|---|
| WMPicUrlOrPicNameIsNull | picUrl or picName in image watermark parameters is empty |
| WMTextParamIsNull | text parameter in text watermark is empty |
| WMPositionError | position parameter in watermark parameters is not passed according to given values |
| WMFontSizeParamIsNull | FontSize parameter in watermark parameters is empty |
| WMFontColorParamIsNull | FontColor parameter in watermark parameters is empty |
| WMFontParamIsNull | Font parameter in watermark parameters is empty |
| WMPicTypeNotSupport | Image watermark type in watermark parameters is not supported |
| WMPicIsNotSupport | line1 in text watermark is empty |
Document Conversion Related
| Response Code | Description |
|---|---|
| TargetFilenameIsNull | TargetFilename in conversion request is empty |
| NotSupportConvertType | Target type for conversion is not supported |
| NotSupportOptions | Conversion method configured in current Document Platform does not support selectRange |
| PDF2PICNoParams | No toPicOptions parameter passed when converting pdf to image |
| LongPicTypeError | longPicType parameter value error |
| Text2PicLongPicTypeError | Word to image does not support image stitching |
Task Status Related
| Response Code | Description |
|---|---|
| TaskSuccessNotify (or ConvertSuccessNotify) | Task succeeded |
| TaskFailNotify (or ConvertFailNotify) | Task failed |
| TaskHandingNotify | Task is being processed |
Result Download Related
| Response Code | Description |
|---|---|
| InvalidTaskId | Invalid task ID |
| AccessOtherRepoIsNotAllowed | Not allowed to access tasks created by other repos |
| ContentIdError | contentId does not exist |
| ContentIdIsNull | contentId is empty |
Document Content Operation Related
| Response Code | Description |
|---|---|
| NotSupportEmptyOps | ops does not support being empty |
| TooManyOps | Maximum of two operations allowed in ops |
| InvalidOpsWithEmptyOpActId | Operations in ops are missing actId |
| InvalidOpsWithSameActId | Operations with same actId are not allowed in ops |
| NotSupportModelOp | Unsupported operations exist in ops |
Document Merge Related
| Response Code | Description |
|---|---|
| NotSupportConvertType | Unsupported file type |
| HasDifferentType | Different file types exist in file list |
| WrongPage | Page number is less than 1 |
| DownloadUrlIsNull | Download link is empty |
| DownloadUrlNotAllowed | Download link domain does not match the third-party interface address configured in Document Platform |
| FileListIsNull | fileList is empty |
| TooManyFiles | Too many files |
| SameNameButDifferentUrl | Files with same name but different download links exist |
Image Operation Related
| Response Code | Description |
|---|---|
| ImageOPNoParams | Image operation did not pass related parameters |
Document Edit Protection Related
| Response Code | Description |
|---|---|
| ProtectionActIsNull | protectionAct is empty |
| ProtectionActNotAllowed | protectionAct value is not supported |
| InvalidSecret | Document Platform has not configured secret, or length is not 32 |
| DecryptFail | Password decryption failed |
Document Split Related
| Response Code | Description |
|---|---|
| TypeIsNullORInvalid | Split type is empty or not supported |
| keywordIsNull | When split type is TEXT, keyword is empty |