TIMMsgSendMessageReadReceipts
功能介绍
发送消息已读回执
该功能需要购买旗舰版套餐包，购买 旗舰版套餐包 后可使用。
当消息为 Group 消息时，messageIDList 里的消息ID必须在同一个 Group 会话中。
如果是群消息已读回执，需要先在 即时通信 IM 控制台 >功能配置>登录与消息>群已读消息回执配置 中设置支持已读回执消息的群类型。
该接口调用成功后，会话未读数不会变化，消息发送者会收到 TIMMsgReadedReceiptCallbackFunc 回调，回调里面会携带消息的最新已读信息。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| msgSendGroupMessageReceipts | MsgSendGroupMessageReceiptsParam | 是 | 发送消息已读回执的参数 |
返回模板
Promise<commonResult<string>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: string | undefined;
json_params?: string | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | 返回状态码 |
| desc | string ｜ undefined | 返回描述 |
| json_param | string ｜ undefined | 根据具具体接口返回 |
| json_params | string ｜ undefined | 兼容的字段，某些情况下会返回这个，根据具体接口返回 |
| user_data | string ｜ undefined | ImSDK负责透传的用户自定义数据，未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { MsgGetMsgListParams,Json_get_msg_param,MsgSendGroupMessageReceiptsParam } from "im_electron_sdk/dist/interfaces";
let convId = ""
let convType = 0
let msgParam:Json_get_msg_param = {
msg_getmsglist_param_last_msg: '', //选填
msg_getmsglist_param_count: 0, //选填
msg_getmsglist_param_is_ramble: false, //选填
msg_getmsglist_param_is_forward: false, //选填
msg_getmsglist_param_last_msg_seq: 0, //选填
msg_getmsglist_param_time_begin: 0, //选填
msg_getmsglist_param_time_period: 0, //选填
}
let param1 : MsgGetMsgListParams = {
conv_id: convId,//必填
conv_type: convType,//必填
params: msgParam,//必填
user_data:'' //选填
}
const {code1,json_params} = await timRenderInstance.TIMMsgGetMsgList(param1)
if(code1 == 0){
let param : MsgSendGroupMessageReceiptsParam = {
json_msg_array: JSON.stringify([json_params[0]]),//必填
user_data: "" //必填
}
const {code} = await timRenderInstance.TIMMsgSendMessageReadReceipts(param);
if(code == 0){
//发送成功
}
}