定向消息

功能说明

发送定向消息是指向群组或聊天室中的单个或多个指定成员发送消息，其他成员不会收到该消息。

使用限制

• 支持消息类型： 适用于文本、图片、语音和视频等各类消息。
• 接收人数限制： 每条定向消息最多可指定群组或聊天室中的 20 名成员接收。
• 会话列表与未读数： 定向消息不会写入服务端会话列表，也不计入服务端会话的未读消息数。
• 群组消息漫游： 群组定向消息默认不支持漫游。如需使用，请联系环信商务开通。
• 聊天室消息漫游： 聊天室定向消息默认不支持漫游。如需使用，请联系环信商务同时开通聊天室消息漫游和定向消息漫游功能。

前提条件

开始前，请确保满足以下条件：

• 完成 SDK 初始化，详见 初始化文档。
• 了解环信即时通讯 IM 的使用限制，详见 使用限制。

发送定向消息

发送定向消息的流程与发送普通消息相似，区别在于发送前需要调用 ChatMessage#setReceiverList 设置定向接收方列表。具体步骤如下：

1. 创建一条群组或聊天室消息。
2. 设置消息的定向接收方列表。
3. 发送定向消息。

下面以群组文本消息为例介绍如何发送定向消息：

// 创建一条群组文本消息。
let message = ChatMessage.createTextSendMessage(
  groupId,
  '这条消息只有指定成员能看到'
);

if (message) {
  // 群聊和聊天室分别设置为 ChatType.GroupChat 和 ChatType.ChatRoom。
  message.setChatType(ChatType.GroupChat);

  // 设置定向接收方列表，最多传入 20 个成员的用户 ID。
  // 不调用 setReceiverList 或传入空数组时，消息发送给群组或聊天室中的全部成员。
  let receiverIds = ['user1', 'user2'];
  message.setReceiverList(receiverIds);

  ChatClient.getInstance().chatManager()?.sendMessage(message);
}

接收定向消息与接收普通消息的操作相同，详见 接收消息。

接口列表

API 名称	所属模块/类	说明
createTextSendMessage	ChatMessage	创建文本消息。
setChatType	ChatMessage	设置消息所属的会话类型。
setReceiverList	ChatMessage	设置定向消息的接收方列表。
sendMessage	ChatManager	发送定向消息。