This action retrieves a list of messages containing a specific search term. You can set the search scope to either a specific group channel or a specific user. When the search scope is set to a user, the search targets up to 100 group channels joined by the user.
Note: Punctuations and special characters are ignored while indexing, so unless they're being used for advanced search functionalities, they should be removed or replaced in the search term for best results.
The following table lists the parameters that this action supports.
Specifies the channel URL to restrict the search scope to a specific group channel.
Restricts the search scope to only retrieve messages from one or more channels where the specified users are members. The search targets up to 100 private and public group channels joined by the user. URL encoding the value is recommended.
Searches for messages that contain content that matches the specified search term. If you want the search messages that exactly match a group of keywords, set
Specifies the custom channel type to restrict the search scope. This
Specifies the number of messages to return per page. Acceptable values are
Determines whether to search for messages that contain an exact match for the entire search term. If set to
Determines whether to apply advanced search functionalities to the
Determines whether to search for messages containing synonyms of the search term. (Default:
Specifies the primary field to sort the results. Acceptable values are the following.
Determines whether to include a score indicating how relevant each result is to the search term in the search results. The
Restricts the search scope to the messages sent after the specified value in Unix milliseconds format. This includes messages sent exactly on the timestamp.
Restricts the search scope to the messages sent before the specified value in Unix milliseconds format. This includes messages sent exactly on the timestamp.
Marks the starting point of the search results to retrieve in the result set. The
Marks the end point of the search results to retrieve in the result set. The
Determines whether to sort the results in reverse order. If set to
Specifies a page token that indicates the starting index of a chunk of results to retrieve. If not specified, the index is set as 0.
array of strings
Specifies an array of user IDs to restrict the search scope to messages that are sent by the specified IDs. Up to five user IDs are allowed per request.
Determines whether to show detailed information about the target channel in the response. (Default:
If successful, this action returns a list of messages that contain the search term in the response body like the following.
List of response properties
array of objects
An array of messages that match the specified parameters.
The starting index of the current results.
The ending index of the current results.
Indicates whether there is a previous page of results.
Indicates whether there is a next page of results.
The value that can be used in the
In the case of an error, an error object is returned. A detailed list of error codes is available here.