> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lyzn.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# WhatsApp Get Messages Tool

> AI tool to retrieve WhatsApp messages with smart filtering

# WhatsApp Get Messages Tool

AI tool to retrieve WhatsApp messages with smart filtering

## Properties

| Property   | Value                      |
| ---------- | -------------------------- |
| **Type**   | whatsapp-tool-get-messages |
| **Family** | AI                         |
| **Group**  | Tools                      |

## Parameters

| Name                 | Label              | Type   | Description                                                    | Required |
| -------------------- | ------------------ | ------ | -------------------------------------------------------------- | -------- |
| toolName             | Tool Name          | String | Name of the tool for the AI to call                            | Yes      |
| toolDescription      | Tool Description   | String | Description of what this tool does                             | Yes      |
| defaultLimit         | Default Limit      | Number | Default number of messages to retrieve if not specified by AI  | No       |
| chat\_jid            | Chat JID           | String | The JID of the chat to retrieve messages from (required)       | No       |
| search               | Search Query       | String | Optional text to search for in messages                        | No       |
| limit                | Limit              | Number | Maximum number of messages to return (default: 20, max: 100)   | No       |
| offset               | Offset             | Number | Number of messages to skip for pagination                      | No       |
| sender\_jid          | Sender JID         | String | Optional: Filter by sender JID                                 | No       |
| message\_type        | Message Type       | String | Optional: Filter by type (text, image, video, audio, document) | No       |
| before\_date         | Before Date        | String | Optional: Only messages before this ISO 8601 date              | No       |
| after\_date          | After Date         | String | Optional: Only messages after this ISO 8601 date               | No       |
| include\_media\_urls | Include Media URLs | Bool   | Whether to include media URLs in response                      | No       |

## Outputs

| Name     | Label    | Type   | Description      |
| -------- | -------- | ------ | ---------------- |
| toolName | toolName | string | Name of the tool |
| toolType | toolType | string | Type of tool     |