GET /messages/matches_narrow
Check whether a set of messages match a narrow.
For many common narrows (e.g. a topic), clients can write an efficient client-side check to determine whether a newly arrived message belongs in the view.
This endpoint is designed to allow clients to handle more complex narrows for which the client does not (or in the case of full-text search, cannot) implement this check.
The format of the match_subject and match_content objects is designed
to match those returned by the GET /messages
endpoint, so that a client can splice these fields into a message object
received from GET /events and end up with an
extended message object identical to how a GET /messages
request for the current narrow would have returned the message.
Servers
- https://{subdomain}.zulipchat.com/api/v1
- {server}/api/v1
- https://chat.zulip.org/api/v1
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
narrow |
Yes |
A structure defining the narrow to check against. See how to construct a narrow. Changes: See changes section of search/narrow filter documentation. |
|
msg_ids |
Yes |
List of IDs for the messages to check. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.