fresns
  1. 公共业务
fresns
  • 请求标头
  • 通用数据结构
  • 错误码
  • 全局配置
    • 全局配置信息
      GET
    • 状态码信息
      GET
    • 扩展档案配置
      GET
    • 上传用的令牌
      GET
    • 用户角色
      GET
    • 地图服务商
      GET
    • 内容类型
      GET
    • 表情图
      GET
    • 阻止词
      GET
  • 公共业务
    • 输入提示信息
      GET
    • 回调返参查询
      GET
    • 发送验证码
      POST
    • 上传日志
      POST
    • 上传文件
      POST
    • 文件下载链接
      GET
    • 下载过文件的用户
      GET
  • 账号
    • 注册
      POST
    • 登录
      POST
    • 重置密码
      PUT
    • 获取账号详情
      GET
    • 钱包交易记录
      GET
    • 身份验证
      POST
    • 修改账号资料
      PUT
    • 退出登录
      DELETE
    • 申请删除账号
      POST
    • 撤销删除申请
      POST
  • 用户
    • 获取用户列表
    • 获取用户详情
    • 获取用户认识的关注者
    • 获取用户互动的用户列表
    • 获取用户标记的内容列表
    • 用户登录
    • 用户面板
    • 修改用户资料
    • 操作标记
    • 标记备注
  • 消息
    • [通知]获取消息列表
    • [通知]更新阅读状态
    • [通知]删除消息
    • [对话]获取对话列表
    • [对话]获取对话详情
    • [对话]获取消息列表
    • [对话]置顶对话
    • [对话]更新阅读状态
    • [对话]发送消息
    • [对话]删除对话或对话的消息
  • 小组
    • 获取树结构小组列表
    • 获取小组分类
    • 获取小组列表
    • 获取小组详情
    • 获取小组互动的用户列表
  • 话题
    • 获取话题列表
    • 获取话题详情
    • 获取话题互动的用户列表
  • 帖子
    • 获取帖子列表
    • 获取关注对象的帖子列表
    • 获取位置附近的帖子列表
    • 获取帖子详情
    • 获取帖子互动的用户列表
    • 获取帖子的附属用户列表
    • 获取帖子的日志列表
    • 获取帖子日志详情
    • 删除帖子
  • 评论
    • 获取评论列表
    • 获取关注对象的评论列表
    • 获取位置附近的评论列表
    • 获取评论详情
    • 获取评论互动的用户列表
    • 获取评论的日志列表
    • 获取评论日志详情
    • 删除评论
  • 编辑器
    • 快速发表(帖子)
    • 快速发表(评论)
    • 编辑器配置信息
    • 获取草稿列表(帖子)
    • 获取草稿列表(评论)
    • 创建草稿(帖子)
    • 创建草稿(评论)
    • 生成编辑草稿(帖子)
    • 生成编辑草稿(评论)
    • 获取草稿详情(帖子)
    • 获取草稿详情(评论)
    • 更新草稿内容(帖子)
    • 更新草稿内容(评论)
    • 提交发表(或审核)
    • 撤回审核中草稿
    • 删除草稿
  • 搜索
    • 用户
    • 小组
    • 话题
    • 帖子
    • 评论
  1. 公共业务

上传文件

开发中
POST
http://localhost:8080/api/v2/common/upload-file

请求参数

Header 参数
X-Fresns-App-Id
string 
必需
密钥 App ID
密钥位置:控制面板->应用中心->应用密钥
默认值:
{{appId}}
X-Fresns-Client-Platform-Id
integer 
必需
平台编号,与密钥的「平台」匹配
默认值:
{{clientPlatformId}}
X-Fresns-Client-Version
string 
必需
你的客户端版本号,推荐使用语义化版本号
默认值:
{{clientVersion}}
X-Fresns-Client-Device-Info
string 
必需
交互设备信息 session_logs > device_info
压缩 Object 信息为字符串传参
默认值:
{{clientDeviceInfo}}
X-Fresns-Aid
string 
可选
账号参数(留空则视为未登录账号)
默认值:
{{aid}}
X-Fresns-Aid-Token
string 
可选
账号身份凭证(传参 aid 时必传)
默认值:
{{aidToken}}
X-Fresns-Uid
integer 
可选
用户参数(留空则视为未登录用户)
默认值:
{{uid}}
X-Fresns-Uid-Token
string 
可选
用户身份凭证(传参 uid 时必传)
默认值:
{{uidToken}}
X-Fresns-Signature
string 
签名
必需
X-Fresns-Signature-Timestamp
string 
必需
签名生成时间(当前 Unix 时间戳,精确到秒或毫秒都支持)
Body 参数multipart/form-data
tableName
string 
必需
来源表名
users /api/v2/user/edit
posts
comments
conversation_messages /api/v2/conversation/send-message
post_logs /api/v2/editor/{type}/{draftId}
comment_logs /api/v2/editor/{type}/{draftId}
tableColumn
string 
必需
来源字段名,默认填参 id
tableId
string 
来源表主键 ID
可选
tableKey
string 
来源表键名
可选
type
string 
必需
四选一 image,video,audio,document
uploadMode
string 
必需
二选一
file 上传文件
fileInfo 上传文件信息
fileInfo
array[string]
可选
uploadMode=fileInfo 专用,上传文件信息数组
示例值:
[""]
moreJson
array[string]
可选
uploadMode=file 专用,可选
file
file 
可选
uploadMode=file 专用,上传文件

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://localhost:8080/api/v2/common/upload-file' \
--header 'X-Fresns-App-Id;' \
--header 'X-Fresns-Client-Platform-Id;' \
--header 'X-Fresns-Client-Version;' \
--header 'X-Fresns-Client-Device-Info;' \
--header 'X-Fresns-Aid: ' \
--header 'X-Fresns-Aid-Token: ' \
--header 'X-Fresns-Uid: ' \
--header 'X-Fresns-Uid-Token: ' \
--header 'X-Fresns-Signature;' \
--header 'X-Fresns-Signature-Timestamp;' \
--form 'tableName=""' \
--form 'tableColumn=""' \
--form 'tableId=""' \
--form 'tableKey=""' \
--form 'type=""' \
--form 'uploadMode=""' \
--form 'fileInfo=""' \
--form 'moreJson=""' \
--form 'file=@""'

返回响应

🟢200uploadMode = file
application/json
Body
来源表名 users /api/v2/user/edit posts comments conversation_messages /api/v2/conversation/send-message post_logs /api/v2/editor/{type}/{draftId} comment_logs /api/v2/editor/{type}/{draftId}
code
integer 
必需
message
string 
必需
data
object 
必需
fid
string 
文件 fid
可选
type
number 
可选
文件类型编号 1.图片 2.视频 3.音频 4.文档
status
boolean 
是否有效
可选
substitutionImageUrl
string 
文件无效提示图
可选
sensitive
boolean 
是否为敏感文件
可选
name
string 
完整原始名称
可选
mime
string 
文件扩展名
可选
extension
string 
文件后缀名
可选
size
string 
大小
可选
md5
string 
文件 md5 编码
可选
sha
string 
文件 sha 编码
可选
shaType
string 
文件 sha 类型
可选
moreJson
object  | null 
可选
imageWidth
number 
图片宽度
可选
imageHeight
number 
图片高度
可选
imageLong
boolean 
是否长图
可选
imageConfigUrl
string 
配置用途图片地址
可选
imageRatioUrl
string 
等比例缩略图地址
可选
imageSquareUrl
string 
正方形缩略图地址
可选
imageBigUrl
string 
原图压缩图地址
可选
videoTime
number 
视频时长
可选
videoPosterUrl
string 
视频封面图链接
可选
videoUrl
string 
视频链接
可选
audioTime
number 
音频时长
可选
audioUrl
string 
音频链接
可选
documentPreviewUrl
string 
文件预览链接
可选
transcodingState
number 
可选
音视频转码状态 1.待转码 2.转码中 3.转码完成 4.转码失败
示例
{
    "code": 0,
    "message": "string",
    "data": {
        "fid": "string",
        "type": 0,
        "status": true,
        "substitutionImageUrl": "string",
        "sensitive": true,
        "name": "string",
        "mime": "string",
        "extension": "string",
        "size": "string",
        "md5": "string",
        "sha": "string",
        "shaType": "string",
        "moreJson": {},
        "imageWidth": 0,
        "imageHeight": 0,
        "imageLong": true,
        "imageConfigUrl": "string",
        "imageRatioUrl": "string",
        "imageSquareUrl": "string",
        "imageBigUrl": "string",
        "videoTime": 0,
        "videoPosterUrl": "string",
        "videoUrl": "string",
        "audioTime": 0,
        "audioUrl": "string",
        "documentPreviewUrl": "string",
        "transcodingState": 0
    }
}
🟢200uploadMode = fileInfo
上一页
上传日志
下一页
文件下载链接
Built with