转发消息

---

功能简介

ZIM SDK 支持实现以下两种形式的消息转发：

• 合并消息后转发。
• 逐条消息转发。

前提条件

在实现“转发消息”功能之前，请确保：

• 已在 ZEGO 控制台 创建项目，获取到了接入 ZIM SDK 服务所需的 AppID、AppSign。ZIM 服务权限不是默认开启的，使用前，请先在 ZEGO 控制台 自助开通 ZIM 服务（详情请参考控制台的 服务配置 - 即时通讯 - 开通服务），若无法开通 ZIM 服务，请联系 ZEGO 技术支持开通。
• 已集成 ZIM SDK，详情请参考 快速开始 - 实现基本收发消息 的 “2 集成 SDK”。

收发合并消息

发送合并消息

发送合并消息步骤如下：

1. 通过 ZIMCombineMessage 对象构造合并消息体。参数包含如下：

   参数	类型	是否必填	说明
   type	number	是	必须为 100，表示合并消息类型。
   title	string	是	合并消息标题，长度上限默认为 20 字节。如需配置，请联系 ZEGO 技术支持。
   summary	string	是	合并消息概要，长度上限默认为 100 字节。如需配置，请联系 ZEGO 技术支持。
   messageList	ZIMMessage[]	是	需要合并转发的原始消息列表，不支持信令、弹幕、撤回、系统类型的消息，不支持合并转发非成功的消息。

   ZIM SDK 支持在合并消息内包含其他合并消息。

2. 调用 sendMessage 接口发送合并消息。开发者可参考 收发普通消息 - 发送消息 了解此接口参数详情。

以下为用户在单聊会话中发送合并消息的示例代码：

// 在单聊会话发送合并信息

var toConversationID = ''; // 对方 userID
var conversationType = 0; // 会话类型，取值为 单聊：0，房间：1，群组：2
var config = { 
    priority: 1, // 设置消息优先级，取值为 低：1（默认），中:2，高：3
};

var messageCombineObj = { 
    type: 100, 
    title: '标题', // 合并消息标题
    summary: '概要' , // 合并消息概要
    messageList: [message1, message2], // 需要合并转发的原始消息列表，可从历史消息中获取
};

var notification = {
    onMessageAttached: function(message) {
        // todo: Loading
    }
}

zim.sendMessage(messageCombineObj, toConversationID, conversationType, config, notification)
    .then(function ({ message }) {
        // 发送成功
    })
    .catch(function (err) {
        // 发送失败
    });

接收合并消息

接收合并消息的回调接口与接收普通消息的回调接口一致，请参考 收发普通消息 - 接收消息 了解具体接口。

以下为用户在单聊会话中接收合并消息的示例代码：

// 用户在单聊会话中接收合并消息
zim.on('receivePeerMessage', function (zim, { messageList, fromConversationID }) {
    console.log(messageList, fromConversationID);
    messageList.forEach(function (msg) {
        // 收到 `Combine` 消息时
        if (msg.type == 100) {
        }
    })
});

查看合并消息详情

消息操作（监听、增加以及拉取历史消息）只会返回合并消息的标题、概要、合并 ID 的信息。因此，当需要了解合并消息包含的子消息时，可以通过调用 queryCombineMessageDetail 接口查询。

操作的结果将通过 ZIMCombineMessageDetailQueriedResult 返回，可知合并消息下具体的子消息内容。

queryCombineMessageDetail(message: ZIMCombineMessage): Promise<ZIMCombineMessageDetailQueriedResult>

zim.queryCombineMessageDetail(message)
    .then(function (res) {
        // 操作成功，在 UI 上更新该消息的子消息列表
        // 具体的子消息在回调中的 message 的 messageList 里。
        console.log(res.message.messageList)
    })
    .catch(function (err) {
        // 操作失败
    });

若子消息列表中存在合并消息，要想获取该合并消息下的具体子消息，需再次调用 queryCombineMessageDetail 接口，将通过接口获取到的合并消息作为参数，以此类推，对于嵌套多层的合并消息会存在多次调用的情况。

逐条转发消息

逐条转发消息本质上就是将已发送成功的消息作为参数发送到其它会话，与发送普通消息所用接口相同，开发者可参考 收发普通消息 - 发送消息 了解此接口参数详情。