API 文件更新:聊天 API 指南更新¶
我更改了API分类并修改了几个字段信息。
http API 更新¶
- 添加消息 API 分类
- 更改 API 分类
- 现有:频道 API > 公告消息发送 API
- 更改:消息 API > 频道公告消息发送 API
- 添加用户公告消息 API
- 添加频道自定义消息 API
- 添加用户自定义消息 API
- 添加频道消息历史检索 API
- 更改 API 分类
- 添加详细错误代码
- 为 HTTP 状态代码 400 添加新代码
400 自定义消息大小超出限制。最大大小为 8,000 字节。
: 自定义消息大小超出限制(最大 8,000 字节)
- 为 HTTP 状态代码 400 添加新代码
- 从响应值中移除
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