浏览 平台 API
服务端 API

概述

复制

消息模块用于让业务服务端通过 Platform API 写入和管理消息。除普通消息发送、批量发送和业务通知外,还提供消息内容处理、流式消息、未读数与已读状态维护等商业版扩展能力。

能力范围

能力说明
发送消息向单聊或群聊会话写入一条消息,可指定发送者、目标会话、内容类型、推送参数和发送时间。
批量发送向多个用户发送同一条消息,或面向全量用户下发低频系统通知。
业务通知让外部业务服务通过 OpenIM 向单聊或群聊客户端实时传递自定义业务事件,由客户端 OnRecvCustomBusinessMessage 回调处理;可选择是否同时产生会话消息,并设置通知可靠性等级。
消息管理按会话 ID 和消息 Seq 撤回已发送消息,并向相关用户同步撤回事件。
时间同步获取消息服务端当前时间,用于发送时间、迁移导入和业务日志对齐。
消息修改 商业版修改指定消息的内容或扩展字段,并向相关客户端同步变更。
内容处理 商业版调用服务端文本翻译能力处理消息或业务文本。
流式消息 商业版创建流式消息并持续追加内容,适用于 AI 回复等渐进式生成场景。
未读数管理 商业版查询、清除或重置指定用户会话的未读数。
已读状态 商业版将用户的指定会话标记为已读。

常用接口

枚举

ContentType

contentType 决定 content 的 JSON 结构。完整的消息类型、字段和示例见消息内容类型

SessionType

消息中的 sessionType 与会话模块的 ConversationType 使用相同取值,详见会话模块的 ConversationType

MsgFrom

名称说明
100UserMsgType用户消息。
200SysMsgType系统消息。

MessageStatus

名称说明
1MsgNormal正常消息。
4MsgDeleted已删除消息。

接入建议

后端发送消息前,应确认发送身份、目标用户或群组、消息内容类型和推送参数都来自可信业务流程。普通用户聊天消息通常由客户端 SDK 按登录用户身份发送,Platform API 更适合系统消息、运营通知、迁移导入和后台管理场景。

导入历史消息时,可以在发送接口中指定 sendTime 保留原始时间。建议先完成用户、群组和好友关系导入,再按会话维度有序写入消息,避免客户端时间线出现跳变。

相关页面