跳到主要内容

单群聊消息扩展概述

单/群聊消息扩展功能可用于为原始消息增加状态标识(扩展数据为 KV 键值对),提供添加、删除、查询扩展信息的接口。

适用场景

对单聊、群聊会话中的原始消息增加状态标识的业务场景均可使用消息扩展。以下是业务场景示例:

  • 消息评论。可通过设置原始消息扩展信息的方式添加评论信息。
  • 礼物领取、订单状态变化。通过此功能可改变消息显示状态。例如:向用户发送礼物,默认为未领取状态,用户点击后可设置消息扩展为已领取状态。
提示

单/群聊消息扩展接口仅支持单聊、群聊会话类型。

  • 聊天室业务不支持消息扩展功能,您无法在聊天室中使用消息扩展。
  • 超级群业务已支持消息扩展功能,并提供 Server API。请另行参见设置超级群消息扩展

长期存储消息扩展数据

消息扩展操作实际上是通过一条特殊的消息实现的,可认为是“扩展操作消息”。如需保证在长期不登录客户端等情况下仍可获取扩展操作消息,建议同时在 IM 服务管理页面开通单群聊消息云端存储功能。

单群聊消息云端存储功能可保证发送者可在长期不登录客户端、或本地不存储消息等情况下仍可获取到历史消息(包括扩展操作消息)。

  • 未开通时,即时通讯服务端默认会保存 7 天的离线消息,供客户端再次上线时收取。例如,假设原始消息已存储在本地,并且离线期间原始消息已经过多次扩展操作,那么客户端再次上线可收取 7 天内的扩展操作消息。注意,客户端无法收取早于 7 天的扩展操作消息。
  • 开通后,消息将存入服务端历史消息库,默认保存 6 个月。长时间未收取的消息、本地已删除的消息均可通过客户端 SDK 的从服务端拉取历史消息的接口获取。

前往控制台开通单群聊消息云端存储。生产环境下,IM 旗舰版IM 尊享版可开通该服务。具体功能与费用以官方价格说明页面及计费说明文档为准。