Browse SDKs · uni-app / uni-app x
SDKsuni-app

Find messages by ID

OpenIM uni-app / uni-app x SDK guide for Find messages by ID.

Copy

Keep both conversationID and clientMsgID when a search result, quoted message, or notification navigates to a message, then use findMessageList() to retrieve the locally synchronized record.

Parameters

findMessageList() accepts an array of query groups:

ParameterTypeRequiredDescription
items[].conversationIDstringYesConversation that owns the requested messages.
items[].clientMsgIDListstring[]YesClient message IDs to find in that conversation.
import { findMessageList } from '@/uni_modules/unix-openim-sdk'

const result = await findMessageList([
  { conversationID, clientMsgIDList: [clientMsgID] },
])

const targetMessage = result?.findResultItems[0]?.messageList[0]

The Promise resolves to OpenIMFindMessageResult | null, containing totalCount and findResultItems. Each result item includes the conversationID, conversationType, conversation display snapshot, messageCount, and messageList.

One call can query several conversations. Do not assume response items preserve input order; match by the result conversationID and each message's clientMsgID. A result can be missing when local data has not synchronized, the message was deleted, or the ID does not exist. This query does not emit message events. To retrieve records around a hit, see Load message context.