vértice
Produto Preços Painel
Mensagens

Mensagens

Envio e manipulação de mensagens: texto, mídia, enquetes, localização, contatos, figurinhas, reações, edição, leitura e presença.

Referência

27 endpoints

POST /instances/:id/messages →

Enviar texto

Envia texto para um contato ou grupo. Com queue, delayMessage, delayTyping ou idempotencyKey, o envio passa pela fila durável e responde 202.

API key · Escopo write
POST /instances/:id/media →

Enviar imagem, vídeo, áudio ou documento

Envia imagem, vídeo, áudio ou documento por URL HTTPS ou base64. No envio pela fila, informe a mídia por URL.

API key · Escopo write
GET /instances/:id/media/:messageId →

Baixar mídia recebida

Baixa a mídia recebida que ainda está no cache local da instância, com content-type seguro e disposição inline quando possível.

API key · Escopo read
POST /instances/:id/messages/:messageId/reaction →

Reagir a uma mensagem

Adiciona uma reação de emoji a uma mensagem recente. Informe jid quando a mensagem não estiver mais no cache.

API key · Escopo write
DELETE /instances/:id/messages/:messageId/reaction →

Remover a reação

Remove a reação atual de uma mensagem.

API key · Escopo write
PATCH /instances/:id/messages/:messageId →

Editar o texto de uma mensagem

Edita o texto de uma mensagem enviada por você. Informe jid se a mensagem não estiver no cache.

API key · Escopo write
DELETE /instances/:id/messages/:messageId →

Apagar uma mensagem para todos

Apaga uma mensagem para todos. A operação depende das permissões da conta no WhatsApp.

API key · Escopo write
POST /instances/:id/messages/:messageId/forward →

Reencaminhar uma mensagem

Reencaminha uma mensagem recente para outro contato ou grupo.

API key · Escopo write
POST /instances/:id/messages/poll →

Enviar uma enquete

Envia uma enquete com 2 a 12 opções e define quantas podem ser selecionadas.

API key · Escopo write
POST /instances/:id/messages/location →

Enviar uma localização

Envia uma localização com latitude, longitude, nome e endereço opcionais.

API key · Escopo write
POST /instances/:id/messages/contact →

Enviar um contato

Envia um contato em formato vCard com nome, telefone e organização opcional.

API key · Escopo write
POST /instances/:id/messages/sticker →

Enviar uma figurinha

Envia uma figurinha a partir de uma URL HTTPS ou base64. O arquivo precisa ser compatível com o WhatsApp.

API key · Escopo write
POST /instances/:id/chats/read →

Marcar mensagens como lidas

Marca mensagens de uma conversa como lidas. Sem ids, usa as mensagens recebidas mais recentes do histórico local.

API key · Escopo write
POST /instances/:id/presence →

Atualizar presença

Atualiza a presença do número: digitando, pausado, disponível ou indisponível.

API key · Escopo write
POST /instances/:id/messages/gif →

Enviar GIF

Envia um GIF (vídeo com reprodução automática).

API key · Escopo write
POST /instances/:id/messages/ptv →

Enviar vídeo circular

Envia um vídeo circular (PTV).

API key · Escopo write
POST /instances/:id/messages/link →

Enviar link com preview

Envia um texto com URL para gerar preview de link.

API key · Escopo write
POST /instances/:id/messages/contacts →

Enviar múltiplos contatos

Envia múltiplos contatos em vCard.

API key · Escopo write
POST /instances/:id/messages/product →

Enviar produto do catálogo

Envia um produto do catálogo em uma mensagem.

API key · Escopo write
POST /instances/:id/messages/event →

Enviar evento

Envia um evento de calendário em um chat ou grupo.

API key · Escopo write
POST /instances/:id/messages/pin →

Fixa/desafixa mensagem

Fixa ou desafixa uma mensagem no chat.

API key · Escopo write
POST /instances/:id/messages/buttons →

Botões de ação

Botões interativos não são expostos pelo Baileys.

API key · Escopo write
POST /instances/:id/messages/buttons/list →

Listar de botões

Lista de botões (não suportado).

API key · Escopo write
POST /instances/:id/messages/options-list →

Listar de opções

Lista de opções (não suportado).

API key · Escopo write
POST /instances/:id/messages/carousel →

Carrossel

Carrossel interativo não é exposto pelo Baileys.

API key · Escopo write
POST /instances/:id/messages/order →

Pedido

Pedidos do catálogo não são expostos pelo Baileys.

API key · Escopo write
POST /instances/:id/messages/poll-vote →

Voto em enquete

Voto em enquete (não suportado).

API key · Escopo write