# 文件操作

为了方便业务系统把相关的文件上传到U聊系统,u聊开放了文件上传下载的接口。

# API详情

# 文件上传接口

接入系统消息将文件数据传送到U聊服务器,以便后续发送文件消息,或者富文本消息时引用。

  • 提供方:U聊服务端
  • 发起方:接入系统

# 请求地址

/upchat-public-gateway/api/app/upload
  • 调用方式:HTTP POST
  • 请求格式:multipart/form-data
  • 请求编码:UTF-8

# 请求参数

属性 说明
apikey 消息发送凭据
uploadtype 文件类型
files 多个文件数据数组

# 参数详细说明:

  • uploadtype
    取值 说明
    image 图片
    audio 音频
    video 视频(客户端暂不支持)
    excel excel文件
    word word文件
    ppt powerpoint文件
    pdf pdf文件

# 响应

  • 响应格式:application/json;charset=UTF-8

  • 响应编码:UTF-8

  • 返回值:

    属性 说明
    status 应答码,0表示成功,非0时异常信息见msg
    msg 异常信息
    files 文件id数组
  • 响应实例

{    "status":"0",
      "msg":"成功",
      "files":[
          {"fileid":"000000004691712x014691f9c084000a", key:"xxxxxx"},
          {"fileid":"0000000042911a63014691f9c084000a", key:"xxxxxx"},
          {"fileid":"00000000429141a3014691f9c083000a", key:"xxxxxx"}
      ]
  }

# 文件下载接口

接入系统消息将文件fileid传送到U聊服务器,下载u聊服务器上的文件。

  • 提供方:U聊服务端
  • 发起方:接入系统

# 请求地址

/upchat-public-gateway/api/app/file/{fileid}
  • 调用方式:HTTP POST
  • 请求格式:application/x-www-form-urlencoded;charset=utf-8
  • 请求编码:UTF-8

# 请求参数

属性 说明
fileid 文件标识
apikey 登陆标识
filesize 文件尺寸: 1-min, 2-中图,3-其他, 原图

# 响应

  • 响应格式:application/json;charset=UTF-8
  • 响应编码:UTF-8
  • 返回值:
    属性 说明
    resp 文件数据http应答
上次更新: 3/10/2021, 5:46:24 PM