Skip to content

下载报告 ​

接口概述 ​

按指定格式获取任务的报告文件地址,支持一次请求多种报告格式。

请求地址 ​

http
POST /loadDownReport

请求头 ​

参数必填说明
apiKey是API 访问凭证
Platform是平台标识,取值参见快速开始
Content-Type是application/json

请求参数 ​

参数类型必填说明
taskIdString是任务 ID
reportFormatListArray是报告格式列表,取值参见报告格式,如 ["WORD"]、["PDF"]

请求示例 ​

bash
curl -X POST "https://openapi.bangtu-ai.com/openApi/loadDownReport" \
  -H "apiKey: YOUR_API_KEY" \
  -H "Platform: INSPECTOR" \
  -H "Content-Type: application/json" \
  -d '{
    "taskId": "1900789012345678901",
    "reportFormatList": ["WORD", "PDF"]
  }'

返回结果 ​

json
{
  "code": 200,
  "message": "success",
  "data": "openApi/report/1900789012345678901.docx",
  "timestamp": 1784533680000
}

返回字段 ​

字段类型说明
codeNumber通用响应码,200 表示成功
messageString响应信息
dataString | null报告文件地址
timestampNumber服务端响应时间戳,单位为毫秒

响应码 ​

code说明
200请求成功
500请求失败,具体原因见 message

注意事项 ​

  • taskId 与 reportFormatList 均为必填,缺失时返回参数校验失败。
  • 报告下载次数会计入任务的 downloadNum 字段。
  • 返回的文件地址需配合文件下载接口获取文件流。
  • 若报告被锁定,需先调用发布报告或生成报告解锁。