Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cometchat-22654f5b-release-unreal-docs.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Conversations represent the chat threads a user is part of — both 1:1 and group. Use the Fetch Conversations Async node to retrieve the list with unread counts, last messages, and metadata.

Fetch Conversations

  1. Create an FCometChatConversationsRequest struct
  2. Set filters (conversation type, tags, unread only, etc.)
  3. Call the Fetch Conversations Async node
  4. On Success, iterate the returned TArray<FCometChatConversation>

FCometChatConversationsRequest

Configure the request to filter and paginate results.
PropertyTypeDefaultDescription
Limitint3230Max conversations per page
ConversationTypeFStringFilter: user or group
bWithUserAndGroupTagsboolfalseInclude user/group tags
TagsTArray<FString>Filter by conversation tags
bWithTagsboolfalseInclude tags in response
UserTagsTArray<FString>Filter by user tags
GroupTagsTArray<FString>Filter by group tags
bIncludeBlockedUsersboolfalseInclude blocked users
bWithBlockedInfoboolfalseInclude blocked info
SearchKeywordFStringSearch conversations
bUnreadboolfalseOnly unread conversations
Pageint320Page number
bHideAgenticboolfalseHide AI/bot conversations
bOnlyAgenticboolfalseOnly AI/bot conversations

FCometChatConversation

The struct returned for each conversation.
PropertyTypeDescription
ConversationIdFStringUnique conversation identifier
ConversationTypeFStringuser or group
LastMessageFCometChatMessageMost recent message in the conversation
ConversationWithUserFCometChatUserThe other user (populated for 1:1 conversations)
ConversationWithGroupFCometChatGroupThe group (populated for group conversations)
UnreadMessageCountint32Number of unread messages
UpdatedAtint64Last activity timestamp
TagsTArray<FString>Conversation tags
UnreadMentionsCountint32Number of unread mentions
LastReadMessageIdint64ID of last read message
LatestMessageIdint64ID of latest message

Conversation Flow

Pagination: Set Page to fetch subsequent pages. Check if the returned array count equals Limit to determine if more pages exist.

Next Steps

Send a Message

Send messages in a conversation.

Real-Time Events

Listen for new messages to update the conversation list.