Skip to main content

SearchMessagesParams

Description

info

Parameters for searching messages

SearchMessagesParams

Field NameField TypeDescription
ConversationIDstringConversation ID. If empty, performs a global search
KeywordListstring[]Search keyword list. Currently only supports single keyword search
KeywordListMatchTypeintKeyword matching mode: 1 represents AND, 2 represents OR. Currently unused
SenderUserIDListstring[]Specifies the list of sender UIDs. Currently unused
MessageTypeListint[]Message type list
SearchTimePositionlongSearch start time point. Default is 0 which means search from now. UTC timestamp in seconds
SearchTimePeriodlongPast time range from the start time point, in seconds. Default 0 means unlimited range, pass 24x60x60 for past day
PageIndexintCurrent page number, starting at 1. Invalid when conversationID is empty (global search)
CountintCount per page. Invalid when conversationID is empty (global search)