Actions60
- User Actions
- Channel Actions
- Accept Invite
- Add Members
- Add Moderators
- Archive
- Ban User
- Create
- Delete
- Delete File
- Delete Image
- Demote Moderators
- Disable Slow Mode
- Enable Slow Mode
- Get Config
- Hide
- Invite Members
- Mark Read
- Mark Unread
- Mute
- Mute Status
- Pin
- Query Channels
- Query Members
- Reject Invite
- Remove Members
- Send Action
- Send File
- Send Image
- Show
- Stop Watching
- Truncate
- Unarchive
- Unban User
- Unmute
- Unpin
- Update
- Watch
- Message Actions
- Moderation Actions
Overview
The node enables searching messages within a Stream Chat channel. It allows users to perform text-based searches on message content in a specified chat channel, supporting partial word matching and keyword usage for more precise results.
This operation is useful when you want to find specific messages or conversations in a chat channel without manually browsing through all messages. For example, you can search for messages containing a particular keyword or phrase in a team discussion channel or customer support chat.
Practical examples:
- Searching for all messages mentioning a product name in a customer support channel.
- Finding messages with a specific error code or keyword in a developer team chat.
- Retrieving messages related to an event or topic in a livestream chat channel.
Properties
| Name | Meaning |
|---|---|
| Channel CID | The identifier of the channel to search in, formatted as type:id (e.g., messaging:general). Specifies which channel's messages will be searched. |
| Search Query | The text string to search for within messages. Supports partial word matching and keywords to refine the search results. |
Output
The output contains a JSON array of search results matching the query within the specified channel. Each item in the output corresponds to a message that matches the search criteria, including message details such as text content, sender, timestamps, and other metadata provided by the Stream Chat API.
No binary data is output by this operation.
Dependencies
- Requires an API key credential for authenticating with the Stream Chat service.
- The node uses the Stream Chat server-side client SDK to perform operations.
- Proper permissions must be granted to the API credentials to allow message searching.
- No additional environment variables are required beyond the API authentication setup.
Troubleshooting
Common issues:
- Invalid or improperly formatted Channel CID (must be in
type:idformat). - Empty or overly broad search queries may return too many results or none.
- Insufficient permissions on the API key to perform search operations.
- Network or connectivity issues with the Stream Chat API endpoint.
- Invalid or improperly formatted Channel CID (must be in
Error messages:
"Unsupported operation: message.searchMessages": Indicates the operation is not recognized; ensure the Resource is set to "Message" and Operation to "Search".- Errors related to invalid Channel CID format or missing parameters.
- API errors returned from Stream Chat, such as authentication failures or rate limits.
Resolutions:
- Verify the Channel CID format and existence of the channel.
- Use specific keywords in the search query to narrow down results.
- Check API key permissions and validity.
- Ensure network connectivity and retry if transient errors occur.