即时通信 IM Web&小程序&uni-app（已读回执）

一、功能描述

群消息已读回执，高效沟通必备功能。作为一种强反馈工具，支持查看已读/未读已发送消息的人数和成员，尤其在商务、办公场景下，可帮助团队构建更加及时、高效的沟通氛围。

注意：说明：

注意：该功能仅对旗舰版或企业版客户开放，购买 旗舰版或企业版套餐包 后可使用。

二、消息已读回执

设置支持已读回执的群类型

如果是群消息已读回执，需要先在 即时通信 IM 控制台 > 功能配置 > 群组配置 > 群已读消息回执配置 中设置支持已读回执消息的群类型。

发送端设置消息需要已读回执

发送端创建消息，设置 needReadReceipt: true，然后发送消息。

// 发送 C2C 消息let message = chat.createTextMessage({ to: 'user1', conversationType: TencentCloudChat.TYPES.CONV_C2C, payload: { text: 'Hello world!' }, // 如果你发消息需要已读回执，需购买旗舰版或企业版套餐，并且创建消息时将 needReadReceipt 设置为 true needReadReceipt: true});// 2. 发送消息let promise = chat.sendMessage(message);promise.then(function(imResponse) { // 发送成功 console.log(imResponse);}).catch(function(imError) { // 发送失败 console.warn('sendMessage error:', imError);});

// 发送群消息let message = chat.createTextMessage({ to: 'test', conversationType: TencentCloudChat.TYPES.CONV_GROUP, payload: { text: 'Hello world!' }, // 如果你发消息需要已读回执，需购买旗舰版或企业版套餐，并且创建消息时将 needReadReceipt 设置为 true needReadReceipt: true});// 发送消息let promise = chat.sendMessage(message);promise.then(function(imResponse) { // 发送成功 console.log(imResponse);}).catch(function(imError) { // 发送失败 console.warn('sendMessage error:', imError);});

接收端发送消息已读回执

接收端收到消息后，可以通过消息对象 Message 的 needReadReceipt 字段判断消息是否需要已读回执，如果需要已读回执，当用户查看消息后，调用 sendMessageReadReceipt 接口发送消息已读回执。

注意：1. messageList 里的消息必须在同一个 C2C 或 Group 会话中。

注意：2. 调用该接口成功后，会话未读数不会变化，消息发送者会收到 TencentCloudChat.TYPES.MESSAGE_READ_RECEIPT_RECEIVED 事件，回调里面会携带消息的最新已读信息。

注意：3. 使用该接口需要你购买旗舰版或企业版套餐。

注意：4. 社群不支持群已读回执。

注意：5. C2C 消息调用此接口成功后，消息发送方的 message.readReceiptInfo.isPeerRead 属性会更新为 true，此属性可用于 C2C 已读回执消息状态渲染，调用此接口不会更新消息的 isPeerRead 属性。

三、sendMessageReadReceipt

接口

chat.sendMessageReadReceipt(messageList);

参数

返回值

Promise

示例

// 拉取群消息列表let messageList = null;chat.getMessageList({conversationID: 'GROUPtest'}).then(function(imResponse) { messageList = imResponse.data.messageList; // 消息列表 chat.sendMessageReadReceipt(messageList).then(function() { // 发送群消息已读回执成功 }).catch(function(imError) { // 发送群消息已读回执失败 });});

// 拉取C2C消息列表let messageList = null;chat.getMessageList({conversationID: 'C2Ctest'}).then(function(imResponse) { messageList = imResponse.data.messageList; // 消息列表 chat.sendMessageReadReceipt(messageList).then(function() { // 发送群消息已读回执成功 }).catch(function(imError) { // 发送群消息已读回执失败 });});

四、发送端监听消息已读回执通知

接收端发送消息已读回执后，发送端可以通过监听消息已读回执通知，在通知中更新 UI，例如更新为 “2 人已读”。

示例

let onMessageReadReceiptReceived = function(event) { // event.data – 存储消息已读回执信息的数组 const readReceiptInfoList = event.data; readReceiptInfoList.forEach((item) => { const { groupID, userID, messageID, readCount, unreadCount, isPeerRead } = item; // messageID – 消息 ID // userID – C2C 消息接收方 // isPeerRead – C2C 消息对端是否已读 // groupID – 群组 ID // readCount – 群消息已读人数 // unreadCount – 群消息未读人数 const message = chat.findMessage(messageID); if (message) { if (message.conversationType === TencentCloudChat.TYPES.CONV_C2C) { if (message.readReceiptInfo.isPeerRead === true) { // 对端已读 } } else if (message.conversationType === TencentCloudChat.TYPES.CONV_GROUP) { if (message.readReceiptInfo.unreadCount === 0) { // 全部已读 } else { // message.readReceiptInfo.readCount – 消息最新的已读数 // 如果想要查询哪些群成员已读了此消息，请使用 [getGroupMessageReadMemberList] 接口 } } } });}chat.on(TencentCloudChat.EVENT.MESSAGE_READ_RECEIPT_RECEIVED, onMessageReadReceiptReceived);

五、发送端主动拉取消息已读回执信息

发送端从其他界面进入消息列表后，先拉取历史消息，再调用 getMessageReadReceipt 接口拉取消息已读回执信息。

注意：1. messageList 里的消息必须在同一个 C2C 或 Group 会话中。

注意：2. 社群不支持群已读回执。

接口

chat.getMessageReadReceiptList(messageList);

参数

返回值

Promise

示例

// 拉取群消息列表let messageList = null;chat.getMessageList({conversationID: 'GROUPtest'}).then(function(imResponse) { messageList = imResponse.data.messageList; // 消息列表 chat.getMessageReadReceiptList(messageList).then(function(imResponse) { messageList = imResponse.data.messageList; // 消息列表 // 成功后，Message.readReceiptInfo 包含消息的已读回执信息 // Message.readReceiptInfo.readCount – // 消息的已读数，如果想要查询哪些群成员已读了此消息，请使用 [getGroupMessageReadMemberList] 接口 // Message.readReceiptInfo.unreadCount – 消息的未读数，当为0的时候，表示“全部已读”。 }).catch(function(imError) { // 拉取已读回执列表失败 });});

// 拉取 C2C 消息列表let messageList = null;chat.getMessageList({conversationID: 'C2Ctest'}).then(function(imResponse) { messageList = imResponse.data.messageList; // 消息列表 chat.getMessageReadReceiptList(messageList).then(function(imResponse) { messageList = imResponse.data.messageList; // 消息列表 // 成功后，Message.readReceiptInfo 包含消息的已读回执信息 // Message.readReceiptInfo.isPeerRead – 对端是否已发送已读回执 }).catch(function(imError) { // 拉取已读回执列表失败 });});

六、发送端主动拉取群消息已读或未读成员列表

发送端在需要查看群消息已读或未读成员列表时，可以调用 getGroupMessageReadMemberList 接口分页拉取消息已读或未读群成员列表。

注意：社群不支持群已读回执。

接口

chat.getGroupMessageReadMemberList(options);

参数

参数 options 为 Object 类型，包含的属性值如下：

返回值

Promise

示例

// 拉取群消息已读成员列表let promise = chat.getGroupMessageReadMemberList({ message, filter: 0, cursor: '', // 第一次拉取传'' count: 30,});promise.then(function(imResponse) { const { isCompleted, cursor, messageID, readUserIDList } = imResponse.data; // isCompleted – true，拉取完成；false 未完成 // cursor – 当 isCompleted 为 false 的时候用于续拉 // messageID – 群消息的 ID // readUserIDList – // 已读的群成员 userID 列表。接入侧可调用 getGroupMemberProfile 接口查询群成员的资料，如群名片、头像、昵称等}).catch(function(imError) { // 拉取群消息已读群成员列表失败});

// 拉取群消息未读成员列表let promise = chat.getGroupMessageReadMemberList({ message, filter: 1, cursor: '', // 第一次拉取传'' count: 30,});promise.then(function(imResponse) { const { isCompleted, cursor, messageID, readUserIDList } = imResponse.data; // isCompleted – true，拉取完成；false 未完成 // cursor – 当 isCompleted 为 false 的时候用于续拉 // messageID – 群消息的 ID // unreadUserIDList – // 未读的群成员 userID 列表。接入侧可调用 getGroupMemberProfile 接口查询群成员的资料，如群名片、头像、昵称等}).catch(function(imError) { // 拉取群消息未读群成员列表失败 // 10062 – 找不到群消息的已读回执信息});