Mensagens
Envio e manipulação de mensagens: texto, mídia, enquetes, localização, contatos, figurinhas, reações, edição, leitura e presença.
63 endpoints
/instances/:id/messages
→
Enviar texto
Com queue, delayMessage, delayTyping ou idempotencyKey, responde 202 com um job. Caso contrário envia na hora.
/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.
/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.
/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.
/instances/:id/messages/:messageId/reaction
→
Remover a reação
Remove a reação atual de uma mensagem.
/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.
/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.
/instances/:id/messages/:messageId/forward
→
Reencaminhar uma mensagem
Reencaminha uma mensagem recente para outro contato ou grupo.
/instances/:id/messages/poll
→
Enviar uma enquete
Envia uma enquete com 2 a 12 opções e define quantas podem ser selecionadas.
/instances/:id/messages/location
→
Enviar uma localização
Envia uma localização com latitude, longitude, nome e endereço opcionais.
/instances/:id/messages/contact
→
Enviar um contato
Envia um contato em formato vCard com nome, telefone e organização opcional.
/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.
/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.
/instances/:id/presence
→
Atualizar presença
Atualiza a presença do número: digitando, pausado, disponível ou indisponível.
/instances/:id/messages/gif
→
Enviar GIF
Envia um GIF (vídeo com reprodução automática).
/instances/:id/messages/ptv
→
Enviar vídeo circular
Envia um vídeo circular (PTV).
/instances/:id/messages/link
→
Enviar link com preview
Envia um texto com URL para gerar preview de link.
/instances/:id/messages/contacts
→
Enviar múltiplos contatos
Envia múltiplos contatos em vCard.
/instances/:id/messages/product
→
Enviar produto do catálogo
Envia um produto do catálogo em uma mensagem.
/instances/:id/messages/event
→
Enviar evento
Envia um evento de calendário em um chat ou grupo.
/instances/:id/messages/pin
→
Fixa/desafixa mensagem
Fixa ou desafixa uma mensagem no chat.
/instances/:id/messages/buttons
→
Enviar botões interativos
Envia botões via relay nativo; renderização experimental conforme versão e conta do destinatário.
/instances/:id/messages/buttons/list
→
Enviar botões interativos
Envia botões interativos (experimental).
/instances/:id/messages/buttons/image
→
Enviar botões interativos
Envia botões interativos (experimental).
/instances/:id/messages/buttons/video
→
Enviar botões interativos
Envia botões interativos (experimental).
/instances/:id/messages/options-list
→
Listar de seleção
Lista de seleção (experimental).
/instances/:id/messages/pix
→
Copia código Pix fornecido
Envia o código fornecido pelo integrador. Não gera, valida ou autentica OTP; não processa nem confirma pagamentos Pix.
/instances/:id/messages/otp
→
Copia código fornecido
Envia o código fornecido pelo integrador. Não gera, valida ou autentica OTP; não processa nem confirma pagamentos Pix.
/instances/:id/messages/carousel
→
Carrossel interativo
Carrossel interativo não é exposto pelo Baileys.
/instances/:id/messages/order
→
Compartilha pedido
totalAmount1000 usa milésimos da moeda (R$23,90 = 23900). Token e dados comerciais precisam ser fornecidos pelo integrador.
/instances/:id/messages/reply-button
→
Responde interação
Responde interação (experimental).
/instances/:id/messages/reply-template-button
→
Responde interação
Responde interação (experimental).
/instances/:id/messages/reply-option-list
→
Responde interação
Responde interação (experimental).
/instances/:id/messages/newsletter-admin-invite
→
Compartilha convite de canal
Compartilha a mensagem de convite. Não concede privilégios nem substitui uma autorização válida no canal.
/instances/:id/messages/request-phone
→
Solicita telefone
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/request-location
→
Solicita localização
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/webview
→
Enviar botão WebView
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/catalog/share
→
Compartilha catálogo
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/pix-details
→
Enviar cartão Pix estático
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64. Metadados de chave Pix estática; não cria cobrança bancária nem confirma pagamento.
/instances/:id/messages/order-details
→
Enviar pedido detalhado
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64. Valores amount100/tax100/shipping100/discount100 são inteiros em centavos; totais calculados com precisão. Não confirma pagamento.
/instances/:id/messages/live-location
→
Enviar amostra de localização ao vivo
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64. Emite uma amostra com sequência; não ativa rastreamento de GPS nem estabelece ciclo de compartilhamento automaticamente.
/instances/:id/messages/scheduled-call
→
Enviar convite de chamada agendada
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/scheduled-call/cancel
→
Cancelar convite de chamada agendada
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/keep
→
Mantém mensagem temporária
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/unkeep
→
Desfaz manter mensagem
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/star
→
Favorita mensagem
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/unstar
→
Remover favorito
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/link-preview
→
Enviar preview personalizado
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/ad
→
Enviar contexto de anúncio
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/rich-title
→
Enviar mensagem com título
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/catalog
→
Enviar cartão de catálogo
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/catalog/collection
→
Enviar coleção de catálogo
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/album
→
Enviar álbum nativo
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64. De 2 a 10 itens; falha parcial retorna partial_album com quantidade enviada.
/instances/:id/messages/poll/vote
→
Vota em enquete existente
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64. options contém seleções existentes; array vazio retira o voto. Exige mensagem original e segredo no cache; não altera a definição da enquete.
/instances/:id/messages/reply/text
→
Responde citando texto
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/reply/contact
→
Responde citando contato
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/reply/contacts
→
Responde citando contatos
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/reply/location
→
Responde citando localização
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/reply/image
→
Responde citando image
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/reply/video
→
Responde citando video
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/reply/audio
→
Responde citando audio
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/reply/document
→
Responde citando document
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
/instances/:id/messages/reply/sticker
→
Responde citando sticker
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.