文档检测任务提交
更新时间:
请求规范
- 请求 URL:
https://msafe.ilivedata.com/api/v1/media/document/submit
- 接口描述:
该接口用于提交文档异步检测任务。提交成功后，接口返回 taskId，检测结果会通过回调方式返回，也可以使用结果查询接口根据 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:
参数
是否必需
类型
描述
url
必需
String
需要检测的文档 URL，必须以 http:// 或 https:// 开头
strategyId
必需
String
策略编号，通过控制台配置
fileName
可选
String
用于辅助识别文档类型的文件名，例如 demo.pdf
mimeType
可选
String
用于辅助识别文档类型的 MIME 类型，例如 application/pdf
callbackUrl
可选
String
接收检测结果的回调地址。传入该字段时，优先使用请求中的回调地址，而不是控制台配置的回调地址
- 请求体示例:
{
"url": "https://example.com/demo.pdf",
"strategyId": "DEFAULT",
"fileName": "demo.pdf",
"mimeType": "application/pdf",
"callbackUrl": "https://example.com/callback"
}
支持的文档类型：
文件类型
fileName 示例
mimeType 示例
PDF
demo.pdf
application/pdf
CSV
demo.csv
text/csv
XLSX
demo.xlsx
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
XLS
demo.xls
application/vnd.ms-excel
DOCX
demo.docx
application/vnd.openxmlformats-officedocument.wordprocessingml.document
DOC
demo.doc
application/msword
请求签名
该接口需要在请求 Header 中传入 Authorization 签名。签名计算规则请参考帮助中心的请求签名。
HTTP 响应
Content-Type: application/json;charset=UTF-8
结果为 JSON 格式，请参考以下示例。
字段名
类型
描述
errorCode
Number
错误码，0 表示成功
errorMessage
String
错误消息
taskId
String
区分不同次调用的唯一标识
code
Number
任务状态码，2 表示任务检测中
- 响应示例:
{
"errorCode": 0,
"taskId": "task_**************************",
"code": 2
}
错误码
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
缺少必需参数，例如 url、strategyId
400
2001
Invalid Parameter
参数格式错误，例如 url 不是 HTTP/HTTPS 地址、文档类型不支持、文档内容无效，或 strategyId 不存在
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/submit
- 接口描述:
该接口用于提交文档异步检测任务。提交成功后，接口返回 taskId，检测结果会通过回调方式返回，也可以使用结果查询接口根据 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:
| 参数 | 是否必需 | 类型 | 描述 |
|---|---|---|---|
| url | 必需 | String | 需要检测的文档 URL，必须以 http:// 或 https:// 开头 |
| strategyId | 必需 | String | 策略编号，通过控制台配置 |
| fileName | 可选 | String | 用于辅助识别文档类型的文件名，例如 demo.pdf |
| mimeType | 可选 | String | 用于辅助识别文档类型的 MIME 类型，例如 application/pdf |
| callbackUrl | 可选 | String | 接收检测结果的回调地址。传入该字段时，优先使用请求中的回调地址，而不是控制台配置的回调地址 |
- 请求体示例:
{
"url": "https://example.com/demo.pdf",
"strategyId": "DEFAULT",
"fileName": "demo.pdf",
"mimeType": "application/pdf",
"callbackUrl": "https://example.com/callback"
}
支持的文档类型：
| 文件类型 | fileName 示例 | mimeType 示例 |
|---|---|---|
| demo.pdf | application/pdf | |
| CSV | demo.csv | text/csv |
| XLSX | demo.xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| XLS | demo.xls | application/vnd.ms-excel |
| DOCX | demo.docx | application/vnd.openxmlformats-officedocument.wordprocessingml.document |
| DOC | demo.doc | application/msword |
请求签名
该接口需要在请求 Header 中传入 Authorization 签名。签名计算规则请参考帮助中心的请求签名。
HTTP 响应
Content-Type: application/json;charset=UTF-8
结果为 JSON 格式，请参考以下示例。
| 字段名 | 类型 | 描述 |
|---|---|---|
| errorCode | Number | 错误码，0 表示成功 |
| errorMessage | String | 错误消息 |
| taskId | String | 区分不同次调用的唯一标识 |
| code | Number | 任务状态码，2 表示任务检测中 |
- 响应示例:
{
"errorCode": 0,
"taskId": "task_**************************",
"code": 2
}
错误码
| 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 | 缺少必需参数，例如 url、strategyId |
| 400 | 2001 | Invalid Parameter | 参数格式错误，例如 url 不是 HTTP/HTTPS 地址、文档类型不支持、文档内容无效，或 strategyId 不存在 |
| 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 | - | - | 请求频率超过限制 |