Skip to main content

WhatsApp Agent Tool

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

Properties

PropertyValue
Typewhatsapp-tool-agent
FamilyAI
GroupTools

Parameters

NameLabelTypeDescriptionRequired
toolNameTool NameStringName of the tool for the AI to callYes
toolDescriptionTool DescriptionStringDescription of what this tool doesYes
actionActionStringThe action to perform: send_message, send_media, send_location, get_messages, search_contacts, get_chats, get_profile, react, mark_read, download_media (required)No
toRecipientStringWhatsApp JID or phone number (for send_message, send_media, send_location)No
messageMessageStringText message content (for send_message)No
media_urlMedia URLStringURL of media file (for send_media)No
media_typeMedia TypeStringType of media: image, video, audio, document (for send_media)No
captionCaptionStringCaption for media (for send_media)No
latitudeLatitudeNumberLatitude coordinate (for send_location)No
longitudeLongitudeNumberLongitude coordinate (for send_location)No
nameLocation NameStringName of location (for send_location)No
chat_jidChat JIDStringJID of the chat (for get_messages, react, mark_read)No
searchSearch QueryStringText to search for (for get_messages)No
queryContact QueryStringName or phone to search (for search_contacts)No
limitLimitNumberMax results to return (for get_messages, search_contacts, get_chats)No
unread_onlyUnread OnlyBoolOnly show unread chats (for get_chats)No
jidJIDStringContact JID (for get_profile)No
phone_numberPhone NumberStringPhone number (for get_profile)No
message_idMessage IDStringID of message (for react, download_media)No
emojiEmojiStringEmoji to react with (for react)No
message_idsMessage IDsJSONArray of message IDs (for mark_read)No
quote_message_idQuote Message IDStringID of message to reply to (for send_message)No

Outputs

NameLabelTypeDescription
toolNametoolNamestringName of the tool
toolTypetoolTypestringType of tool