OpenMax
免费试用

编辑与修订历史

toEditMessageContent、toMessageEdits:编辑接口的请求体和修订历史的转换。

编辑与修订历史

适配器的 messaging 对已有消息动手(表态、编辑、撤回)、取修订历史和改动日志时打哪些接口,实时帧怎么翻成信号,以及两个可复用的转换函数。自己写宿主接 OpenMax 时用这两个函数,发出去的与 SDK 逐字相同。状态和全部导出的索引见概览。

消息接口

成员 接口 失败时
addReaction、removeReaction POST /api/v1/messages/{id}/reactions、DELETE /api/v1/messages/{id}/reactions/{code} 412、403 抛 kind 为 forbidden 的 ChatSdkRequestError(isChatOperationNotAllowed() 认得),其他按状态推出种类
editMessage PUT /api/v1/messages/{id},请求体由 toEditMessageContent 造 同上
recallMessage DELETE /api/v1/messages/{id} 同上
listMessageEdits GET /api/v1/messages/{id}/edits,经 toMessageEdits 转 抛 ChatSdkRequestError
loadMessage GET /api/v1/conversations/{cid}/messages/{mid},正文与附件取自详情里的 content 404、403 返回 undefined
loadChangesSince GET /api/v1/conversations/{cid}/changes?since_change_seq=&limit=500,一次一页 抛 ChatSdkRequestError(含 404:后端还没有这条路由),这次补改动静默放弃
getMessagesByIds POST /api/v1/conversations/{cid}/messages/batch-get { message_ids } 抛 ChatSdkRequestError;断网、超时、429、502–504(retryable 为真)时聊天退避 1 秒、2 秒后重发同一批,最多发 3 次,都没成时这次补改动静默放弃;401 等不重发
loadReadCursors GET /api/v1/conversations/{cid}/read-cursors,member_id、last_read_seq、last_ack_seq、member_count、truncated 换成契约字段 412(这条会话的回执关闭)、403 时 reject kind 为 forbidden 的 ChatSdkRequestError,不返回空快照

四个写方法成功时返回 { changeSeq }(响应里有 change_seq 时),编辑另带 editedAt(ISO 串)。 loadThread 与 loadThreadSince 把列表响应的 head_change_seq 交成 headChangeSeq(响应里没有时不给),聊天据此从改动日志补回离开期间别人对已有消息的改动。 loadReadCursors 被拒时,消息区把这条会话当成没有回执,一个回执都不画,也不提示。返回空快照则会画成「谁都没读」的单勾,所以取不到时要 reject。

实时帧

帧 信号
message、sync messages:只带会话 id,正文由 SDK 补拉
system message.reaction.added、message.reaction.removed reaction:哪条消息、谁、哪个表情、加还是减
system message.updated、message.recalled、message.deleted、card.interaction.recorded messageChanged,change 分别是 edited、recalled、deleted、card;缺 message_id 的帧丢掉
read_state_update、delivery_state_update read、delivery

帧的 change_seq 是非负整数(数字或数字串)时作为 changeSeq 带上;旧服务端的帧没有它,就不带。message.updated 不带正文,消息区收到后用 loadMessage 再取一次。

toEditMessageContent

function toEditMessageContent(edit: ChatMessageEditInput): OpenMaxEditMessageBody;

编辑接口(PUT /api/v1/messages/{id})的请求体:

  • 一个附件都不剩:content_type: "text"、body: { text }、attachments 为空。
  • 还有附件:全是图片时 "image",否则 "file"(图和文件混着也是 "file");body.file_name 取第一项,正文非空才带 text。附件是全量替换,按显示序原样放进去,不重排。
  • 不带 type、fallback_text:消息的 type 和会话列表的预览文字保持编辑前的值。

OpenMaxEditMessageBody

interface OpenMaxEditMessageBody {
  content: {
    content_type: "text" | "image" | "file";
    body: Record<string, unknown>;
    attachments: ChatAttachment[];
  };
}

toEditMessageContent 的返回值,原样作为编辑接口的请求体。

toMessageEdits

function toMessageEdits(items: readonly OpenMaxMessageEditItem[] | null | undefined): ChatMessageEdit[];

修订历史接口的 items 转成 ChatMessageEdit,顺序原样(旧到新)。毫秒时间转 ISO 串;body.text 是字符串就用它,否则用整个 body 的 JSON。items 为 null 或不给时按空表。

OpenMaxMessageEditItem

interface OpenMaxMessageEditItem {
  id: string;
  created_at: number;
  body?: Record<string, unknown> | null;
}

修订历史接口回来的一项里 toMessageEdits 读的那几格:id、编辑发生的时间 created_at(unix 毫秒)、编辑前那一版的内容体 body。