> ## 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 Agent Tool

> Comprehensive WhatsApp tool for AI agents - send messages, search contacts, get messages, and more

# WhatsApp Agent Tool

Comprehensive WhatsApp tool for AI agents - send messages, search contacts, get messages, and more

## Properties

| Property   | Value               |
| ---------- | ------------------- |
| **Type**   | whatsapp-tool-agent |
| **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      |
| action             | Action           | String | The action to perform: send\_message, send\_media, send\_location, get\_messages, search\_contacts, get\_chats, get\_profile, react, mark\_read, download\_media (required) | No       |
| to                 | Recipient        | String | WhatsApp JID or phone number (for send\_message, send\_media, send\_location)                                                                                               | No       |
| message            | Message          | String | Text message content (for send\_message)                                                                                                                                    | No       |
| media\_url         | Media URL        | String | URL of media file (for send\_media)                                                                                                                                         | No       |
| media\_type        | Media Type       | String | Type of media: image, video, audio, document (for send\_media)                                                                                                              | No       |
| caption            | Caption          | String | Caption for media (for send\_media)                                                                                                                                         | No       |
| latitude           | Latitude         | Number | Latitude coordinate (for send\_location)                                                                                                                                    | No       |
| longitude          | Longitude        | Number | Longitude coordinate (for send\_location)                                                                                                                                   | No       |
| name               | Location Name    | String | Name of location (for send\_location)                                                                                                                                       | No       |
| chat\_jid          | Chat JID         | String | JID of the chat (for get\_messages, react, mark\_read)                                                                                                                      | No       |
| search             | Search Query     | String | Text to search for (for get\_messages)                                                                                                                                      | No       |
| query              | Contact Query    | String | Name or phone to search (for search\_contacts)                                                                                                                              | No       |
| limit              | Limit            | Number | Max results to return (for get\_messages, search\_contacts, get\_chats)                                                                                                     | No       |
| unread\_only       | Unread Only      | Bool   | Only show unread chats (for get\_chats)                                                                                                                                     | No       |
| jid                | JID              | String | Contact JID (for get\_profile)                                                                                                                                              | No       |
| phone\_number      | Phone Number     | String | Phone number (for get\_profile)                                                                                                                                             | No       |
| message\_id        | Message ID       | String | ID of message (for react, download\_media)                                                                                                                                  | No       |
| emoji              | Emoji            | String | Emoji to react with (for react)                                                                                                                                             | No       |
| message\_ids       | Message IDs      | JSON   | Array of message IDs (for mark\_read)                                                                                                                                       | No       |
| quote\_message\_id | Quote Message ID | String | ID of message to reply to (for send\_message)                                                                                                                               | No       |

## Outputs

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