WaAPI icon

WaAPI

Interact with WaAPI API
Join our community

Actions85

Overview

The node provides functionality to search messages within a messaging platform using the WaAPI API. It allows users to query message content based on text and filter results by additional options such as chat ID, pagination page, and limit of results per page. This node is useful for scenarios where you need to find specific messages containing certain keywords or phrases in chats, for example, retrieving customer support conversations that mention a particular issue or keyword.

Properties

Name Meaning
Id Instance ID (a required numeric identifier for the instance).
Query Text string to search for within messages.
Options JSON object with optional parameters: chatId (ID of the chat to search in), page (pagination page number), and limit (number of results per page).

Example of Options JSON:

{
  "chatId": "123456789@c.us",
  "page": 1,
  "limit": 10
}

Output

The output contains a JSON field with the search results from the messages matching the query and options provided. The structure typically includes an array of message objects that meet the search criteria. Each message object may contain details such as message content, sender information, timestamps, and chat identifiers.

If the node supports binary data output (not explicitly shown here), it would represent any media or attachments related to the messages found.

Dependencies

  • Requires an API key credential for authenticating with the WaAPI service.
  • The node depends on the external WaAPI REST API endpoint at https://waapi.app/api/v1.
  • Proper configuration of the API key credential in n8n is necessary for successful requests.

Troubleshooting

  • Common issues:
    • Invalid or missing API key credential will cause authentication failures.
    • Incorrect Id or malformed Options JSON can lead to request errors.
    • Searching with an empty or too generic query might return no results or excessive data.
  • Error messages:
    • Authentication errors usually indicate invalid credentials; verify and update the API key.
    • Validation errors on input properties suggest checking the format and required fields.
    • Network or timeout errors imply connectivity issues with the WaAPI service.

Links and References

Discussion