API de Mensagens

Documentação completa dos endpoints para enviar e gerenciar mensagens WhatsApp.

📋 Índice

Enviar Mensagens

Enviar Texto
Enviar Link com Preview
Enviar Mídia
Enviar Enquete (Poll)
Enviar Sticker
Enviar Localização
Enviar Contato
~~Enviar Botões~~ ⚠️ DEPRECIADO
~~Enviar Lista~~ ⚠️ DEPRECIADO

Enviar Mensagens

Enviar Texto

Envia uma mensagem de texto simples.

Endpoint: POST /send/text

Headers:

Content-Type: application/json
apikey: SUA-CHAVE-API

Body:

{
  "number": "5511999999999",
  "text": "Olá! Como posso ajudar?",
  "id": "msg-custom-123",
  "delay": 1000,
  "mentionedJid": "5511888888888@s.whatsapp.net",
  "mentionAll": false,
  "formatJid": true,
  "quoted": {
    "messageId": "BAE5...",
    "participant": "5511999999999@s.whatsapp.net"
  }
}

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`number`	string	✅ Sim	Número do destinatário (formato: DDI + DDD + número)
`text`	string	✅ Sim	Texto da mensagem
`id`	string	❌ Não	ID customizado (se vazio, será gerado automaticamente)
`delay`	int32	❌ Não	Delay em milissegundos antes de enviar
`mentionedJid`	string	❌ Não	JID do usuário a mencionar
`mentionAll`	bool	❌ Não	Mencionar todos os participantes (apenas grupos)
`formatJid`	bool	❌ Não	Formatar número automaticamente (padrão: true)
`quoted`	object	❌ Não	Mensagem a ser citada

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "Info": {
      "ID": "3EB0C5A277F7F9B6C599",
      "ServerID": 12345,
      "Timestamp": "2025-11-11T10:30:00Z",
      "Type": "ExtendedTextMessage"
    }
  }
}

Resposta de Erro (400):

{
  "error": "phone number is required"
}

Exemplo cURL:

curl -X POST http://localhost:4000/send/text \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "text": "Olá! Esta é uma mensagem de teste."
  }'

Enviar Link com Preview

Envia uma mensagem com preview de link (título, descrição, imagem).

Endpoint: POST /send/link

Body:

{
  "number": "5511999999999",
  "text": "Confira este artigo: https://example.com/artigo",
  "title": "Título do Link",
  "url": "https://example.com/artigo",
  "description": "Descrição do conteúdo",
  "imgUrl": "https://example.com/imagem.jpg"
}

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`number`	string	✅ Sim	Número do destinatário
`text`	string	✅ Sim	Texto com URL
`title`	string	❌ Não	Título do preview (extraído automaticamente se vazio)
`url`	string	❌ Não	URL do link
`description`	string	❌ Não	Descrição (extraída automaticamente se vazia)
`imgUrl`	string	❌ Não	URL da imagem de preview

Nota: Se title, description ou imgUrl não forem fornecidos, o sistema tentará extrair automaticamente os metadados Open Graph da URL.

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "Info": {
      "ID": "3EB0C5A277F7F9B6C599",
      "Type": "ExtendedTextMessage"
    }
  }
}

Exemplo cURL:

curl -X POST http://localhost:4000/send/link \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "text": "Veja esta notícia: https://g1.globo.com/tecnologia"
  }'

Enviar Mídia

Envia imagem, vídeo, áudio ou documento. Suporta envio via URL ou arquivo local (multipart/form-data).

Endpoint: POST /send/media

Opção 1: Enviar por URL

Body (JSON):

{
  "number": "5511999999999",
  "url": "https://example.com/imagem.jpg",
  "type": "image",
  "caption": "Confira esta imagem!",
  "filename": "foto.jpg"
}

Opção 2: Enviar Arquivo (multipart/form-data)

Body (form-data):

number: 5511999999999
type: image
caption: Confira esta imagem!
filename: foto.jpg
file: [arquivo binário]
delay: 0

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`number`	string	✅ Sim	Número do destinatário
`type`	string	✅ Sim	Tipo: `image`, `video`, `audio`, `document`
`url`	string	✅ Sim (URL)	URL da mídia (se não enviar arquivo)
`file`	binary	✅ Sim (arquivo)	Arquivo binário (se não enviar URL)
`caption`	string	❌ Não	Legenda da mídia
`filename`	string	❌ Não	Nome do arquivo

Tipos de Mídia Aceitos:

Tipo	Formatos Aceitos	Observações
`image`	JPG, PNG, WebP	WebP convertido para JPEG
`video`	MP4, GIF	MP4. GIF URLs são convertidos automaticamente para vídeo com `GifPlayback`
`audio`	Qualquer	Convertido para Opus (PTT) automaticamente
`document`	Qualquer	Qualquer tipo de arquivo

Áudio: O sistema converte automaticamente qualquer formato de áudio para Opus (formato PTT do WhatsApp). Pode usar conversor local (ffmpeg) ou API externa (configurável via API_AUDIO_CONVERTER).

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "Info": {
      "ID": "3EB0C5A277F7F9B6C599",
      "Type": "ImageMessage"
    }
  }
}

Resposta de Erro (400):

{
  "error": "Invalid file format: 'image/gif'. Only 'image/jpeg', 'image/png' and 'image/webp' are accepted"
}

Exemplo cURL (URL):

curl -X POST http://localhost:4000/send/media \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "url": "https://exemplo.com/produto.jpg",
    "type": "image",
    "caption": "Novo produto disponível!"
  }'

Exemplo cURL (Arquivo):

curl -X POST http://localhost:4000/send/media \
  -H "apikey: SUA-CHAVE-API" \
  -F "number=5511999999999" \
  -F "type=image" \
  -F "caption=Foto enviada" \
  -F "file=@/caminho/para/imagem.jpg"

Enviar Enquete

Cria uma enquete (poll) com múltiplas opções.

Endpoint: POST /send/poll

Body:

{
  "number": "5511999999999",
  "question": "Qual seu horário preferido?",
  "maxAnswer": 1,
  "options": [
    "Manhã (8h-12h)",
    "Tarde (13h-18h)",
    "Noite (19h-22h)"
  ]
}

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`number`	string	✅ Sim	Número do destinatário
`question`	string	✅ Sim	Pergunta da enquete
`options`	array	✅ Sim	Opções (mínimo 2)
`maxAnswer`	int	❌ Não	Número máximo de respostas permitidas

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "Info": {
      "ID": "3EB0C5A277F7F9B6C599",
      "Type": "PollCreationMessage"
    }
  }
}

Resposta de Erro (400):

{
  "error": "minimum 2 options are required"
}

Exemplo cURL:

curl -X POST http://localhost:4000/send/poll \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "question": "Qual plano você prefere?",
    "maxAnswer": 1,
    "options": ["Básico", "Intermediário", "Premium"]
  }'

Enviar Sticker

Envia um sticker (figurinha) via URL.

Endpoint: POST /send/sticker

Body:

{
  "number": "5511999999999",
  "sticker": "https://example.com/video.mp4",
  "transparentColor": "#000000"
}

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`number`	string	✅ Sim	Número do destinatário
`sticker`	string	✅ Sim	URL da imagem ou vídeo (convertida para WebP automaticamente)
`transparentColor`	string	❌ Não	Cor em Hex (ex: #000000) para tornar transparente (útil para vídeos)

Nota:

O sistema converte automaticamente imagens e vídeos (MP4) para o formato WebP (formato de sticker do WhatsApp).
Vídeos são convertidos para stickers animados.
O parâmetro transparentColor permite remover o fundo de uma cor específica durante a conversão.

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "Info": {
      "ID": "3EB0C5A277F7F9B6C599",
      "Type": "StickerMessage"
    }
  }
}

Exemplo cURL:

# Sticker estático (Imagem)
curl -X POST http://localhost:4000/send/sticker \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "sticker": "https://exemplo.com/figurinha.png"
  }'

# Sticker animado (Vídeo com fundo removido)
curl -X POST http://localhost:4000/send/sticker \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "sticker": "https://exemplo.com/video.mp4",
    "transparentColor": "#000000"
  }'

Enviar Localização

Envia uma localização geográfica.

Endpoint: POST /send/location

Body:

{
  "number": "5511999999999",
  "name": "Escritório Central",
  "address": "Av. Paulista, 1000 - São Paulo, SP",
  "latitude": -23.5505199,
  "longitude": -46.6333094
}

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`number`	string	✅ Sim	Número do destinatário
`latitude`	float64	✅ Sim	Latitude da localização
`longitude`	float64	✅ Sim	Longitude da localização
`name`	string	✅ Sim	Nome do local
`address`	string	✅ Sim	Endereço do local

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "Info": {
      "ID": "3EB0C5A277F7F9B6C599",
      "Type": "LocationMessage"
    }
  }
}

Exemplo cURL:

curl -X POST http://localhost:4000/send/location \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "name": "Teatro Municipal",
    "address": "Praça Ramos de Azevedo, São Paulo",
    "latitude": -23.5454614,
    "longitude": -46.6369813
  }'

Enviar Contato

Envia um cartão de contato (VCard).

Endpoint: POST /send/contact

Body:

{
  "number": "5511999999999",
  "vcard": {
    "fullName": "João Silva",
    "phone": "5511888888888",
    "organization": "Empresa LTDA"
  }
}

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`number`	string	✅ Sim	Número do destinatário
`vcard.fullName`	string	✅ Sim	Nome completo do contato
`vcard.phone`	string	✅ Sim	Telefone do contato
`vcard.organization`	string	❌ Não	Empresa/organização

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "Info": {
      "ID": "3EB0C5A277F7F9B6C599",
      "Type": "ContactMessage"
    }
  }
}

Exemplo cURL:

curl -X POST http://localhost:4000/send/contact \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "vcard": {
      "fullName": "Maria Santos",
      "phone": "5511777777777",
      "organization": "Vendas LTDA"
    }
  }'

Enviar Botões

⚠️ ENDPOINT DEPRECIADO

Este endpoint não funciona mais. O WhatsApp descontinuou o suporte a botões interativos para contas que não são Business API oficial.

Alternativas:

Use Enquetes (Polls) para coleta de respostas

Use mensagens de texto com instruções

Para soluções avançadas, migre para WhatsApp Business API oficial

~~Envia mensagem com botões interativos. Suporta diferentes tipos de botões.~~

Endpoint: ~~POST /send/button~~

Body:

{
  "number": "5511999999999",
  "title": "Escolha uma opção",
  "description": "Selecione o que deseja fazer",
  "footer": "Powered by Evolution GO",
  "buttons": [
    {
      "type": "reply",
      "displayText": "Ver Produtos",
      "id": "btn_produtos"
    },
    {
      "type": "url",
      "displayText": "Site Oficial",
      "url": "https://exemplo.com"
    },
    {
      "type": "call",
      "displayText": "Ligar",
      "phoneNumber": "5511999999999"
    }
  ]
}

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`number`	string	✅ Sim	Número do destinatário
`title`	string	✅ Sim	Título da mensagem
`description`	string	✅ Sim	Descrição/corpo da mensagem
`footer`	string	✅ Sim	Rodapé da mensagem
`buttons`	array	✅ Sim	Array de botões (máx 3 para tipo reply)

Tipos de Botões:

Tipo	Campos Necessários	Descrição	Limitações
`reply`	`displayText`, `id`	Botão de resposta rápida	Máx 3, não pode misturar com outros tipos
`copy`	`displayText`, `copyCode`	Copiar texto	-
`url`	`displayText`, `url`	Abrir URL	-
`call`	`displayText`, `phoneNumber`	Ligar para número	-
`pix`	`name`, `key`, `keyType`, `currency`	Pagamento PIX (Brasil)	Não pode combinar com outros

Botão PIX:

{
  "type": "pix",
  "name": "Loja Exemplo",
  "key": "exemplo@pix.com",
  "keyType": "email",
  "currency": "BRL"
}

Tipos de chave PIX: phone, email, cpf, cnpj, random (EVP).

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "Info": {
      "ID": "3EB0C5A277F7F9B6C599",
      "Type": "ButtonMessage"
    }
  }
}

Resposta de Erro (400):

{
  "error": "máximo de 3 botões do tipo 'reply' permitidos"
}

Exemplo cURL:

curl -X POST http://localhost:4000/send/button \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "title": "Atendimento",
    "description": "Como podemos ajudar?",
    "footer": "Suporte 24h",
    "buttons": [
      {"type": "reply", "displayText": "Falar com Vendas", "id": "vendas"},
      {"type": "reply", "displayText": "Suporte Técnico", "id": "suporte"}
    ]
  }'

Enviar Lista

⚠️ ENDPOINT DEPRECIADO

Este endpoint não funciona mais. O WhatsApp descontinuou o suporte a listas interativas para contas que não são Business API oficial.

Alternativas:

Use Enquetes (Polls) para seleção de opções

Use mensagens de texto com numeração

Para soluções avançadas, migre para WhatsApp Business API oficial

~~Envia mensagem com menu de lista interativo.~~

Endpoint: ~~POST /send/list~~

Body:

{
  "number": "5511999999999",
  "title": "Nossos Serviços",
  "description": "Selecione um serviço",
  "buttonText": "Ver Opções",
  "footerText": "Atendimento 24h",
  "sections": [
    {
      "title": "Planos",
      "rows": [
        {
          "title": "Plano Básico",
          "description": "R$ 29,90/mês",
          "rowId": "plano_basico"
        },
        {
          "title": "Plano Premium",
          "description": "R$ 59,90/mês",
          "rowId": "plano_premium"
        }
      ]
    },
    {
      "title": "Suporte",
      "rows": [
        {
          "title": "Falar com Atendente",
          "description": "Chat ao vivo",
          "rowId": "atendente"
        }
      ]
    }
  ]
}

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`number`	string	✅ Sim	Número do destinatário
`title`	string	✅ Sim	Título da mensagem
`description`	string	✅ Sim	Descrição/corpo
`buttonText`	string	✅ Sim	Texto do botão que abre a lista
`footerText`	string	✅ Sim	Rodapé da mensagem
`sections`	array	✅ Sim	Seções da lista

Estrutura de Section:

Campo	Tipo	Obrigatório	Descrição
`title`	string	✅ Sim	Título da seção
`rows`	array	✅ Sim	Linhas da seção

Estrutura de Row:

Campo	Tipo	Obrigatório	Descrição
`title`	string	✅ Sim	Título da opção
`description`	string	❌ Não	Descrição da opção
`rowId`	string	✅ Sim	ID único da opção

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "Info": {
      "ID": "3EB0C5A277F7F9B6C599",
      "Type": "ListMessage"
    }
  }
}

Exemplo cURL:

curl -X POST http://localhost:4000/send/list \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "title": "Menu Principal",
    "description": "Escolha uma categoria",
    "buttonText": "Ver Menu",
    "footerText": "Delivery 24h",
    "sections": [
      {
        "title": "Pratos",
        "rows": [
          {"title": "Pizza", "description": "A partir de R$ 35", "rowId": "pizza"},
          {"title": "Hambúrguer", "description": "A partir de R$ 25", "rowId": "burger"}
        ]
      }
    ]
  }'

Gerenciar Mensagens

Reagir a Mensagem

Adiciona ou remove uma reação (emoji) em uma mensagem.

Endpoint: POST /message/react

Body:

{
  "number": "5511999999999",
  "reaction": "👍",
  "id": "3EB0C5A277F7F9B6C599",
  "fromMe": false,
  "participant": "5511888888888@s.whatsapp.net"
}

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`number`	string	✅ Sim	Número do chat (individual ou grupo)
`reaction`	string	✅ Sim	Emoji da reação (ou "remove" para remover)
`id`	string	✅ Sim	ID da mensagem a reagir
`fromMe`	bool	✅ Sim	Se a mensagem foi enviada por você (true/false)
`participant`	string	❌ Não	JID do autor (obrigatório em grupos quando fromMe=false)

Nota: Para remover uma reação, use "reaction": "remove".

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "Info": {
      "ID": "3EB0C5A277F7F9B6C599",
      "Type": "ReactionMessage"
    }
  }
}

Exemplo cURL:

# Adicionar reação
curl -X POST http://localhost:4000/message/react \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "reaction": "❤️",
    "id": "3EB0C5A277F7F9B6C599",
    "fromMe": false
  }'

# Remover reação
curl -X POST http://localhost:4000/message/react \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "reaction": "remove",
    "id": "3EB0C5A277F7F9B6C599",
    "fromMe": false
  }'

Marcar como Lida

Marca mensagem(ns) como lida(s).

Endpoint: POST /message/markread

Body:

{
  "number": "5511999999999",
  "id": [
    "3EB0C5A277F7F9B6C599",
    "3EB0C5A277F7F9B6C600"
  ]
}

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`number`	string	✅ Sim	Número do chat
`id`	array	✅ Sim	Array de IDs de mensagens para marcar como lidas

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "timestamp": "2025-11-11T10:30:00Z"
  }
}

Exemplo cURL:

curl -X POST http://localhost:4000/message/markread \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "id": ["3EB0C5A277F7F9B6C599"]
  }'

Editar Mensagem

Edita o conteúdo de uma mensagem enviada.

Endpoint: POST /message/edit

Body:

{
  "chat": "5511999999999@s.whatsapp.net",
  "messageId": "3EB0C5A277F7F9B6C599",
  "message": "Texto editado da mensagem"
}

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`chat`	string	✅ Sim	JID do chat
`messageId`	string	✅ Sim	ID da mensagem a editar
`message`	string	✅ Sim	Novo texto da mensagem

Nota: Só é possível editar mensagens de texto enviadas por você (fromMe=true).

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "messageId": "3EB0C5A277F7F9B6C599",
    "timestamp": "2025-11-11T10:30:00Z"
  }
}

Exemplo cURL:

curl -X POST http://localhost:4000/message/edit \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "chat": "5511999999999@s.whatsapp.net",
    "messageId": "3EB0C5A277F7F9B6C599",
    "message": "Mensagem corrigida"
  }'

Deletar Mensagem

Deleta uma mensagem para todos (revoke).

Endpoint: POST /message/delete

Body:

{
  "chat": "5511999999999@s.whatsapp.net",
  "messageId": "3EB0C5A277F7F9B6C599"
}

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`chat`	string	✅ Sim	JID do chat
`messageId`	string	✅ Sim	ID da mensagem a deletar

Nota: Só é possível deletar mensagens enviadas por você. O WhatsApp tem limite de tempo para deletar mensagens (geralmente até 1 hora).

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "messageId": "3EB0C5A277F7F9B6C599",
    "timestamp": "2025-11-11T10:30:00Z"
  }
}

Exemplo cURL:

curl -X POST http://localhost:4000/message/delete \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "chat": "5511999999999@s.whatsapp.net",
    "messageId": "3EB0C5A277F7F9B6C599"
  }'

Presença no Chat

Define o status de presença no chat (digitando, gravando áudio, online).

Endpoint: POST /message/presence

Body:

{
  "number": "5511999999999",
  "state": "composing",
  "isAudio": false
}

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`number`	string	✅ Sim	Número do chat
`state`	string	✅ Sim	Estado: `composing`, `paused`, `recording`, `available`, `unavailable`
`isAudio`	bool	❌ Não	Se true, mostra "gravando áudio" (apenas com state=composing)

Estados Disponíveis:

composing - Digitando...
paused - Para de digitar
recording - Gravando áudio (use isAudio=true)
available - Online
unavailable - Offline

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "timestamp": "2025-11-11T10:30:00Z"
  }
}

Exemplo cURL:

# Mostrar "digitando..."
curl -X POST http://localhost:4000/message/presence \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "state": "composing",
    "isAudio": false
  }'

# Mostrar "gravando áudio..."
curl -X POST http://localhost:4000/message/presence \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "state": "composing",
    "isAudio": true
  }'

# Parar de digitar
curl -X POST http://localhost:4000/message/presence \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "number": "5511999999999",
    "state": "paused"
  }'

Download de Mídia

Faz download de mídia de uma mensagem recebida e retorna em base64.

Endpoint: POST /message/downloadimage

Body:

{
  "message": {
    "imageMessage": {
      "url": "...",
      "mimetype": "image/jpeg",
      "fileSha256": "...",
      "fileLength": "..."
    }
  }
}

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`message`	object	✅ Sim	Objeto de mensagem completo (do webhook)

Tipos de Mídia Suportados:

imageMessage - Imagens
videoMessage - Vídeos
audioMessage - Áudios
documentMessage - Documentos
stickerMessage - Stickers (convertido para PNG)

Nota: O objeto message deve ser o mesmo recebido via webhook/event. Contém todas as informações necessárias para download (URL, chaves de criptografia, etc).

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "base64": "data:image/jpeg;base64,/9j/4AAQSkZJRg...",
    "timestamp": "2025-11-11T10:30:00Z"
  }
}

Exemplo cURL:

curl -X POST http://localhost:4000/message/downloadimage \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "message": {
      "imageMessage": {
        "url": "https://mmg.whatsapp.net/...",
        "mimetype": "image/jpeg",
        "fileSha256": "...",
        "fileLength": 123456
      }
    }
  }'

Status da Mensagem

Consulta o status de entrega/leitura de uma mensagem no banco de dados.

Endpoint: POST /message/status

Body:

{
  "id": "3EB0C5A277F7F9B6C599"
}

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`id`	string	✅ Sim	ID da mensagem

Nota: Requer DATABASE_SAVE_MESSAGES=true para funcionar. O sistema precisa estar salvando mensagens no banco.

Resposta de Sucesso (200):

{
  "message": "success",
  "data": {
    "result": {
      "id": "3EB0C5A277F7F9B6C599",
      "remoteJid": "5511999999999@s.whatsapp.net",
      "fromMe": true,
      "messageType": "conversation",
      "status": "READ",
      "timestamp": "2025-11-11T10:30:00Z"
    },
    "timestamp": "2025-11-11T10:31:00Z"
  }
}

Status Possíveis:

PENDING - Enviando
SENT - Enviada
DELIVERED - Entregue
READ - Lida

Exemplo cURL:

curl -X POST http://localhost:4000/message/status \
  -H "Content-Type: application/json" \
  -H "apikey: SUA-CHAVE-API" \
  -d '{
    "id": "3EB0C5A277F7F9B6C599"
  }'

Recursos Adicionais

Citação de Mensagens (Quoted)

Para citar/responder uma mensagem, adicione o objeto quoted em qualquer endpoint de envio:

{
  "number": "5511999999999",
  "text": "Respondendo sua mensagem",
  "quoted": {
    "messageId": "3EB0C5A277F7F9B6C599",
    "participant": "5511999999999@s.whatsapp.net"
  }
}

Menções em Grupos

Para mencionar usuários em grupos, use mentionedJid ou mentionAll:

{
  "number": "120363XXXXXXXXXX@g.us",
  "text": "Olá @usuario, tudo bem?",
  "mentionedJid": "5511888888888@s.whatsapp.net"
}

Ou mencionar todos:

{
  "number": "120363XXXXXXXXXX@g.us",
  "text": "@todos Reunião às 15h!",
  "mentionAll": true
}

Delay e Presença

Simule digitação antes de enviar:

{
  "number": "5511999999999",
  "text": "Mensagem com delay",
  "delay": 3000
}

Isso mostrará "digitando..." por 3 segundos antes de enviar a mensagem.

Verificação de Número

Por padrão, o sistema verifica se o número existe no WhatsApp antes de enviar (configurável via CHECK_USER_EXISTS). Se desabilitado, mensagens podem falhar silenciosamente.

Formatação de Números

O parâmetro formatJid (padrão: true) normaliza automaticamente o número:

Remove caracteres especiais
Adiciona sufixo @s.whatsapp.net
Valida formato

Para enviar para JIDs já formatados (grupos, etc), use formatJid: false.

Códigos de Erro Comuns

Código	Erro	Solução
400	`phone number is required`	Forneça o campo `number`
400	`message body is required`	Forneça o campo `text` ou conteúdo
400	`minimum 2 options are required`	Enquetes precisam de pelo menos 2 opções
400	`Invalid file format`	Formato de arquivo não suportado
500	`instance not found`	Instância não existe ou não está conectada
500	`client disconnected`	Instância desconectada, reconecte
500	`number X is not registered on WhatsApp`	Número não existe no WhatsApp

Boas Práticas

1. Usar Delay em Múltiplas Mensagens

Ao enviar várias mensagens seguidas, use o parâmetro delay para parecer mais natural:

Primeira mensagem: "delay": 1000 (1 segundo)
Segunda mensagem: "delay": 2000 (2 segundos)
Terceira mensagem: "delay": 1500 (1.5 segundos)

Isso simula o tempo que uma pessoa levaria para digitar cada mensagem.

2. Verificar Status de Conexão

Antes de enviar mensagens em massa, verifique se a instância está conectada:

curl "http://localhost:4000/instance/status" \
  -H "apikey: TOKEN-DA-INSTANCIA"

3. Tratamento de Erros

Sempre trate erros HTTP 4xx (validação) e 5xx (servidor):

400: Erro de validação (campos obrigatórios faltando, formato inválido)
500: Erro no servidor (instância desconectada, número inválido, etc)

Sempre verifique o status code da resposta e o campo error no JSON retornado.

4. Usar Webhooks

Para receber mensagens, configure webhooks em vez de polling:

WEBHOOK_URL=https://seu-servidor.com/webhook

5. Gerenciar Mídias

Para áudio, configure conversor externo para melhor performance:

API_AUDIO_CONVERTER=https://seu-conversor.com/convert
API_AUDIO_CONVERTER_KEY=sua-chave

Próximos Passos

API de Usuários - Gerenciar perfil e contatos
API de Grupos - Criar e administrar grupos
Sistema de Eventos - Receber webhooks
Referência Completa da API

Documentação gerada para Evolution GO v1.0

FilesExpand file tree

api-messages.md

Latest commit

History

api-messages.md

File metadata and controls

API de Mensagens

📋 Índice

Enviar Mensagens

Gerenciar Mensagens

Enviar Mensagens

Enviar Texto

Enviar Link com Preview

Enviar Mídia

Opção 1: Enviar por URL

Opção 2: Enviar Arquivo (multipart/form-data)

Enviar Enquete

Enviar Sticker

Enviar Localização

Enviar Contato

Enviar Botões

Enviar Lista

Gerenciar Mensagens

Reagir a Mensagem

Marcar como Lida

Editar Mensagem

Deletar Mensagem

Presença no Chat

Download de Mídia

Status da Mensagem

Recursos Adicionais

Citação de Mensagens (Quoted)

Menções em Grupos

Delay e Presença

Verificação de Número

Formatação de Números

Códigos de Erro Comuns

Boas Práticas

1. Usar Delay em Múltiplas Mensagens

2. Verificar Status de Conexão

3. Tratamento de Erros

4. Usar Webhooks

5. Gerenciar Mídias

Próximos Passos