全量消息路由
全量消息路由服务支持将单聊、群组、超级群、聊天室、讨论组(废弃)、客服(废弃)的消息数据同步到指定的应用服务器。当接收到的消息为图片、视频类消息时,如果需要获取图片、视频等文件信息,可通过地址进行下载,文件存储有效期为 6 个月。
适用场景举例:
- 存储聊天记录:可通过开启此服务,实时同步用户发送的消息至应用服务器,由应用服务器进行存储。
- 数据迁移:实现从第三方通讯云服务的平滑迁移,您的新客户端(集成客户端 SDK)向老客户端(即集成原第三方 SDK) 发送消息时,服务端会通过消息路由服务调用原第三方的相应服务端接口,实现向指定老客户端(即集成原第三方 SDK)用户发送消息。详细请查看平滑迁移。
开通服务
使用全量消息路由功能前,请确认已为当前 App Key 开通相关服务。详见消息管理服务配置。
开通服务时,请配置可正常访问的回调接收地址。如果您的网络有 IP 访问限制,请务必配置 IP 白名单,否则无法正常接收服务端回调。
限制与注意事项说明
-
消息中包含敏感词:
- 内置敏感词服务与第三方审核服务(如数美)可设置用于屏蔽消息的敏感词。如果消息因包含此类敏感词导致不下发给收件人,服务端默认也不会将该消息同步到应用服务器。如需将含有屏蔽敏感词的消息也路由到应用服务器,可在融云控制台的免费基础功能界面开通含敏感词消息开启路由功能。
- 如果在内置敏感词服务的配置中设置了替换敏感词,会将消息中的敏感词替换成设置的内容再同步到应用服务器。如需获取原始内容,可参考知识 库使用内置敏感词、IM 内容审核、消息回调服务时,如何获取消息原始内容?。
-
Server API 发送的消息默认不进行消息路由:
- 通过调用 Server API 接口发送的消息,默认不会通过消息路由服务。如需修改默认行为,请在控制台免费基础功能页面开通 Server API 发送消息实时路由服务。
-
单聊状态消息默认不进行消息路由:单聊会话中的状态类消息,默认不会被同步到应用服务器。包含以下情况:
- 客户端自动往单聊会话中发送即时通讯服务预定义的状态类消息,例如“正在输入状态”消息,详见消息类型概述。
- 客户端主动调用发送消息接口发送状态类消息,包括即时通讯服务预定义的状态类消息或客户自定义的状态消息。
- 通过调用 Server API 接口发送单聊状态消息发送的任何消息。
- 如果需要上述状态类消息启用消息路由,可在融云控制台,通过应用配置>IM 服务>免费基础功能>单群聊,开通单聊状态消息消息路由功能。注意,如果客户端使用了单聊会话「正在输入的状态」功能,该正在输入的状态消息也会进行路由和消息日志存储,消息量较大请谨慎开通。如果未开通 Server API 发送消息实时路由服 务,则仅对客户端发送的状态类消息启用全量消息路由。
-
始终不支持进行消息路由的情况:无论是否开通 Server API 发送消息实时路由服务,以下接口发送的消息始终不支持进行消息路由:
-
单群聊消息扩展变更会进行全量消息路由:
- 如果变更单群聊消息扩展,服务端会生成一条类型为
RC:MsgExMsg
的消息。新消息仅用于消息路由同步,不会同步给客户端 SDK。新消息 ID 由服务端生成,originalMsgUID
字段中会携带原消息的MsgUID
。 - 注意,在发消息时即携带的扩展数据无法通过全量消息路由获取。
- 如果变更单群聊消息扩展,服务端会生成一条类型为
-
超级群消息扩展变更默认不支持全量消息路由:
- 2022.08.11 之后,超级群业务中对消息扩展的变更操作可以同步到您指定的应用服务器。考虑到消息扩展频率较大,可能产生大量消息,因此即时通讯服务端默认不进行全量消息路由。如有需要,请提交工单