Whatsmiau

https://whatsmiau.dev/docs
Admin
Whatsmiau is a RESTful WhatsApp API that enables developers to integrate WhatsApp messaging, media...
Tokens:18,333
Snippets:139
Trust Score:2.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get QR Code as PNG with cURL

Source: https://whatsmiau.dev/docs

Download the QR code for instance connection as a PNG image. This is useful for embedding in HTML. Replace 'Marketing01' with your instance name and 'SUA_CHAVE' with your API key.

```bash
curl -X GET https://api.whatsmiau.dev/v2/instance/connect/Marketing01/image \
  -H "apikey: SUA_CHAVE" \
  -o qr.png
```

--------------------------------

### Get Instance Connection State

Source: https://whatsmiau.dev/docs

Use this endpoint to check the connection status of a specific WhatsApp instance. Ensure you replace 'Marketing01' with your instance name and 'SUA_CHAVE' with your API key.

```bash
curl -X GET https://api.whatsmiau.dev/v2/instance/connectionState/Marketing01 \
  -H "apikey: SUA_CHAVE"
```

--------------------------------

### MCP - Get Instance Details Tool

Source: https://whatsmiau.dev/docs

Retrieves detailed information about a specific WhatsApp instance. This is part of the 'Instances' tool category.

```APIDOC
## Tool: get_instance_details

### Description
Provides complete details for a specific instance.

### Endpoint
`GET /tools/instances/details` (This is an inferred endpoint based on the tool description and MCP concept. The actual endpoint might differ or be accessed via MCP client.)

### Parameters
This tool does not require explicit parameters when invoked through an MCP client, as the client discovers available tools and their schemas automatically.
```

--------------------------------

### Get Instance Connection State

Source: https://whatsmiau.dev/docs

Retrieves the connection state of a specific WhatsApp instance.

```APIDOC
## GET /instance/connectionState/:name

### Description
Retrieves the connection state of a specific WhatsApp instance.

### Method
GET

### Endpoint
/instance/connectionState/:name

### Parameters
#### Path Parameters
- **name** (string) - Required - Name of the instance.
```

--------------------------------

### Find Webhook Configuration

Source: https://whatsmiau.dev/docs

Retrieve the current webhook configuration for a specific instance. This is a GET request to the /webhook/find/:instance endpoint.

```curl
curl -X GET https://api.whatsmiau.dev/v2/webhook/find/MinhaInstancia \
  -H "apikey: SUA_CHAVE_AQUI"
```

--------------------------------

### Create Instance with cURL (Simple)

Source: https://whatsmiau.dev/docs

Create a new WhatsApp instance with a specified name and enable QR code generation. Replace 'SUA_CHAVE' with your API key.

```bash
curl -X POST https://api.whatsmiau.dev/v2/instance/create \
  -H "apikey: SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
  "instanceName": "Marketing01",
  "qrcode": true
}'
```

--------------------------------

### Create Instance

Source: https://whatsmiau.dev/docs

Creates a new instance with complete configuration, including webhook, call rejection, and history synchronization.

```APIDOC
## POST /instance/create

### Description
Creates a new instance with complete configuration: webhook, behavior (call rejection, mark as read, history sync) and optionally proxy (Enterprise). The 'instanceName' you choose will be the identifier used in all other calls — no separate ObjectID exists anymore.

### Method
POST

### Endpoint
/instance/create

### Parameters
#### Request Body
- **instanceName** (string) - Required - Unique identifier for the instance within your account. It will be used as :name in all other endpoints.
- **qrcode** (boolean) - Optional - Returns the QR Code in the creation response (if supported by the core).
- **token** (string) - Optional - Custom token.
- **rejectCall** (boolean) - Optional - Automatically rejects incoming calls.
- **msgCall** (string) - Optional - Message sent automatically when rejecting a call.
- **groupsIgnore** (boolean) - Optional - Ignores group events in the webhook.
- **alwaysOnline** (boolean) - Optional - Keeps the account always online on WhatsApp.
- **readMessages** (boolean) - Optional - Automatically marks messages as read.
- **readStatus** (boolean) - Optional - Automatically marks statuses as seen.
- **syncFullHistory** (boolean) - Optional - Syncs the full WhatsApp history upon connection.
- **webhook.enabled** (boolean) - Optional - Enables the webhook upon creation.
- **webhook.url** (string) - Optional - Public HTTPS URL that will receive events. Blocked: localhost, private IPs, and internal networks (SSRF protection).
- **webhook.events** (string[]) - Optional - List of events to filter. If omitted, all events are sent.
- **webhook.base64** (boolean) - Optional - If true, media in events come encoded in base64.
- **proxyHost** (string) - Optional - Proxy: public host (Enterprise).
- **proxyPort** (string) - Optional - Proxy: port (Enterprise).
- **proxyProtocol** (string) - Optional - Proxy: "http", "https", or "socks5" (Enterprise).
- **proxyUsername** (string) - Optional - Proxy: username (Enterprise).
- **proxyPassword** (string) - Optional - Proxy: password (Enterprise).
- **migration** (object) - Optional - Migration of an already authenticated Baileys session. Restricted to the Enterprise plan. Structure: { creds: object, preKeys: array }. Response includes migration: { jid, preKeysImported, connected }.

### Request Example
```curl
curl -X POST https://api.whatsmiau.dev/v2/instance/create \
  -H "apikey: SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d 
'{ 
  "instanceName": "Marketing01",
  "qrcode": true
}'
```
```

--------------------------------

### Connect Instance

Source: https://whatsmiau.dev/docs

Initiates the connection for an instance and returns the QR Code (base64) or pairing code if available.

```APIDOC
## GET /instance/connect/:name

### Description
Initiates the connection and returns the QR Code (base64) + pairing code when available. The instance is referenced by the name you chose during creation.

### Method
GET

### Endpoint
/instance/connect/:name

### Parameters
#### Path Parameters
- **name** (string) - Required - Instance name (the same "instanceName" used during creation).

#### Query Parameters
- **number** (string) - Optional - Phone number with country code to receive pairing code instead of QR Code (e.g., 5511999998888).

### Request Example
```curl
curl -X GET https://api.whatsmiau.dev/v2/instance/connect/Marketing01 \
  -H "apikey: SUA_CHAVE"
```
```

--------------------------------

### Connect Instance with cURL

Source: https://whatsmiau.dev/docs

Initiate a connection for a specific WhatsApp instance using its name. Replace 'Marketing01' with your instance name and 'SUA_CHAVE' with your API key.

```bash
curl -X GET https://api.whatsmiau.dev/v2/instance/connect/Marketing01 \
  -H "apikey: SUA_CHAVE"
```

--------------------------------

### MCP - Connect Instance Tool

Source: https://whatsmiau.dev/docs

Initiates the connection process for a WhatsApp instance and returns a base64 encoded QR code for authentication. This is one of the 'Instances' tools.

```APIDOC
## Tool: connect_instance

### Description
Starts the instance connection and returns the QR code in base64 format.

### Endpoint
`POST /tools/instances/connect` (This is an inferred endpoint based on the tool description and MCP concept. The actual endpoint might differ or be accessed via MCP client.)

### Parameters
This tool does not require explicit parameters when invoked through an MCP client, as the client discovers available tools and their schemas automatically.
```

--------------------------------

### MCP - Create Instance Tool

Source: https://whatsmiau.dev/docs

Creates a new WhatsApp instance for your account. This is one of the 7 tools available in the 'Instances' category.

```APIDOC
## Tool: create_instance

### Description
Creates a new WhatsApp instance.

### Endpoint
`POST /tools/instances/create` (This is an inferred endpoint based on the tool description and MCP concept. The actual endpoint might differ or be accessed via MCP client.)

### Parameters
This tool does not require explicit parameters when invoked through an MCP client, as the client discovers available tools and their schemas automatically.
```

--------------------------------

### List Instances with cURL

Source: https://whatsmiau.dev/docs

Retrieve a list of all your WhatsApp instances and their current connection states. Remember to substitute 'SUA_CHAVE' with your API key.

```bash
curl -X GET https://api.whatsmiau.dev/v2/instance/fetchInstances \
  -H "apikey: SUA_CHAVE"
```

--------------------------------

### List Instances

Source: https://whatsmiau.dev/docs

Retrieves all instances associated with your account, including their current connection status.

```APIDOC
## GET /instance/fetchInstances

### Description
Returns all instances of your account with the current connection state. Each item follows the same response format as Creation. Instances suspended due to plan limits will have state: 'closed' and suspended: true.

### Method
GET

### Endpoint
/instance/fetchInstances

### Request Example
```curl
curl -X GET https://api.whatsmiau.dev/v2/instance/fetchInstances \
  -H "apikey: SUA_CHAVE"
```
```

--------------------------------

### Verify Credentials

Source: https://whatsmiau.dev/docs

Test if your API key is valid by listing your instances.

```APIDOC
## GET /instance/fetchInstances

### Description
Test if your API key is valid by listing your instances.

### Method
GET

### Endpoint
/instance/fetchInstances

### Request Example
```curl
curl -X GET https://api.whatsmiau.dev/v2/instance/fetchInstances \
  -H "apikey: SUA_CHAVE_AQUI"
```
```

--------------------------------

### Update Instance Webhook and Proxy Settings

Source: https://whatsmiau.dev/docs

Update webhook and proxy configurations for an existing instance. Fields not provided will remain unchanged. Proxy fields are restricted to the Enterprise plan. Ensure the URL is HTTPS and not a localhost or private IP.

```bash
curl -X PUT https://api.whatsmiau.dev/v2/instance/update/Marketing01 \
  -H "apikey: SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
  "webhook": {
    "enabled": true,
    "url": "https://meusite.com/webhook",
    "events": ["messages.upsert", "connection.update"]
  }
}'
```

--------------------------------

### Cursor/Continue/Cline MCP Configuration

Source: https://whatsmiau.dev/docs

This JSON configuration file is for clients like Cursor, Continue, or Cline to connect to the WhatsMiau MCP server. It simply requires the URL of the MCP endpoint.

```json
{
  "mcpServers": {
    "whatsmiau": {
      "url": "https://mcp.whatsmiau.dev/mcp"
    }
  }
}
```

--------------------------------

### MCP - Update Instance Tool

Source: https://whatsmiau.dev/docs

Configures webhook settings and behavior flags for a specific WhatsApp instance. This is one of the 'Instances' tools.

```APIDOC
## Tool: update_instance

### Description
Configures webhook and behavior flags for an instance.

### Endpoint
`PUT /tools/instances/update` (This is an inferred endpoint based on the tool description and MCP concept. The actual endpoint might differ or be accessed via MCP client.)

### Parameters
This tool does not require explicit parameters when invoked through an MCP client, as the client discovers available tools and their schemas automatically.
```

--------------------------------

### MCP - List Instances Tool

Source: https://whatsmiau.dev/docs

Lists all WhatsApp instances associated with your account, including their connection status. This is one of the 23 tools available through the MCP.

```APIDOC
## Tool: list_instances

### Description
Lists all instances of your account with connection status.

### Endpoint
`GET /tools/instances/list` (This is an inferred endpoint based on the tool description and MCP concept. The actual endpoint might differ or be accessed via MCP client.)

### Parameters
This tool does not require explicit parameters when invoked through an MCP client, as the client discovers available tools and their schemas automatically.
```

--------------------------------

### Verify API Key with cURL

Source: https://whatsmiau.dev/docs

Test if your API key is valid by listing your instances. Ensure you replace 'SUA_CHAVE_AQUI' with your actual API key.

```bash
curl -X GET https://api.whatsmiau.dev/v2/instance/fetchInstances \
  -H "apikey: SUA_CHAVE_AQUI"
```

--------------------------------

### Claude Desktop MCP Configuration

Source: https://whatsmiau.dev/docs

This JSON configuration file is used for Claude Desktop to connect to WhatsMiau's Model Context Protocol (MCP) server. It specifies the command to run and its arguments for establishing the connection.

```json
{
  "mcpServers": {
    "whatsmiau": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://mcp.whatsmiau.dev/mcp"]
    }
  }
}
```

--------------------------------

### Update Instance

Source: https://whatsmiau.dev/docs

Updates the webhook and/or proxy configuration of an existing instance. Fields not sent remain unchanged. Proxy fields are restricted to the Enterprise plan.

```APIDOC
## PUT /instance/update/:name

### Description
Updates the webhook and/or proxy configuration of an existing instance. Fields not sent remain unchanged. Proxy fields are restricted to the Enterprise plan.

### Method
PUT

### Endpoint
/instance/update/:name

### Parameters
#### Path Parameters
- **name** (string) - Required - Name of the instance (path param).

#### Request Body
- **webhook.enabled** (boolean) - Optional - Enable/disable webhook.
- **webhook.url** (string) - Optional - HTTPS URL that will receive events. Blocked: localhost, private IPs, and internal networks.
- **webhook.events** (string[]) - Optional - Event filter (e.g., messages.upsert, connection.update).
- **webhook.base64** (boolean) - Optional - If true, media in events are base64 encoded.
- **proxyHost** (string) - Optional - Public proxy host (Enterprise).
- **proxyPort** (string) - Optional - Proxy port (Enterprise).
- **proxyProtocol** (string) - Optional - "http", "https", or "socks5" (Enterprise).
- **proxyUsername** (string) - Optional - Proxy user (Enterprise).
- **proxyPassword** (string) - Optional - Proxy password (Enterprise).

### Request Example
```json
{
  "webhook": {
    "enabled": true,
    "url": "https://meusite.com/webhook",
    "events": ["messages.upsert", "connection.update"]
  }
}
```
```

--------------------------------

### Disconnect (Logout) Instance

Source: https://whatsmiau.dev/docs

Logs out the WhatsApp session for a given instance, but keeps the instance itself active. The instance can be reconnected later by calling '/instance/connect/:name'. Use 'Delete Instance' to remove it permanently.

```bash
curl -X DELETE https://api.whatsmiau.dev/v2/instance/logout/Marketing01 \
  -H "apikey: SUA_CHAVE"
```

--------------------------------

### Send Audio (PTT)

Source: https://whatsmiau.dev/docs

Sends an audio file as if it were recorded on the spot (Push-To-Talk).

```APIDOC
## POST /message/sendWhatsAppAudio/:instance

### Description
Sends an audio file as if it were recorded on the spot (Push-To-Talk).

### Method
POST

### Endpoint
/message/sendWhatsAppAudio/:instance

### Parameters
#### Path Parameters
- **instance** (string) - Required

#### Request Body
- **number** (string) - Required - Recipient number.
- **audio** (string) - Required - Public URL of the MP3/OGG file.
- **delay** (number) - Optional - Delay in milliseconds (max: 300000).
- **encoding** (boolean) - Optional - Re-encode audio before sending.
- **quoted** (object) - Optional - Message to reply to (key.id required).
- **mentionsEveryOne** (boolean) - Optional - Mention everyone in groups.
- **mentioned** (string[]) - Optional - List of JIDs to mention.

### Request Example
```json
{
  "number": "551199998888",
  "audio": "https://example.com/voice.mp3"
}
```
```

--------------------------------

### get_webhook

Source: https://whatsmiau.dev/docs

Returns the current webhook configuration of an instance.

```APIDOC
## get_webhook

### Description
Returns the current webhook configuration of an instance.

### Parameters
(Parameters not specified in the source text, only a reference to 'Ver parâmetros →')
```

--------------------------------

### Configure Webhook

Source: https://whatsmiau.dev/docs

Sets or updates the webhook configuration for an instance, allowing customization of the destination URL, events, headers, and payload format.

```APIDOC
## POST /webhook/set/:instance

### Description
Sets or updates the webhook configuration for an instance, allowing customization of the destination URL, events, headers, and payload format.

### Method
POST

### Endpoint
/webhook/set/:instance

### Parameters
#### Request Body
- **webhook.enabled** (boolean) - Optional - Enables or disables the webhook.
- **webhook.url** (string) - Optional - The URL that will receive events via POST.
- **webhook.events** (string[]) - Optional - A list of events to filter (e.g., messages.upsert, connection.update).
- **webhook.headers** (object) - Optional - Custom HTTP headers sent with each event.
- **webhook.byEvents** (boolean) - Optional - If true, sends one POST per event. If false, groups events.
- **webhook.base64** (boolean) - Optional - If true, encodes the payload in base64.

### Request Example
```json
{
  "webhook": {
    "enabled": true,
    "url": "https://meusite.com/webhook",
    "events": ["messages.upsert", "connection.update"],
    "headers": {
      "Authorization": "Bearer meu_token"
    }
  }
}
```
```

--------------------------------

### Configure Webhook

Source: https://whatsmiau.dev/docs

Set or update webhook configurations, including URL, enabled status, event filters, custom headers, and payload format. This is a POST request.

```curl
curl -X POST https://api.whatsmiau.dev/v2/webhook/set/MinhaInstancia \
  -H "Content-Type: application/json" \
  -H "apikey: SUA_CHAVE_AQUI" \
  -d '{
    "webhook": {
      "enabled": true,
      "url": "https://meusite.com/webhook",
      "events": ["messages.upsert", "connection.update"],
      "headers": {
        "Authorization": "Bearer meu_token"
      }
    }
  }'
```

--------------------------------

### Send Audio (PTT) Message

Source: https://whatsmiau.dev/docs

Send an audio file as a Push-To-Talk message. The audio file must be a public URL to an MP3 or OGG file. Options include delays, re-encoding, and message quoting.

```bash
curl -X POST https://api.whatsmiau.dev/v2/message/sendWhatsAppAudio/Marketing01 \
  -H "apikey: KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "number": "551199998888",
  "audio": "https://example.com/voice.mp3"
}'
```

--------------------------------

### Find Webhook Configuration

Source: https://whatsmiau.dev/docs

Retrieves the current webhook configuration for a specific instance.

```APIDOC
## GET /webhook/find/:instance

### Description
Retrieves the current webhook configuration for a specific instance.

### Method
GET

### Endpoint
/webhook/find/:instance
```

--------------------------------

### Handle Connection State Changes

Source: https://whatsmiau.dev/docs

This snippet illustrates the 'connection.update' event, which signals changes in the WhatsApp connection state. It includes the instance ID, WhatsApp UID, profile information, and the connection state ('open' or 'close').

```json
{
  "event": "connection.update",
  "instance": "Atendimento01",
  "date_time": "2026-03-30T10:00:00Z",
  "data": {
    "instance": "Atendimento01",
    "wuid": "5511999998888@s.whatsapp.net",
    "profileName": "Meu Negócio",
    "profilePictureUrl": "https://pps.whatsapp.net/v/t61...",
    "state": "open",
    "statusReason": 200
  }
}
```

--------------------------------

### QR Code as PNG

Source: https://whatsmiau.dev/docs

Retrieves the QR Code as a raw PNG image, suitable for embedding in HTML.

```APIDOC
## GET /instance/connect/:name/image

### Description
Returns the QR Code as a pure PNG image (Content-Type: image/png). Useful for embedding in HTML pages via <img />. Returns 204 No Content if the instance is already connected.

### Method
GET

### Endpoint
/instance/connect/:name/image

### Parameters
#### Path Parameters
- **name** (string) - Required - Instance name.

### Request Example
```curl
curl -X GET https://api.whatsmiau.dev/v2/instance/connect/Marketing01/image \
  -H "apikey: SUA_CHAVE" \
  -o qr.png
```
```

--------------------------------

### Disconnect (Logout) Instance

Source: https://whatsmiau.dev/docs

Ends the WhatsApp session but keeps the instance created. To reconnect later, simply call /instance/connect/:name again. To remove permanently, use Delete Instance.

```APIDOC
## DELETE /instance/logout/:name

### Description
Ends the WhatsApp session but keeps the instance created. To reconnect later, simply call /instance/connect/:name again. To remove permanently, use Delete Instance.

### Method
DELETE

### Endpoint
/instance/logout/:name

### Parameters
#### Path Parameters
- **name** (string) - Required - Name of the instance.
```

--------------------------------

### Connection State

Source: https://whatsmiau.dev/docs

Retrieves the current connection status of the instance.

```APIDOC
## GET /instance/connectionState/:name

### Description
Returns the current state of the instance. Values: 'open' (connected), 'closed' (disconnected), 'connecting' (connecting), 'qr-code' (awaiting read). When suspended due to plan limits, it returns 'closed' + an extra field suspended: true.

### Method
GET

### Endpoint
/instance/connectionState/:name

### Parameters
#### Path Parameters
- **name** (string) - Required - Instance name.
```

--------------------------------

### send_list_message

Source: https://whatsmiau.dev/docs

Sends an interactive menu with a list of options.

```APIDOC
## send_list_message

### Description
Sends an interactive menu with a list of options.

### Parameters
(Parameters not specified in the source text, only a reference to 'Ver parâmetros →')
```

--------------------------------

### Send Round Video (PTV)

Source: https://whatsmiau.dev/docs

Sends a short circular video message (Push-To-Video), similar to PTT audio but with video. Use short files (<= 60s) in MP4 format.

```APIDOC
## POST /message/sendPtv/:instance

### Description
Sends a short circular video message (Push-To-Video).

### Method
POST

### Endpoint
/message/sendPtv/:instance

### Parameters
#### Request Body
- **number** (string) - Required - Recipient's number (e.g., 5511999998888).
- **video** (string) - Required - Public URL of the MP4 file.
- **delay** (number) - Optional - Delay in milliseconds (max: 300000).
- **quoted** (object) - Optional - Message to reply to (key.id required).
- **mentionsEveryone** (boolean) - Optional - Mention everyone in groups.
- **mentioned** (string[]) - Optional - List of JIDs to mention.

### Request Example
```json
{
  "number": "551199998888",
  "video": "https://example.com/short.mp4"
}
```
```

--------------------------------

### MCP - Logout Instance Tool

Source: https://whatsmiau.dev/docs

Disconnects a WhatsApp instance without deleting it. This is one of the tools available under the 'Instances' category.

```APIDOC
## Tool: logout_instance

### Description
Disconnects the instance without deleting it.

### Endpoint
`POST /tools/instances/logout` (This is an inferred endpoint based on the tool description and MCP concept. The actual endpoint might differ or be accessed via MCP client.)

### Parameters
This tool does not require explicit parameters when invoked through an MCP client, as the client discovers available tools and their schemas automatically.
```

--------------------------------

### Delete Instance

Source: https://whatsmiau.dev/docs

Permanently removes a WhatsApp instance, ending its session and freeing up a slot in your plan. Use the same 'instanceName' that was used during creation.

```bash
curl -X DELETE https://api.whatsmiau.dev/v2/instance/delete/Marketing01 \
  -H "apikey: SUA_CHAVE"
```

--------------------------------

### send_button_message

Source: https://whatsmiau.dev/docs

Sends a message with 1 to 3 quick reply buttons.

```APIDOC
## send_button_message

### Description
Sends a message with 1 to 3 quick reply buttons.

### Parameters
(Parameters not specified in the source text, only a reference to 'Ver parâmetros →')
```

--------------------------------

### Send Round Video (PTV) Message using cURL

Source: https://whatsmiau.dev/docs

Send a short circular video message (Push-To-Video). Use MP4 files with a maximum duration of 60 seconds.

```bash
curl -X POST https://api.whatsmiau.dev/v2/message/sendPtv/Marketing01 \
  -H "apikey: KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "number": "551199998888",
  "video": "https://example.com/short.mp4"
}'
```

--------------------------------

### Send List Message

Source: https://whatsmiau.dev/docs

Use this endpoint to send a structured list message. This is useful for presenting options or catalog items to the user. Ensure all required fields like 'number' and 'description' are provided.

```cURL
curl -X POST https://api.whatsmiau.dev/v2/message/sendList/Marketing01 \
  -H "apikey: KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "number": "551199998888",
  "title": "Nossos Planos",
  "description": "Escolha o plano ideal para você:",
  "buttonText": "Ver opções",
  "footerText": "Whatsmiau Cloud",
  "sections": [
    {
      "title": "Planos",
      "rows": [
        { "title": "Starter", "description": "R$ 30/mês - 1 instância", "rowId": "plan_starter" },
        { "title": "Pro", "description": "R$ 90/mês - 5 instâncias", "rowId": "plan_pro" },
        { "title": "Enterprise", "description": "R$ 200/mês - 15 instâncias", "rowId": "plan_enterprise" }
      ]
    }
  ]'
}
```

--------------------------------

### Send Presence

Source: https://whatsmiau.dev/docs

Simulates presence status (typing, recording audio, online) in a chat.

```APIDOC
## POST /chat/sendPresence/:instance

### Description
Simulates presence status in a chat.

### Method
POST

### Endpoint
/chat/sendPresence/:instance
```

--------------------------------

### send_typing_indicator

Source: https://whatsmiau.dev/docs

Shows 'typing...' or 'recording audio...' to the recipient.

```APIDOC
## send_typing_indicator

### Description
Shows "typing..." or "recording audio..." to the recipient.

### Parameters
(Parameters not specified in the source text, only a reference to 'Ver parâmetros →')
```

--------------------------------

### Delete Instance

Source: https://whatsmiau.dev/docs

Permanently removes the instance, ends the session, and frees up a slot in your plan.

```APIDOC
## DELETE /instance/delete/:name

### Description
Permanently removes the instance, ends the session, and frees up a slot in your plan.

### Method
DELETE

### Endpoint
/instance/delete/:name

### Parameters
#### Path Parameters
- **name** (string) - Required - Name of the instance (the same "instanceName" used when creating).
```

--------------------------------

### send_ptv_message

Source: https://whatsmiau.dev/docs

Sends a round video (push-to-video, FaceTime type).

```APIDOC
## send_ptv_message

### Description
Sends a round video (push-to-video, FaceTime type).

### Parameters
(Parameters not specified in the source text, only a reference to 'Ver parâmetros →')
```

--------------------------------

### Handle Incoming Text Messages

Source: https://whatsmiau.dev/docs

This snippet demonstrates the structure of a 'messages.upsert' event when a simple text message is received. It includes sender information, message content, and metadata.

```json
{
  "event": "messages.upsert",
  "instance": "Atendimento01",
  "date_time": "2026-03-30T14:32:00Z",
  "data": {
    "key": {
      "remoteJid": "5511999999999@s.whatsapp.net",
      "fromMe": false,
      "id": "3EB04A2D1F75..."
    },
    "pushName": "Maria Silva",
    "status": "received",
    "message": {
      "conversation": "Olá! Gostaria de saber o status do meu pedido."
    },
    "messageType": "conversation",
    "messageTimestamp": 1743349920,
    "instanceId": "Atendimento01",
    "source": "android"
  }
}
```

--------------------------------

### connection.update

Source: https://whatsmiau.dev/docs

Triggered when the connection state changes. This occurs upon successful connection (QR Code scan), disconnection (logout, session loss), or connection failures.

```APIDOC
## connection.update

### Description
Disparado quando o estado da conexão muda. Ocorre ao conectar com sucesso (escaneou QR Code), ao desconectar (logout, perda de sessão) ou em falhas de conexão.

### Payload (data)
- **instance** (string) - ID da instância.
- **wuid** (string) - WhatsApp UID (número conectado). Presente apenas quando state = "open".
- **profileName** (string) - Nome do perfil do WhatsApp. Presente apenas quando state = "open".
- **profilePictureUrl** (string?) - URL da foto de perfil (quando disponível).
- **state** (string) - "open" | "close". Estado atual da conexão.
- **statusReason** (number) - Código do motivo (200 = sucesso, outros = erro).

### Request Example
```json
{
  "event": "connection.update",
  "instance": "Atendimento01",
  "date_time": "2026-03-30T10:00:00Z",
  "data": {
    "instance": "Atendimento01",
    "wuid": "5511999998888@s.whatsapp.net",
    "profileName": "Meu Negócio",
    "profilePictureUrl": "https://pps.whatsapp.net/v/t61...",
    "state": "open",
    "statusReason": 200
  }
}
```
```

--------------------------------

### MCP - Delete Instance Tool

Source: https://whatsmiau.dev/docs

Permanently removes a WhatsApp instance from your account. This is part of the 'Instances' tool category.

```APIDOC
## Tool: delete_instance

### Description
Permanently removes the instance.

### Endpoint
`DELETE /tools/instances/delete` (This is an inferred endpoint based on the tool description and MCP concept. The actual endpoint might differ or be accessed via MCP client.)

### Parameters
This tool does not require explicit parameters when invoked through an MCP client, as the client discovers available tools and their schemas automatically.
```

--------------------------------

### send_sticker_message

Source: https://whatsmiau.dev/docs

Sends a sticker from a public .webp URL.

```APIDOC
## send_sticker_message

### Description
Sends a sticker from a public .webp URL.

### Parameters
(Parameters not specified in the source text, only a reference to 'Ver parâmetros →')
```

--------------------------------

### Send Media Message

Source: https://whatsmiau.dev/docs

Send images, videos, or documents via a public URL. Specify the media type, URL, and optionally add a caption, filename, or MIME type. Supports optional delays and message quoting.

```bash
curl -X POST https://api.whatsmiau.dev/v2/message/sendMedia/Marketing01 \
  -H "apikey: KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "number": "551199998888",
  "mediatype": "image",
  "media": "https://example.com/image.png",
  "caption": "Confira!"
}'
```

--------------------------------

### send_audio_message

Source: https://whatsmiau.dev/docs

Sends voice notes (PTT), automatically converting them to Ogg/Opus.

```APIDOC
## send_audio_message

### Description
Sends voice notes (PTT) — automatically converts to Ogg/Opus.

### Parameters
(Parameters not specified in the source text, only a reference to 'Ver parâmetros →')
```

--------------------------------

### Send Media

Source: https://whatsmiau.dev/docs

Sends images, videos, or documents via public URL.

```APIDOC
## POST /message/sendMedia/:instance

### Description
Sends images, videos, or documents via public URL.

### Method
POST

### Endpoint
/message/sendMedia/:instance

### Parameters
#### Path Parameters
- **instance** (string) - Required

#### Request Body
- **number** (string) - Required - Recipient number.
- **mediaType** (string) - Required - "image", "video", or "document".
- **media** (string) - Required - Public URL of the file.
- **caption** (string) - Optional - Media caption.
- **fileName** (string) - Optional - File name (for documents).
- **mimeType** (string) - Optional - File MIME type.
- **delay** (number) - Optional - Delay in milliseconds (max: 300000).
- **quoted** (object) - Optional - Message to reply to (key.id required).
- **mentionsEveryOne** (boolean) - Optional - Mention everyone in groups.
- **mentioned** (string[]) - Optional - List of JIDs to mention.

### Request Example
```json
{
  "number": "551199998888",
  "mediaType": "image",
  "media": "https://example.com/image.png",
  "caption": "Confira!"
}
```
```

--------------------------------

### send_status_message

Source: https://whatsmiau.dev/docs

Publishes to the user's own status (text, image, audio, or video).

```APIDOC
## send_status_message

### Description
Publishes to the status of the own user (text, image, audio or video).

### Parameters
(Parameters not specified in the source text, only a reference to 'Ver parâmetros →')
```

--------------------------------

### Send Buttons Message

Source: https://whatsmiau.dev/docs

Sends a message with interactive quick reply or PIX payment buttons. Supports up to 3 buttons.

```APIDOC
## POST /message/sendButtons/:instance

### Description
Sends a message with interactive quick reply buttons. Supports reply buttons and PIX buttons.

### Method
POST

### Endpoint
/message/sendButtons/:instance

### Parameters
#### Request Body
- **number** (string) - Required - Recipient's number (e.g., 5511999998888).
- **title** (string) - Optional - Message title.
- **description** (string) - Required - Message body.
- **footer** (string) - Optional - Footer text.
- **buttons** (array) - Required - List of buttons (max 3).
  - **buttons[].type** (string) - Required - "reply" for quick reply or "pix" for payment.
  - **buttons[].displayText** (string) - Required - Text displayed on the button.
  - **buttons[].id** (string) - Optional - Button ID (returned in webhook when clicked). Used with type "reply".
  - **buttons[].currency** (string) - Optional - PIX currency (e.g., "BRL"). Required when type is "pix".
  - **buttons[].name** (string) - Optional - PIX recipient's name. Required when type is "pix".
  - **buttons[].keyType** (string) - Optional - PIX key type: "email", "cpf", "cnpj", "phone", or "random". Required when type is "pix".
  - **buttons[].key** (string) - Optional - PIX recipient's key. Required when type is "pix".

### Request Example
```json
{
  "number": "551199998888",
  "title": "Confirmar Pedido",
  "description": "Deseja confirmar o pedido #1234?",
  "footer": "Whatsmiau Cloud",
  "buttons": [
    { "type": "reply", "displayText": "Sim, confirmar", "id": "confirm_yes" },
    { "type": "reply", "displayText": "Não, cancelar", "id": "confirm_no" }
  ]
}
```
```

--------------------------------

### Send Reaction to a Message using cURL

Source: https://whatsmiau.dev/docs

React to a specific message with an emoji. You need to provide the reaction emoji and the key details of the target message.

```bash
curl -X POST https://api.whatsmiau.dev/v2/message/sendReaction/Marketing01 \
  -H "apikey: KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reaction": "👍",
  "key": {
    "remoteJid": "5511999998888@s.whatsapp.net",
    "id": "3EB0XXXXXXXX",
    "fromMe": false
  }
}'
```

--------------------------------

### Send Sticker Message

Source: https://whatsmiau.dev/docs

Sends a sticker from a public URL. Supports automatic conversion for non-WebP formats.

```APIDOC
## POST /message/sendSticker/:instance

### Description
Sends a sticker (sticker) from a public URL. The file needs to be in WebP format for direct use; other formats may be automatically converted.

### Method
POST

### Endpoint
/message/sendSticker/:instance

### Parameters
#### Request Body
- **number** (string) - Required - Recipient's number (e.g., 5511999998888).
- **sticker** (string) - Required - Public URL of the WebP file.
- **delay** (number) - Optional - Delay in milliseconds before sending (max: 300000).
- **notConvertSticker** (boolean) - Optional - If true, does not attempt to convert the file before sending.
- **quoted** (object) - Optional - Message to reply to (key.id required).
- **mentionsEveryone** (boolean) - Optional - Mention everyone in groups.
- **mentioned** (string[]) - Optional - List of JIDs to mention.

### Request Example
```json
{
  "number": "551199998888",
  "sticker": "https://example.com/sticker.webp"
}
```
```

--------------------------------

### Send Contact Message using cURL

Source: https://whatsmiau.dev/docs

Use this endpoint to send contact information to a recipient. Ensure the 'number' and 'contact' fields are correctly formatted.

```bash
curl -X POST https://api.whatsmiau.dev/v2/message/sendContact/Marketing01 \
  -H "apikey: KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "number": "551199998888",
  "contact": [
    {
      "fullName": "Ivo Silva",
      "phoneNumber": "5511999997777",
      "organization": "Verboo",
      "email": "ivo@verboo.com.br"
    }
  ]'
}
```

--------------------------------

### send_reaction

Source: https://whatsmiau.dev/docs

Reacts to a message with an emoji.

```APIDOC
## send_reaction

### Description
Reacts to a message with an emoji.

### Parameters
(Parameters not specified in the source text, only a reference to 'Ver parâmetros →')
```

--------------------------------

### Send Sticker Message

Source: https://whatsmiau.dev/docs

Send a sticker from a public URL. The sticker must be in WebP format for direct use; other formats may be converted. You can optionally set a delay before sending or prevent automatic conversion.

```cURL
curl -X POST https://api.whatsmiau.dev/v2/message/sendSticker/Marketing01 \
  -H "apikey: KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "number": "551199998888",
  "sticker": "https://example.com/sticker.webp"
}'

```

--------------------------------

### Send Reaction

Source: https://whatsmiau.dev/docs

Reacts to a specific message with an emoji.

```APIDOC
## POST /message/sendReaction/:instance

### Description
Reacts to a specific message with an emoji.

### Method
POST

### Endpoint
/message/sendReaction/:instance

### Parameters
#### Request Body
- **reaction** (string) - Required - Reaction emoji (e.g., 👍, ❤️). 1-character string.
- **key** (object) - Required - Key of the target message.
  - **remoteJid** (string) - Required - Chat JID (e.g., 5511...@s.whatsapp.net).
  - **id** (string) - Required - Target message ID.
  - **fromMe** (boolean) - Required - Whether the message was sent by you.

### Request Example
```json
{
  "reaction": "👍",
  "key": {
    "remoteJid": "5511999998888@s.whatsapp.net",
    "id": "3EB0XXXXXXXX",
    "fromMe": false
  }
}
```
```

--------------------------------

### send_media_message

Source: https://whatsmiau.dev/docs

Sends images or documents from a URL.

```APIDOC
## send_media_message

### Description
Sends images or documents from a URL.

### Parameters
(Parameters not specified in the source text, only a reference to 'Ver parâmetros →')
```

--------------------------------

### Send List Message

Source: https://whatsmiau.dev/docs

Sends a message with interactive list buttons. This is useful for presenting options to the user in a structured format.

```APIDOC
## POST /message/sendList/:instance

### Description
Sends a message with interactive list buttons. Supports sections with selectable rows.

### Method
POST

### Endpoint
/message/sendList/:instance

### Parameters
#### Request Body
- **number** (string) - Required - Recipient's number (e.g., 5511999998888).
- **title** (string) - Optional - Title of the message.
- **description** (string) - Required - Body/description of the message.
- **buttonText** (string) - Optional - Text for the button that opens the list.
- **footerText** (string) - Optional - Footer text.
- **sections** (array) - Required - List sections, each with title and rows.
  - **sections[].title** (string) - Optional - Section title.
  - **sections[].rows** (array) - Required - Rows within a section.
    - **sections[].rows[].title** (string) - Required - Option title.
    - **sections[].rows[].description** (string) - Optional - Option description.
    - **sections[].rows[].rowId** (string) - Required - Unique option ID (returned in webhook).

### Request Example
```json
{
  "number": "551199998888",
  "title": "Nossos Planos",
  "description": "Escolha o plano ideal para você:",
  "buttonText": "Ver opções",
  "footerText": "Whatsmiau Cloud",
  "sections": [
    {
      "title": "Planos",
      "rows": [
        { "title": "Starter", "description": "R$ 30/mês - 1 instância", "rowId": "plan_starter" },
        { "title": "Pro", "description": "R$ 90/mês - 5 instâncias", "rowId": "plan_pro" },
        { "title": "Enterprise", "description": "R$ 200/mês - 15 instâncias", "rowId": "plan_enterprise" }
      ]
    }
  ]
}
```
```

--------------------------------

### Webhook Envelope Structure

Source: https://whatsmiau.dev/docs

The standard envelope structure for all webhook events, including event type, instance ID, payload data, timestamp, sender, and server URL.

```json
{
  "event": string,           // Tipo do evento (ex: "messages.upsert")
  "instance": string,        // ID da instância
  "data": T,                 // Payload específico do evento (ver abaixo)
  "date_time": string,       // Timestamp ISO 8601
  "sender": string,          // Remetente (quando aplicável)
  "server_url": string       // URL do servidor
}
```

--------------------------------

### Send List Message

Source: https://whatsmiau.dev/docs

Sends an interactive message with a list of options for the user to select. Ideal for menus, catalogs, and simple forms.

```APIDOC
## POST /message/sendList/:instance

### Description
Sends an interactive message with a list of options for the user to select. Ideal for menus, catalogs, and simple forms.

### Method
POST

### Endpoint
/message/sendList/:instance
```

--------------------------------

### send_text_message

Source: https://whatsmiau.dev/docs

Sends text messages with WhatsApp formatting (bold, italic, etc.).

```APIDOC
## send_text_message

### Description
Sends text messages with WhatsApp formatting (bold, italic, etc.).

### Parameters
(Parameters not specified in the source text, only a reference to 'Ver parâmetros →')
```

--------------------------------

### Send Contact Message

Source: https://whatsmiau.dev/docs

Sends one or more contact cards (vCard). For multiple contacts, send a single array.

```APIDOC
## POST /message/sendContact/:instance

### Description
Sends one or more contact cards (vCard). For multiple contacts, send a single array - WhatsApp automatically groups them.

### Method
POST

### Endpoint
/message/sendContact/:instance

### Parameters
#### Request Body
- **number** (string) - Required - Recipient's number (e.g., 5511999998888).
- **contact** (object or array) - Required - Contact information or an array of contact information.
  - **contact[].name** (string) - Required - Contact name.
  - **contact[].phoneNumber** (string) - Required - Contact phone number.

### Request Example (Single Contact)
```json
{
  "number": "551199998888",
  "contact": {
    "name": "John Doe",
    "phoneNumber": "5511987654321"
  }
}
```

### Request Example (Multiple Contacts)
```json
{
  "number": "551199998888",
  "contact": [
    {
      "name": "John Doe",
      "phoneNumber": "5511987654321"
    },
    {
      "name": "Jane Smith",
      "phoneNumber": "5511912345678"
    }
  ]
}
```
```

--------------------------------

### Verify WhatsApp Number

Source: https://whatsmiau.dev/docs

Checks if a given phone number is registered with WhatsApp.

```APIDOC
## POST /chat/whatsappNumbers/:instance

### Description
Checks if a given phone number is registered with WhatsApp.

### Method
POST

### Endpoint
/chat/whatsappNumbers/:instance

### Parameters
#### Request Body
- **numbers** (string[]) - Required - A list of phone numbers to verify.

### Request Example
```json
{
  "numbers": ["551199998888"]
}
```
```
Tokens:
Raw