List all WhatsApp instances (or a specific one by name) with their connection status, owner and counts.

Check the connection state of a WhatsApp instance (open = connected, close/connecting otherwise).

Create a new WhatsApp instance. Returns the instance hash/apikey and (for Baileys) a QR code to connect.

Connect a WhatsApp instance and get the pairing code / QR code base64.

Restart a WhatsApp instance.

Set the global presence of an instance (available or unavailable).

Log out a WhatsApp instance (disconnects the device without deleting the instance).

Permanently delete a WhatsApp instance.

Get basic information about the Evolution API server (version, status).

Send a plain text message to a WhatsApp number.

Send a media message (image, video, audio or document) by URL or base64.

Send a WhatsApp voice note (PTT) by URL or base64.

Send a sticker by URL or base64.

Send a location message.

Send one or more contact cards (vCards).

React to a message with an emoji.

Send a poll message.

Send an interactive list message.

Send a message with interactive buttons.

Post a WhatsApp status/story (text, image or audio).

Send a PTV (round video note) by URL or base64.

Send an approved WhatsApp Business template message. Only works on WHATSAPP-BUSINESS (Cloud API) instances.

Read the message history of a chat. Filter by the contact's remoteJid (e.g. 5491112345678@s.whatsapp.net or a group ...@g.us). Results are paginated.

List WhatsApp chats with their metadata (name, last message timestamp, unread count).

Search contacts by id (phone/JID) or name.

Find a single chat by its remoteJid.

Retrieve status (story) messages.

Check whether one or more phone numbers are registered on WhatsApp.

Mark one or more messages as read.

Mark a chat as unread.

Archive or unarchive a chat.

Delete a message for everyone in the chat.

Edit a previously sent text message.

Send a typing/recording presence to a chat (composing, recording or paused).

Block or unblock a contact.

Get the profile picture URL of a contact.

Download a media message and return it as base64.

Fetch the WhatsApp Business profile of a number.

Fetch the profile (name, status, picture) of a number.

Update the display name of the instance's own profile.

Update the 'about'/status text of the instance's own profile.

Update the profile picture of the instance (URL or base64).

Remove the profile picture of the instance.

Fetch the privacy settings of the instance.

Update the privacy settings of the instance (read receipts, profile, status, online, last seen, group add).

List all groups the instance belongs to.

Get the info of a group by its JID.

List the participants of a group.

Create a new group with a subject and participants.

Change a group's subject (name).

Change a group's picture (URL or base64).

Change a group's description.

Get the invite link/code of a group.

Get group info from an invite code (without joining).

Join a group using an invite code.

Send a group invite to one or more numbers.

Revoke and regenerate a group's invite code.

Add, remove, promote (to admin) or demote participants in a group.

Change group settings: who can send messages (announcement) or edit group info (locked).

Set disappearing messages for a group (expiration in seconds: 0, 86400, 604800 or 7776000).

Leave a group.

Update the behaviour settings of an instance.

Get the current behaviour settings of an instance.

Configure the webhook of an instance (where Evolution POSTs events).

Get the current webhook configuration of an instance.

List the chat labels of an instance.

Add or remove a label from a chat.

List the message templates of an instance (WHATSAPP-BUSINESS only).

Create a message template (WHATSAPP-BUSINESS / Cloud API only).

Offer a (fake) WhatsApp call to a number — rings the recipient without a real call.