Class V2TIMMessageManager

1.1 添加高级消息的事件监听器

1.2 移除高级消息监听器

2.1 创建文本消息

2.2 创建文本消息，并且可以附带 @ 提醒功能（该接口已弃用，推荐使用 CreateAtSignedGroupMessage 接口）

提醒消息仅适用于在群组中发送的消息

Note

atUserList 使用注意事项

• 默认情况下，最多支持 @ 30个用户，超过限制后，消息会发送失败。
• atUserList 的总数不能超过默认最大数，包括 @ALL。
• 直播群（AVChatRoom）不支持发送 @ 消息。

2.4 创建自定义消息

2.5 创建图片消息（图片最大支持 28 MB）

2.6 创建语音消息（语音最大支持 28 MB）

2.7 创建视频消息（视频最大支持 100 MB）

2.8 创建文件消息（文件最大支持 100 MB）

2.9 创建地理位置消息

2.10 创建表情消息

SDK 并不提供表情包，如果开发者有表情包，可使用 index 存储表情在表情包中的索引， 或者直接使用 data 存储表情二进制信息以及字符串 key，都由用户自定义，SDK 内部只做透传。

2.11 创建合并消息（5.2.210 及以上版本支持）

我们在收到一条合并消息的时候，通常会在聊天界面这样显示：

|vinson 和 lynx 的聊天记录 | -- title （标题）

|vinson：新版本 SDK 计划什么时候上线呢？ | -- abstract1 （摘要信息1）

|lynx：计划下周一，具体时间要看下这两天的系统测试情况..| -- abstract2 （摘要信息2）

|vinson：好的. | -- abstract3 （摘要信息3）

聊天界面通常只会展示合并消息的标题和摘要信息，完整的转发消息列表，需要用户主动点击转发消息 UI 后再获取。

多条被转发的消息可以被创建成一条合并消息 V2TIMMessage，然后调用 SendMessage 接口发送，实现步骤如下：

1. 调用 CreateMergerMessage 创建一条合并消息 V2TIMMessage。

2. 调用 SendMessage 发送转发消息 V2TIMMessage。

收到合并消息解析步骤：

1. 通过 V2TIMMessage 获取 mergerElem。

2. 通过 mergerElem 获取 title 和 abstractList UI 展示。

3. 当用户点击摘要信息 UI 的时候，调用 DownloadMessageList 接口获取转发消息列表。

2.12 创建转发消息（5.2.210 及以上版本支持）

如果需要转发一条消息，不能直接调用 SendMessage 接口发送原消息，需要先 CreateForwardMessage 创建一条转发消息再发送。

2.13 创建定向群消息（6.0 及以上版本支持）

如果您需要在群内给指定群成员列表发消息，可以创建一条定向群消息，定向群消息只有指定群成员才能收到。

Note

• 原始消息对象不支持群 @ 消息。
• 消息接收者列表最大支持 50 个。
• 社群（Community）和直播群（AVChatRoom）不支持发送定向群消息。
• 定向群消息默认不计入群会话的未读计数。

2.14 创建带 @ 标记的群消息（7.0 及以上版本支持）

如果您需要发送的群消息附带 @ 提醒功能，可以创建一条带 @ 标记的群消息。

Note

atUserList 使用注意事项

• 默认情况下，最多支持 @ 30个用户，超过限制后，消息会发送失败。
• atUserList 的总数不能超过默认最大数，包括 @ALL。
• 直播群（AVChatRoom）不支持发送 @ 消息。

3.1 发送高级消息（高级版本：可以指定优先级，推送信息等特性）

Note

• 设置 offlinePushInfo 字段，需要先在 V2TIMOfflinePushManager 开启推送，推送开启后，除了自定义消息，其他消息默认都会推送。
• 如果自定义消息也需要推送，请设置 offlinePushInfo 的 desc 字段，设置成功后，推送的时候会默认展示 desc 信息。
• AVChatRoom 群聊不支持 onlineUserOnly 字段，如果是 AVChatRoom 请将该字段设置为 false。
• 如果设置 onlineUserOnly 为 true 时，该消息为在线消息且不会被计入未读计数。

4.1 设置针对某个用户的 C2C 消息接收选项（支持批量设置）

5.3.425 及以上版本支持

Note

• 该接口支持批量设置，您可以通过参数 userIDList 设置一批用户，但一次最大允许设置 30 个用户。
• 该接口调用频率被限制为1秒内最多调用5次。

4.2 查询针对某个用户的 C2C 消息接收选项

5.3.425 及以上版本支持

4.3 设置群消息的接收选项

4.4 设置全局消息接收选项，从 7.4 版本开始支持。

Note

• 当 duration 的取值小于 246060 时，可用于实现重复免打扰，即消息免打扰从每天的 startHour:startMinute:startSecond 表示的时间点开始，持续时长为 druation 秒
• 当 duration 取值不小于 246060 时，可用于实现永久免打扰，即从调用该 API 当天 startHour:startMinute:startSecond 表示的时间点开始永久消息免打扰

4.5 设置全局消息接收选项，从 7.4 版本开始支持。

4.5 获取登录用户全局消息接收选项，从 7.4 版本开始支持

5.1 获取历史消息高级接口

Note

• 如果没有触发登录，调用该接口不会返回历史消息
• 如果登录失败，调用该接口会返回本地历史消息
• 如果 SDK 检测到没有网络，调用该接口会返回本地历史消息
• 如果登录成功且网络正常，当 option 设置为拉取云端历史消息，调用该接口会先请求云端历史消息，然后再和本地历史消息合并后返回
• 只有会议群（Meeting）才能拉取到进群前的历史消息，直播群（AVChatRoom）消息不存漫游和本地数据库，调用这个接口无效

5.2 撤回消息

Note

• 撤回消息的时间限制默认 2 minutes，超过 2 minutes 的消息不能撤回，您也可以在 控制台（功能配置 -> 登录与消息 -> 消息撤回设置）自定义撤回时间限制。
• 仅支持单聊和群组中发送的普通消息，无法撤销 onlineUserOnly 为 true 即仅在线用户才能收到的消息，也无法撤销直播群（AVChatRoom）中的消息。
• 如果发送方撤回消息，已经收到消息的一方会收到 V2TIMAdvancedMsgListener::OnRecvMessageRevoked 回调。
• 从 IMSDK 7.4 版本开始，支持撤回包括直播群（AVChatRoom）、社群在内的所有群类型的消息。
• 在单聊场景中，仅能撤回自己的消息；在群聊场景中，除了可以撤回自己的消息外，管理员或者群主也可以撤回其他群成员的消息。

5.3 消息变更

Note

• 如果消息修改成功，自己和对端用户（C2C）或群组成员（Group）都会收到 OnRecvMessageModified 回调。
• 如果在修改消息过程中，消息已经被其他人修改，callback 会返回 ERR_SDK_MSG_MODIFY_CONFLICT 错误。
• 消息无论修改成功或则失败，callback 都会返回最新的消息对象。

5.4 删除本地消息

Note

该接口只能删除本地历史，消息删除后，SDK 会在本地把这条消息标记为已删除状态，getHistoryMessage 不能再拉取到，如果程序卸载重装，本地会失去对这条消息的删除标记，getHistoryMessage 还能再拉取到该条消息。

5.5 删除本地及云端的消息

Note

该接口删除本地及云端的消息，且无法恢复。需要注意的是：

• 一次最多只能删除 50 条消息
• 要删除的消息必须属于同一会话
• 一秒钟最多只能调用一次该接口
• 如果该账号在其他设备上拉取过这些消息，那么调用该接口删除后，这些消息仍然会保存在那些设备上，即删除消息不支持多端同步。

5.6 清空单聊本地及云端的消息（不删除会话）

5.4.666 及以上版本支持

Note

• 会话内的消息在本地删除的同时，在服务器也会同步删除。

5.7 清空群聊本地及云端的消息（不删除会话）

5.4.666 及以上版本支持

Note

• 会话内的消息在本地删除的同时，在服务器也会同步删除。

5.8 向群组消息列表中添加一条消息

该接口主要用于满足向群组聊天会话中插入一些提示性消息的需求，比如“您已经退出该群”，这类消息有展示 在聊天消息区的需求，但并没有发送给其他人的必要。 所以 InsertGroupMessageToLocalStorage() 相当于一个被禁用了网络发送能力的 SendMessage() 接口。

Note

通过该接口 save 的消息只存本地，程序卸载后会丢失。

5.9 向C2C消息列表中添加一条消息

该接口主要用于满足向C2C聊天会话中插入一些提示性消息的需求，比如“您已成功发送消息”，这类消息有展示 在聊天消息去的需求，但并没有发送给对方的必要。 所以 InsertC2CMessageToLocalStorage()相当于一个被禁用了网络发送能力的 SendMessage() 接口。

Note

通过该接口 save 的消息只存本地，程序卸载后会丢失。

5.10 根据 messageID 查询指定会话中的本地消息，包括状态 status 为 V2TIM_MSG_STATUS_LOCAL_REVOKED（已撤回）和 V2TIM_MSG_STATUS_HAS_DELETED（已删除）的消息

Note

通过 V2TIMMessage 的 status 来区分消息的状态

5.11 搜索本地消息（5.4.666 及以上版本支持，需要您购买旗舰版套餐）

Note

返回的列表不包含消息状态 status 为 V2TIM_MSG_STATUS_LOCAL_REVOKED（已撤回）和 V2TIM_MSG_STATUS_HAS_DELETED（已删除）的消息

5.12 搜索云端消息（7.3 及以上版本支持）

Note

• 该功能为 IM 增值功能，详见价格说明
• 如果您没有开通该服务，调用接口会返回 60020 错误码
• 返回的列表不包含消息状态 status 为 V2TIM_MSG_STATUS_LOCAL_REVOKED（已撤回）和 V2TIM_MSG_STATUS_HAS_DELETED（已删除）的消息

5.13 发送消息已读回执（6.1 及其以上版本支持）

Note

• 该功能为旗舰版功能，购买旗舰版套餐包后可使用，详见价格说明。
• 向群消息发送已读回执，需要您先到控制台打开对应的开关，详情参考文档 群消息已读回执 。
• messageList 里的消息必须在同一个会话中。
• 该接口调用成功后，会话未读数不会变化，消息发送者会收到 onRecvMessageReadReceipts 回调，回调里面会携带消息的最新已读信息。

5.14 获取消息已读回执（6.1 及其以上版本支持）

Note

• 该功能为旗舰版功能，购买旗舰版套餐包后可使用，详见价格说明。
• 获取群消息已读回执，需要您先到控制台打开对应的开关，详情参考文档 群消息已读回执 。
• messageList 里的消息必须在同一个会话中。

5.15 获取群消息已读群成员列表（6.1 及其以上版本支持）

Note

• 该功能为旗舰版功能，购买旗舰版套餐包后可使用，详见价格说明。
• 使用该功能之前，请您先到控制台打开对应的开关，详情参考文档 群消息已读回执 。

5.16 设置消息扩展（6.7 及其以上版本支持，需要您购买旗舰版套餐）

Note

• 扩展 key 最大支持 100 字节，扩展 value 最大支持 1KB，单次最多支持设置 20 个扩展，单条消息最多可设置 300 个扩展。
• 当多个用户同时设置或删除同一个扩展 key 时，只有第一个用户可以执行成功，其它用户会收到 23001 错误码和最新的扩展信息，在收到错误码和扩展信息后，请按需重新发起设置操作。
• 我们强烈建议不同的用户设置不同的扩展 key，这样大部分场景都不会冲突，比如投票、接龙、问卷调查，都可以把自己的 userID 作为扩展 key。

5.17 获取消息扩展（6.7 及其以上版本支持，需要您购买旗舰版套餐）

5.18 删除消息扩展（6.7 及其以上版本支持，需要您购买旗舰版套餐）

Note

• 当多个用户同时设置或删除同一个扩展 key 时，只有第一个用户可以执行成功，其它用户会收到 23001 错误码和最新的扩展信息，在收到错误码和扩展信息后，请按需重新发起删除操作。

5.19 添加消息回应（可以用于实现表情回复）（7.4 及其以上版本支持，需要您购买旗舰版套餐）

表情回应功能是指对某条消息通过表情符号进行互动回应，我们可以看到每种表情的回应人数和回应人列表。

目前常见的消息回应展示方式会有如下两种风格：

风格一：

----------------------------

| lucy, happy birthday! |

----------------------------

| 😄 1 💐 2 👍🏻 10 |

----------------------------

风格二：

------------------------------------------------

| lucy, happy birthday! |

------------------------------------------------

| 😁 bob 💐olivia 🎂david |

| 👍🏻 denny、james、lucy、linda、thomas 等10人 |

------------------------------------------------

当用户点击某个表情后，会跳转到表情回应详情界面：

| 😄 | 💐 | 👍🏻 |

| bob | olivia | lucy |

| ... | ... | denny |

| ... | ... | ... |

用户可以根据某个表情分页拉取使用该表情的用户信息。

您可以基于 SDK API 实现表情回应能力:

1、调用 AddMessageReaction 接口为一条消息添加一个 emoji，添加成功后，emoji 下就会存储当前操作用户。

2、调用 RemoveMessageReaction 接口删除已经添加的 emoji，删除成功后，emoji 下就不再存储当前操作用户。

3、调用 GetMessageReactions 接口批量拉取多条消息的 emoji 列表，其中每个 emoji 都包含了当前使用者总人数以及前 N（默认 10）个使用者用户资料。

4、调用 GetAllUserListOfMessageReaction 接口分页拉取消息 emoji 的全量使用者用户资料。

5、监听 onRecvMessageReactionsChanged 回调，感知 emoji 的使用者信息变更，该回调会携带 emoji 最新的使用者信息（包含使用者总人数以及前 N 个使用者用户资料）。

Note

• 该功能为旗舰版功能，需要您购买旗舰版套餐。
• 如果单条消息 Reaction 数量超过最大限制，调用接口会报 ERR_SVR_MSG_REACTION_COUNT_LIMIT 错误。
• 如果单个 Reaction 用户数量超过最大限制，调用接口会报 ERR_SVR_MSG_REACTION_USER_COUNT_LIMIT 错误。
• 如果 Reaction 已经包含当前用户，调用接口会报 ERR_SVR_MSG_REACTION_ALREADY_CONTAIN_USER 错误。

5.20 删除消息回应（7.4 及其以上版本支持，需要您购买旗舰版套餐）

Note

• 如果 Reaction 不存在，调用接口会报 ERR_SVR_MSG_REACTION_NOT_EXISTS 错误。
• 如果 Reaction 不包含当前用户，调用接口会报 ERR_SVR_MSG_REACTION_NOT_CONTAIN_USER 错误。

5.21 批量拉取多条消息回应信息（7.4 及其以上版本支持，需要您购买旗舰版套餐）

5.22 分页拉取使用指定消息回应用户信息（7.4 及其以上版本支持，需要您购买旗舰版套餐）

5.23 翻译文本消息

5.24 设置群消息置顶（7.9 及以上版本支持，需要您购买旗舰版套餐）

Note

• 此接口用于置顶和取消置顶对应的群消息，如果置顶消息数量超出限制sdk会返回错误码10070。

5.25 获取已置顶的群消息列表（7.9 及以上版本支持，需要您购买旗舰版套餐）

Note

• 此接口用于获取置顶消息列表，如果置顶消息已过期不会返回