Send WhatsApp message or attachment
Input
kind requiredWhat to send: a text, an attached file of that kind, or a saved contact's card.
text optionalThe message text, for kind text.
phone optionalRecipient phone in international format, for a number with no chat yet, e.g. "+33 6 12 34 56 78" or "0033612345678". Confirm the number with the user before sending. Give this or `chatId`.
chatId optionalThe chat to send to, as get_inbox returns it in `chatId`. Give this or `phone`.
caption optionalOptional caption for an image, video or document.
dry_run optionalWhen true, everything runs up to the send and stops: the chat is opened and checked, the text typed or the file accepted by WhatsApp's editor, the contact found. Nothing is sent.
filename optionalName the file is sent under, e.g. report.pdf. WhatsApp shows it on documents.
attachment optionalThe file to send, for kind image, video or document.
contactName optionalSaved name of the contact whose card to send, exactly as the address book shows it, for kind contact.
Output
kind requiredsent requiredTrue once WhatsApp's server acknowledged the message. False on a dry run.
chatId requiredThe chat the message went to.
at optionalWhen it was sent, ISO datetime.
id optionalThe new message's id, usable by delete_message, react_to_message and the other message scripts. Null on a dry run.
status optionalDelivery status when the run ended.
dry_run optionalrecipient optionalChat title, as the chat list shows it.
account_used optionalPhone number of the WhatsApp account that sent it, read from the live session.
FAQ
Get WhatsApp conversation
Read the most recent messages of one WhatsApp chat, oldest first. Give the chat by its `chatId` from get_inbox. Each message gives its id, type, sender (in groups), time, text or caption, whether it was deleted for everyone, the delivery status of your own messages, file details for media, and its reactions with counts. `complete` is true when the start of the chat's history was reached. Reading does not open the chat, so nothing is marked as read and the other person gets no read receipt. If WhatsApp Web is open in another tab of the same browser, the run stops and asks to close that tab. If the browser is not linked to WhatsApp, the run stops and says so. An unknown chatId stops the run with an error.
Get WhatsApp inbox
List the chats of the WhatsApp chat list, in the order the list shows them, most recent first. Pick the same tab as the app: all chats, unread, favorites, groups, or archived. Each chat gives its id, its name, when it was last active, its unread count, whether it is pinned, muted, a favorite or marked unread by hand, and its last message with id, type, sender, time and text. `total` tells how many chats the tab holds, so a result cut by `count` is visible. Reading the list does not open a chat and marks nothing as read. If WhatsApp Web is open in another tab of the same browser, the run stops and asks to close that tab, because taking the session would disconnect it. If the browser is not linked to WhatsApp, the run stops and says so.
WhatsApp — Leave group
Leave (exit) a WhatsApp group by exact name, then confirm you are really out. With alsoDelete:true the conversation is also removed from your chat list; left off, the chat stays with its history. Only admins are notified when you leave. If you are already no longer a member of that group, it reports that instead of touching the conversation. Leaving removes you from the group and cannot be undone from here, so the group name is worth confirming with the user rather than guessed.