SearchCloudMessagesParams

SearchCloudMessagesParams

Properties:
Name Type Attributes Description
keyword string <optional>

Keyword list

senderUserIDList Array.<string> <optional>

Messages sent by specified userIDs, maximum 5 supported

messageTypeList Array.<string> <optional>

Specified message type collection to search, default searches all types

  • When not passed, means search all supported message types (TencentCloudChat.TYPES.MSG_FACE, TencentCloudChat.TYPES.MSG_GRP_TIP and TencentCloudChat.TYPES.MSG_GRP_SYS_NOTICE not supported)
conversationID string <optional>

Search "all conversations" or "specified conversation", when not passed, means all conversations, default: all conversations. Conversation ID composition:

  • C2C${userID} (one-to-one chat)
  • GROUP${groupID} (group chat)
  • Community, topic, live streaming groups do not support cloud message search
timePosition number <optional>

Search start time point. Default is 0 which means search from now. Unit: seconds

timePeriod number <optional>

Time range from start time point, unit seconds. Default is 0 which means no time range limit, pass 24 * 60 * 60 to represent past day

cursor string <optional>

Starting position for each cloud search. Do not pass cursor for first search, for continuing search fill in the cursor value returned by last searchCloudMessages call

  • Note: For full search, cursor is valid for 2 minutes

Cloud Message Search Parameters