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

[对话]获取对话详情

开发中
GET
http://localhost:8080/api/v2/conversation/{conversationId}/detail

请求参数

Path 参数
conversationId
string 
对话 ID
必需
Query 参数
whitelistKeys
string 
可选
白名单键名，只返回给定键名的键值对
多个以英文逗号隔开，支持「点表示法」表示多维数组
仅对 user 参数有效
blacklistKeys
string 
可选
黑名单键名，从返回数据中删除指定的键值对
多个以英文逗号隔开，支持「点表示法」表示多维数组
仅对 user 参数有效
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 时间戳，精确到秒或毫秒都支持）

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://localhost:8080/api/v2/conversation//detail?whitelistKeys=&blacklistKeys=' \
--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;'

返回响应

🟢200成功
application/json
Body
id
string 
对话 ID
必需
user
object (User) 
可选
与我对话的用户信息，为空表示用户已注销
fsid
string 
可选
用户标识 ID，uid 或 username
uid
number 
用户 ID
可选
username
string 
用户名
可选
url
string 
用户主页地址
可选
nickname
string 
用户昵称
可选
avatar
string 
头像图
可选
decorate
string 
头像挂件
可选
banner
string 
条幅图
可选
gender
number 
可选
性别 1.未知 2.男 3.女
birthday
string 
生日
可选
bio
string 
简介
可选
bioHtml
string 
可选
简介 HTML 格式
location
string 
位置
可选
conversationLimit
number 
可选
对话设置，1.允许所有用户 2.仅允许我关注的用户 3.我关注的用户和已认证的用户 4.不允许所有用户
commentLimit
number 
可选
评论设置，1.允许所有用户 2.仅允许我关注的用户 3.我关注的用户和已认证的用户 4.不允许所有用户
timezone
string 
可选
自定义 UTC 时区
verifiedStatus
boolean 
是否认证
可选
verifiedIcon
string 
自定义认证图标
可选
verifiedDesc
string 
认证介绍
可选
verifiedDateTime
string 
认证时间
可选
expired
boolean 
可选
用户是否过期，公开模式始终为 false
expiryDateTime
string 
用户过期时间
可选
lastPublishPost
string 
最后发帖时间
可选
lastPublishComment
string 
最后评论时间
可选
lastEditUsername
string 
最后修改用户名时间
可选
lastEditNickname
string 
最后修改昵称时间
可选
registerDate
string 
注册日期
可选
hasPassword
boolean 
是否有密码
可选
rankState
number 
等级状态
可选
status
boolean 
用户状态
可选
waitDelete
boolean 
是否待删除
可选
waitDeleteDateTime
string 
准备删除时间
可选
nicknameColor
string 
主角色-昵称颜色
可选
rid
number 
主角色-角色 ID
可选
roleName
string 
主角色-角色名
可选
roleNameDisplay
boolean 
可选
主角色-是否显示角色名
roleIcon
string 
可选
主角色-角色图标地址
roleIconDisplay
boolean 
可选
主角色-是否显示角色图标
roleExpiryDateTime
string 
可选
主角色-角色过期日期
roleRankState
number 
等级状态
可选
rolePermissions
object 
必需
Object 角色权限 数据表 roles->permissions
roleStatus
boolean 
主角色-是否有效
可选
stats
object 
必需
archives
array[object (ExtendParam) {4}] 
必需
operations
object (ExtendInfo) 
必需
extends
object (ExtendContent) 
必需
roles
array[object (Role) {9}] 
必需
interaction
object (UserInteraction) 
必需
conversation
object (UserConversation) 
必需
messageCount
number 
全部消息数
必需
unreadCount
number 
对话框未读消息数
必需
示例
{
    "code": 0,
    "message": "ok",
    "data": {
        "id": "Number / 对话 ID",
        "user": {
            // 与我对话的用户信息，为空表示用户已注销
            // 通用数据结构->用户信息
        },
        "messageCount": "Number / 全部消息数",
        "unreadCount": "Number / 对话框未读消息数"
    }
}
修改于 2023-03-28 07:32:48
上一页
[对话]获取对话列表
下一页
[对话]获取消息列表
Built with