文档检测结果查询
更新时间:
请求规范
- 请求 URL:
https://msafe.ilivedata.com/api/v1/media/document/result
- 接口描述:
该接口用于根据 taskId 查询文档检测任务的结果。
- HTTP 请求 Header:
Header
示例值
是否必需
描述
Content-Type
application/json;charset=UTF-8
必需
请求体格式。该接口只接收 JSON 请求体
Accept
application/json;charset=UTF-8
可选
期望的响应格式。不传时默认返回 JSON
X-AppId
82100001
必需
项目的唯一标识，可在 <控制台-服务配置> 中获取
X-TimeStamp
2026-01-31T07:59:03Z
必需
请求发起时的 UTC 时间，格式为 yyyy-MM-dd'T'HH:mm:ss'Z'，例如：2026-01-31T23:59:59Z
Authorization
*****
必需
请求签名。签名计算规则请参考帮助中心的请求签名
- 请求方法:
POST
- 请求体 JSON:
参数
是否必需
类型
描述
taskId
必需
String
提交文档检测任务后返回的任务 ID
- 请求体示例:
{
"taskId": "task_**************************"
}
请求签名
该接口需要在请求 Header 中传入 Authorization 签名。签名计算规则请参考帮助中心的请求签名。
HTTP 响应
Content-Type: application/json;charset=UTF-8
结果为 JSON 格式，请参考以下示例。
字段名
类型
描述
errorCode
Number
错误码，0 表示成功
errorMessage
String
错误消息
code
Number
任务状态码：0 检测完成，1 检测失败，2 检测中，3 taskId 无效
taskId
String
区分不同次调用的唯一标识
appId
String
项目标识
inputType
String
输入类型。文档检测返回 DOCUMENT
documentType
Number
服务实际采用的文档类型。具体含义见下方文档类型编码表
result
Number
文档级检测结果：0 通过，1 疑似，2 不通过
items
Array
文档解析出的内容项检测结果
documentType:
编码
文件类型
0
未知
1
PDF
2
CSV
3
XLSX
4
XLS
5
DOCX
6
DOC
items:
字段名
类型
描述
itemId
String
内容项唯一标识
mediaType
String
媒体类型：TEXT 或 IMAGE
taskId
String
异步媒体项的服务侧任务 ID。同步检测项可能为空
sourceUrl
String
图片内容项的来源 URL
originalText
String
原始文本内容。文本项返回
filteredText
String
过滤后的文本内容。文本项命中不通过内容时返回
result
Number
内容项检测结果：0 通过，1 疑似，2 不通过
tags
Array
命中的分类信息
tags:
字段名
类型
描述
tag
Number
一级分类编码。具体含义请参考帮助中心的分类编码表
subTags
Array
二级分类信息
subTags:
字段名
类型
描述
subTag
Number
二级分类编码
- 响应示例:
{
"errorCode": 0,
"code": 0,
"taskId": "task_**************************",
"appId": "82100001",
"inputType": "DOCUMENT",
"documentType": 1,
"result": 2,
"items": [
{
"itemId": "document_text_1",
"mediaType": "TEXT",
"originalText": "Example document text",
"filteredText": "Example **** text",
"result": 2,
"tags": [
{
"tag": 150,
"subTags": [
{
"subTag": 150001
}
]
}
]
},
{
"itemId": "document_image_1",
"mediaType": "IMAGE",
"result": 0
}
]
}
如果任务仍在处理中，接口返回 code: 2，并可能在有部分检测结果时返回部分结果。
如果 taskId 不存在，接口返回 code: 3。
错误码
Http 状态码
错误码
错误消息
错误原因
200
0
此字段省略
请求成功
400
1003
Bad Request
请求体不是合法 JSON，或服务处理请求失败
400
1112
The project is closed now, please contact us to restart the project.
项目已关闭
400
2000
Missing Parameter
缺少 taskId
400
2001
Invalid Parameter
参数格式错误
401
1102
Unauthorized Client
X-AppId 无效
401
1106
Missing Access Token
缺少 Authorization
401
1107
Invalid Token
Authorization 签名不正确
401
1108
Expired Token
X-TimeStamp 已过期
401
1110
Invalid Client
缺少 X-AppId
401
2000
Missing Parameter
缺少 X-TimeStamp
401
2001
Invalid Parameter
X-TimeStamp 格式错误
429
-
-
请求频率超过限制
请求规范
- 请求 URL:
https://msafe.ilivedata.com/api/v1/media/document/result
- 接口描述:
该接口用于根据 taskId 查询文档检测任务的结果。
- HTTP 请求 Header:
| Header | 示例值 | 是否必需 | 描述 |
|---|---|---|---|
| Content-Type | application/json;charset=UTF-8 | 必需 | 请求体格式。该接口只接收 JSON 请求体 |
| Accept | application/json;charset=UTF-8 | 可选 | 期望的响应格式。不传时默认返回 JSON |
| X-AppId | 82100001 | 必需 | 项目的唯一标识，可在 <控制台-服务配置> 中获取 |
| X-TimeStamp | 2026-01-31T07:59:03Z | 必需 | 请求发起时的 UTC 时间，格式为 yyyy-MM-dd'T'HH:mm:ss'Z'，例如：2026-01-31T23:59:59Z |
| Authorization | ***** | 必需 | 请求签名。签名计算规则请参考帮助中心的请求签名 |
- 请求方法:
POST
- 请求体 JSON:
| 参数 | 是否必需 | 类型 | 描述 |
|---|---|---|---|
| taskId | 必需 | String | 提交文档检测任务后返回的任务 ID |
- 请求体示例:
{
"taskId": "task_**************************"
}
请求签名
该接口需要在请求 Header 中传入 Authorization 签名。签名计算规则请参考帮助中心的请求签名。
HTTP 响应
Content-Type: application/json;charset=UTF-8
结果为 JSON 格式，请参考以下示例。
| 字段名 | 类型 | 描述 |
|---|---|---|
| errorCode | Number | 错误码，0 表示成功 |
| errorMessage | String | 错误消息 |
| code | Number | 任务状态码：0 检测完成，1 检测失败，2 检测中，3 taskId 无效 |
| taskId | String | 区分不同次调用的唯一标识 |
| appId | String | 项目标识 |
| inputType | String | 输入类型。文档检测返回 DOCUMENT |
| documentType | Number | 服务实际采用的文档类型。具体含义见下方文档类型编码表 |
| result | Number | 文档级检测结果：0 通过，1 疑似，2 不通过 |
| items | Array | 文档解析出的内容项检测结果 |
documentType:
| 编码 | 文件类型 |
|---|---|
| 0 | 未知 |
| 1 | |
| 2 | CSV |
| 3 | XLSX |
| 4 | XLS |
| 5 | DOCX |
| 6 | DOC |
items:
| 字段名 | 类型 | 描述 |
|---|---|---|
| itemId | String | 内容项唯一标识 |
| mediaType | String | 媒体类型：TEXT 或 IMAGE |
| taskId | String | 异步媒体项的服务侧任务 ID。同步检测项可能为空 |
| sourceUrl | String | 图片内容项的来源 URL |
| originalText | String | 原始文本内容。文本项返回 |
| filteredText | String | 过滤后的文本内容。文本项命中不通过内容时返回 |
| result | Number | 内容项检测结果：0 通过，1 疑似，2 不通过 |
| tags | Array | 命中的分类信息 |
tags:
| 字段名 | 类型 | 描述 |
|---|---|---|
| tag | Number | 一级分类编码。具体含义请参考帮助中心的分类编码表 |
| subTags | Array | 二级分类信息 |
subTags:
| 字段名 | 类型 | 描述 |
|---|---|---|
| subTag | Number | 二级分类编码 |
- 响应示例:
{
"errorCode": 0,
"code": 0,
"taskId": "task_**************************",
"appId": "82100001",
"inputType": "DOCUMENT",
"documentType": 1,
"result": 2,
"items": [
{
"itemId": "document_text_1",
"mediaType": "TEXT",
"originalText": "Example document text",
"filteredText": "Example **** text",
"result": 2,
"tags": [
{
"tag": 150,
"subTags": [
{
"subTag": 150001
}
]
}
]
},
{
"itemId": "document_image_1",
"mediaType": "IMAGE",
"result": 0
}
]
}
如果任务仍在处理中，接口返回 code: 2，并可能在有部分检测结果时返回部分结果。
如果 taskId 不存在，接口返回 code: 3。
错误码
| Http 状态码 | 错误码 | 错误消息 | 错误原因 |
|---|---|---|---|
| 200 | 0 | 此字段省略 | 请求成功 |
| 400 | 1003 | Bad Request | 请求体不是合法 JSON，或服务处理请求失败 |
| 400 | 1112 | The project is closed now, please contact us to restart the project. | 项目已关闭 |
| 400 | 2000 | Missing Parameter | 缺少 taskId |
| 400 | 2001 | Invalid Parameter | 参数格式错误 |
| 401 | 1102 | Unauthorized Client | X-AppId 无效 |
| 401 | 1106 | Missing Access Token | 缺少 Authorization |
| 401 | 1107 | Invalid Token | Authorization 签名不正确 |
| 401 | 1108 | Expired Token | X-TimeStamp 已过期 |
| 401 | 1110 | Invalid Client | 缺少 X-AppId |
| 401 | 2000 | Missing Parameter | 缺少 X-TimeStamp |
| 401 | 2001 | Invalid Parameter | X-TimeStamp 格式错误 |
| 429 | - | - | 请求频率超过限制 |