WA-AKG icon

WA-AKG

Interact with WA-AKG WhatsApp Gateway API

Message → Search

AI-generated

Summary

Search messages by keyword

Inputs

  • sessionId (required) — The Session ID to use for this request
  • additionalFields — Additional Fields
  • mentions — JIDs to mention separated by commas. E.g. 628123@s.whatsapp.net, 628456@s.whatsapp.net
  • caption — Text caption to accompany the media. E.g. "Look at this picture!"
  • docFileName — Filename for the document (e.g. report.pdf). Only used when Media Type is Document.
  • locationName — Display name of the place. E.g. "Starbucks Cafe"
  • address — Address string of the place. E.g. "Jln. Sudirman No 1."
  • selectableCount — Number of options a user is allowed to select from the poll (e.g. 1 for single-choice)
  • listDescription — Secondary text body under the list message title
  • packName — Name of the sticker pack metadata. E.g. "My Funny Pack"
  • stickerAuthor — Author metadata on the sticker. E.g. "John StickerMaker"
  • searchQuery — Text string to search for in messages. E.g. "invoice"
  • filterJid — JID to restrict the search to a specific chat. E.g. 628xx@s.whatsapp.net

Output shape

an array of matching message objects

The result typically contains the messages that satisfy the search criteria; pagination or additional metadata is not defined in the node.

Examples

Example 1: Search for invoices in a specific chat

Set Session ID, enter Search Query = "invoice", and optionally set Filter by JID to the target chat JID.

Example 2: Search across all chats for the word "help"

Leave Session ID empty and set Search Query = "help".

Example 3: Search for media captions containing "sale"

Provide Search Query = "sale" and optionally use Additional Fields to filter by JID.

Links

Discussion