响应码说明
认证相关
| 响应码 | 描述 |
|---|---|
| InvalidAuthHeader | Authorization为空或者值验证错误。 值验证错误排查步骤: 1. 检查Filez文档中台是否配置开放接口密钥。详见期1.4.2 Filez文档中台Open API密钥配置 2. 检查Content-Type。值需要是application/json 3. 检查是否发送请求体。如果计算Authorization请求头时包含请求体，那么请求时需要发送请求体 4. 检查计算Authorization时的请求体与实际发送的内容是否一致。可能影响原因换行符，制表符，请求体编码(要求编码是UTF-8) 5. 检查计算token时使用的所有值是否与请求发送的值一致，要求两者完全相同 |
| InvalidAuthRepoID | zOffice中未配置三方repoId，或者对应的repo没有开启publicapi功能，需要检查应用配置 |
| InvalidAuthTimestamp | 请求头timeStamp表示的时间戳与zOffice服务器当前时间戳差值超过30s，检查 |
| TokenIsInvalid | Authorization值不符合规范repoId:publicApi:token |
| Header_{HeaderName}_IsNull | 缺少请求头{HeaderName} |
| PublicApiIsDisable | 文档中台中repoId对应的应用的publicApi功能没有开启 |
| SecretIsNull | 文档中台中repoId对应的应用没有配置publicApi密钥 |
证书相关
| 响应码 | 描述 |
|---|---|
| LicenseNotFound | 未配置license |
| InvalidLicense | 配置的license无效 |
| LicenseIsExpire | 配置的license过期 |
通用请求体检查相关
通用基础请求参数
| 响应码 | 描述 |
|---|---|
| FilenameIsNull | 请求中的fileName为空（注意区分大小写） |
| TargetFilenameIsNull | 参数中的targetFilename为空 |
| SourceInfoIsNull | 参数中的fileUrl为空 |
| CallbackIsNull | 请求中的callback为空，callback是三方应用接收任务结果的回调地址 |
| ThirdPartyTokenIsNull | 请求中的tokenValue为空 |
| TokenTypeIsNull | 请求中的tokenType为空 |
| FileUrlNotAllowed | 参数中fileUrl文件下载地址域名需要与配置中的三方应用接口地址前缀中的域名一致 |
| CallbackUrlNotAllowed | 参数中callback地址域名需要与配置中的三方应用接口地址前缀中的域名一致 |
| TaskQueueCongestion | 任务队列已满，稍后再试 |
| ServerBusy | 服务繁忙，稍后再试 |
| ParamTypeError | 有参数值的类型错误 |
| ParamOutOfRange | 有参数值超出范围或者没有按照给定的参数传入 |
| UriNotFound | api请求路径错误 |
| DownloadErr | 下载文件错误，请确认请求参数中的文件下载链接能正常下载文件，或者tokenType、tokenValue是否正确 |
| NotSupportTask | 发起的任务不支持，请检查请求参数是否符合对应api的要求，例如文件类型、操作类型是否支持 |
水印相关
| 响应码 | 描述 |
|---|---|
| WMPicUrlOrPicNameIsNull | 图片水印参数中picUrl或者picName为空 |
| WMTextParamIsNull | 文字水印中的text参数为空 |
| WMPositionError | 水印参数中的position参数没有按照给定的值传入 |
| WMFontSizeParamIsNull | 水印参数中的FontSize参数为空 |
| WMFontColorParamIsNull | 水印参数中的FontColor参数为空 |
| WMFontParamIsNull | 水印参数中的Font 参数为空 |
| WMPicTypeNotSupport | 水印参数中的图片水印类型不支持 |
| WMPicIsNotSupport | 文字水印中line1是空 |
文档转换相关
| 响应码 | 描述 |
|---|---|
| TargetFilenameIsNull | 转换请求中的TargetFilename为空 |
| NotSupportConvertType | 转换为目标类型不支持 |
| NotSupportOptions | 当前文档中台配置的转换方式不支持selectRange |
转图片相关
| 响应码 | 描述 |
|---|---|
| PDF2PICNoParams | pdf转图片时没有传入参数toPicOptions |
| LongPicTypeError | longPicType参数值错误 |
| Text2PicLongPicTypeError | word转图片不支持图片拼接 |
任务状态相关
| 响应码 | 描述 |
|---|---|
| TaskSuccessNotify (或ConvertSuccessNotify) | 任务成功 |
| TaskFailNotify (或ConvertFailNotify) | 任务失败 |
| TaskHandingNotify | 任务正在处理中 |
结果下载相关
| 响应码 | 描述 |
|---|---|
| InvalidTaskId | 无效的任务ID |
| AccessOtherRepoIsNotAllowed | 不允许访问其他repo创建的任务 |
| ContentIdError | contentId不存在 |
| ContentIdIsNull | contentId为空 |
文档内容操作相关
| 响应码 | 描述 |
|---|---|
| NotSupportEmptyOps | ops不支持为空 |
| TooManyOps | ops中的操作最多允许两个 |
| InvalidOpsWithEmptyOpActId | ops中的操作缺少actId |
| InvalidOpsWithSameActId | ops中不允许存在actId相同的操作 |
| NotSupportModelOp | ops中存在不支持的操作 |
文档合并相关
| 响应码 | 描述 |
|---|---|
| NotSupportConvertType | 不支持的文件类型 |
| HasDifferentType | 文件列表中存在不同的文件类型 |
| WrongPage | 页码小于1 |
| DownloadUrlIsNull | 下载链接为空 |
| DownloadUrlNotAllowed | 下载链接的域名和文档中台配置的三方接口地址不一致 |
| FileListIsNull | fileList为空 |
| TooManyFiles | 文件过多 |
| SameNameButDifferentUrl | 存在文件名相同但是下载链接不同的文件 |
图片操作相关
| 响应码 | 描述 |
|---|---|
| ImageOPNoParams | 图片操作没有传入相关参数 |
文档编辑保护相关
| 响应码 | 描述 |
|---|---|
| ProtectionActIsNull | protectionAct为空 |
| ProtectionActNotAllowed | protectionAct值不支持 |
| InvalidSecret | 文档中台没有配置secret，或者长度不是32 |
| DecryptFail | 密码解密失败 |
文档拆分相关
| 响应码 | 描述 |
|---|---|
| TypeIsNullORInvalid | 拆分类型为空或不支持 |
| keywordIsNull | 拆分类型为TEXT时，keyword为空 |