文档首页/云客服/API参考/Adapter类接口参考/接口说明/数据访问接口/WEB渠道/下载文档类型的资源信息
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

下载文档类型的资源信息

接口功能

根据文件标识下载文档类型的资源信息

使用说明

  • 前提条件

    正确创建web渠道配置。

接口原型

表1 接口原型说明

请求方法

POST

请求URL

https://ip:port/service-cloud/rest/webadapter/v1/webadapterfacade/downloadDocument

其中，ip:port为对外暴露的nslb的ip和port

表2 请求Headers参数说明

参数名称

选取原则

参数类型

默认值

说明

Content-Type

必选

String

无

固定填 application/json; charset=UTF-8。

Cookie

必选

String

无

集成页面的时候，ccmessaging通过请求响应，将ccmessaging-token写到集成页面浏览器的Cookie中。单独调用时需确保请求头的Cookie中含有ccmessaging-token=xxx，xxx为ccmessaging-token值。

请求参数

参数名称

选取原则

参数类型

说明

messageCode

必选

String

文档消息对应的消息码

fileSuffix

必选

String

文件后缀（类型），可以是pdf、doc、docx、zip、gif

响应参数

参数名称

选取原则

参数类型

说明

resultCode

必选

String

接口返回码。0为成功，2为入参无效，13为下载失败

resultDesc

可选

String

接口返回失败时的错误描述

fileStream

可选

String

接口返回成功时，对应文档类型多媒体资源的二进制流

接口示例

  • 请求示例 
    POST /service-cloud/rest/webadapter/v1/webadapterfacade/downloadDocument

host: 10.10.10.2:18446
connection: Keep-Alive
x-forwarded-for: 10.10.10.3, 10.10.10.4
x-real-ip: 10.10.10.5
content-length: 401
remote-host: 10.10.10.6
user-agent: java/socket
content-type: application/json; charset=utf-8
cookie: JSESSION*****#*#*****3
ccmessaging-token：********
accept: */*

{
    "messageCode": "b1060006-15c6-4a15-aea1-b310198e3e89",
    "fileSuffix": "zip"
}
  • 响应示例 
    {
    "resultCode": "0",
    "fileStream": "XXXXXXXX"
}
父主题：WEB渠道