浏览 SDKs · WASM
平台
SDKsWASM商业版

查询分组内会话

分页查询指定会话分组及其会话详情。

复制

调用 getConversationGroupInfoWithConversations() 可一次性获取指定会话分组的详细资料以及该分组内包含的会话列表(支持分页)。

参数说明

参数类型是否必填说明
conversationGroupIDstring是要查询的会话分组 ID。
pagination.pageNumbernumber是页码,从 1 开始。
pagination.showNumbernumber是每页读取的会话数量。
const { data } = await openimsdk.getConversationGroupInfoWithConversations({
  conversationGroupID,
  pagination: {
    pageNumber: 1,
    showNumber: 20,
  },
});

renderConversationGroup(data.group, data.conversationElems, data.conversationTotal);

返回结果

字段类型说明
groupConversationGroup当前会话分组资料。
conversationTotalnumber分组内会话总数。
conversationElemsConversationItem[]当前页的会话详情。

关于 group 的完整字段定义请参考查询会话分组列表;conversationElems 中每个会话项的字段请参考获取会话列表。分页是否全部加载完毕可通过已拉取会话数与 conversationTotal 进行比对判断。

该接口为纯只读查询,不会触发事件通知。在应用运行过程中,分组与会话关联若发生变更,SDK 会通过相应事件进行通知,详情请参考会话分组概览。