跳转至

Guide Changes Notice

API 文档更新：聊天 API 指南更新

我更改了API分类并修改了几个字段信息。

http API 更新

  • 添加了消息 API 分类
    • 更改了 API 分类
      • 现有：频道 API > 公告消息发送 API
      • 更改：消息 API > 频道公告消息发送 API
    • 添加了用户公告消息 API
    • 添加了频道自定义消息 API
    • 添加了用户自定义消息 API
    • 添加了频道消息历史检索 API
  • 添加了详细的错误代码
    • 为 HTTP 状态码 400 添加了新代码
      • 400 自定义消息大小超出限制。最大大小为 8,000 字节。: 自定义消息大小超出限制（最大 8,000 字节）
  • 从响应值中移除了 extraData
    • 频道检索 API (response > data > members)
    • 频道参与者检索 API (response > data > members)
  • 添加了 chatHistoryAllowed 消息历史检索可用性
    • 检索整个频道列表的响应值
    • 频道检索的响应值
    • 频道创建的请求值
    • 检索用户参与频道的响应值
  • 修正了拼写错误并更改了描述
    • 检索整个频道列表
      • 更改了查询参数 size 字段的描述
        • 现有：最小 10 ~ 最大 100
        • 更改：最小 1 ~ 最大 10
    • 更改了 timestampMillis 的时间类型
      • 整数 → 长整型
    • 频道入口
      • 更改了请求示例
    • 频道消息历史检索
      • 更改了 API 端点
      • 从路径参数中移除了 Content-Type
    • 频道创建
      • 更改了基于请求数据中 playerId 存在与否的操作指导
    • 频道退出
      • 添加了说明，指出没有参与者且频道所有者不是 SYSTEM 的频道将被定期删除
    • 用户阻止
      • 添加了说明，指出这是限制实时消息发送和接收的功能
    • 频道公告消息
      • 添加了基于请求数据中 channelId 和 langCode 存在与否的操作指导
    • 修订了概述描述
    • 更改了措辞
      • 时间 → 日期
    • 修正了一些间距
    • 更改了类型数组的表示法
      • 示例：array → object array

websocket API 变更

  • 数据包类型
    • 添加了 NOTIFY_NOTICE
  • 客户端连接
    • 更改了请求示例
  • 客户端重新连接
    • 更改了请求示例
  • 通知消息
    • 重命名为用户通知消息
    • 更改了主体 playerId 信息
  • 渠道通知消息
    • 更改了主体 channelId 信息
  • 更改了 extraData 数据传输包
    • 从请求值中移除 extraData
      • CONNECT
      • RECONNECT
    • 将 extraData 添加到请求值中
      • CHANNEL_CHAT
      • DIRECT_CHAT
    • 从响应值中移除 extraData
      • NOTIFY_ENTER_CHANNEL
      • NOTIFY_EXIT_CHANNEL
    • 更改响应键值 (fromExtra → extraData)
      • NOTIFY_CHANNEL_CHAT
      • NOTIFY_DIRECT_CHAT
  • 将 timestampMillis 添加到响应值中
    • NOTIFY_ENTER_CHANNEL
    • NOTIFY_EXIT_CHANNEL
    • NOTIFY_DELETE_CHANNEL
    • NOTIFY_CHANNEL_NOTICE
    • NOTIFY_CHANNEL_CHAT
    • NOTIFY_DIRECT_CHAT
  • 将 langCode 添加到请求值中
    • CONNECT
    • RECONNECT
  • 添加了 Socket 服务器事件消息
    • NOTIFY_NOTICE
  • 移除了不推荐使用的数据包
    • NOTIFY_DISCONNECT

API 文档更新：响应格式和字段变更

API 响应格式已更改，并且添加或删除了多个字段。

API 文档更新

  • 更改 API 响应格式
    • 添加 memberCount 以了解当前连接用户的数量
    • 添加 regTimeMillis 字段（类型：整数）
  • 渠道检索 API
    • 添加 memberCount 字段
    • 添加 regTimeMillis 字段
  • 参与者信息检索 API
    • 添加 connectedTimeMillis 字段
  • 用户参与渠道检索 API
    • 添加 memberCount 字段
  • 当频道所有者退出时，将频道删除更改为频道保留

websocket API 变更

  • 添加了新的重连功能
    • 添加了 RECONNECT 数据包类型
    • 包括重新加入先前频道的能力
  • 修订了套接字断开连接过程的描述
    • 添加了在连接时没有客户端请求的情况处理
    • 如果在已连接的情况下从另一个终端连接，则终止现有连接
    • 移除了 DISCONNECT
  • 修改了套接字通信结构
    • 添加了 correlationId 字段
  • 修订了响应数据包格式和服务器消息数据包格式
    • 添加并详细说明了新的数据包字段内容
    • 分为请求数据包、响应数据包和服务器消息数据包