NODAPI

Enviar Mensagem

Enviar mídia (imagem, vídeo, áudio ou documento)

POST/send/media
  • Conta no limite de envio da conexão. Ao passar do limite, a resposta é 429.

Autenticação: envie a chave da conexão no header token ou em Authorization: Bearer.

Envia diferentes tipos de mídia para um contato, grupo ou canal/newsletter. Suporta URLs ou arquivos base64.

Tipos de Mídia Suportados

  • `image`: Imagens (JPG preferencialmente)
  • `video`: Vídeos (apenas MP4)
  • `videoplay`: Vídeo com comportamento visual de autoplay/loop no WhatsApp
  • `document`: Documentos (PDF, DOCX, XLSX, etc)
  • `audio`: Áudio comum (MP3 ou OGG)
  • `myaudio`: Mensagem de voz (alternativa ao PTT)
  • `ptt`: Mensagem de voz (Push-to-Talk)
  • `ptv`: Mensagem de vídeo (Push-to-Video)
  • `sticker`: Figurinha/Sticker

Recursos Específicos

  • Upload por URL ou base64
  • Caption/legenda opcional com suporte a placeholders
  • Nome personalizado para documentos (docName)
  • Geração automática de thumbnails
  • Compressão otimizada conforme o tipo
  • `viewOnce` recomendado para mídia compatível

Envio para Newsletter

Para enviar mídia para um canal, use o mesmo campo number, mas informe o JID completo do canal:

  • Exemplo: 120363123456789012@newsletter
{
  "number": "120363123456789012@newsletter",
  "type": "image",
  "file": "https://exemplo.com/foto.jpg",
  "text": "Imagem publicada no canal"
}

Campos Comuns

Este endpoint suporta todos os campos opcionais comuns documentados na tag "Enviar Mensagem", incluindo: delay, readchat, readmessages, replyid, mentions, forward, track_source, track_id, placeholders e envio para grupos.

Exemplos Básicos

Visualização Única (viewOnce)

O campo viewOnce é recomendado quando quiser mídia de visualização única e hoje produz efeito para os tipos: image, video, videoplay, ptv, audio, myaudio e ptt.

Para document, sticker e demais endpoints de envio, o campo é ignorado silenciosamente.

Imagem Simples

{
  "number": "5511999999999",
  "type": "image",
  "file": "https://exemplo.com/foto.jpg"
}

Documento com Nome

{
  "number": "5511999999999",
  "type": "document",
  "file": "https://exemplo.com/contrato.pdf",
  "docName": "Contrato.pdf",
  "text": "Segue o documento solicitado"
}

Corpo da requisição (JSON)

CampoTipoDescrição
number*string

ID do chat para o qual a mensagem será enviada. Pode ser um número de telefone em formato internacional, um ID de grupo (@g.us), um ID de usuário (com @s.whatsapp.net ou @lid) ou um ID de canal/newsletter (@newsletter).

Exemplo: 5511999999999

type*string

Tipo de mídia (image, video, videoplay, document, audio, myaudio, ptt, ptv, sticker)

Exemplo: image

file*string

URL ou base64 do arquivo

Exemplo: https://exemplo.com/imagem.jpg

textstring

Texto descritivo (caption) - aceita placeholders

Exemplo: Veja esta foto!

docNamestring

Nome do arquivo (apenas para documents)

Exemplo: relatorio.pdf

thumbnailstring

URL ou base64 de thumbnail personalizado para vídeos e documentos

Exemplo: https://exemplo.com/thumb.jpg

mimetypestring

MIME type do arquivo (opcional, detectado automaticamente)

Exemplo: application/pdf

replyidstring

ID da mensagem para responder

Exemplo: 3EB0538DA65A59F6D8A251

mentionsstring

Números para mencionar (separados por vírgula)

Exemplo: 5511999999999,5511888888888

readchatboolean

Marca conversa como lida após envio

Exemplo: true

readmessagesboolean

Marca últimas mensagens recebidas como lidas

Exemplo: true

delayinteger

Atraso em milissegundos antes do envio, durante o atraso apacerá 'Digitando...' ou 'Gravando áudio...'

Exemplo: 1000

forwardboolean

Marca a mensagem como encaminhada no WhatsApp

Exemplo: true

track_sourcestring

Origem do rastreamento da mensagem

Exemplo: chatwoot

track_idstring

ID para rastreamento da mensagem (aceita valores duplicados)

Exemplo: msg_123456789

asyncboolean

Se true, envia a mensagem de forma assíncrona via fila interna

Exemplo: false

viewOnceboolean

Recomendado para mídia com visualização única em tipos compatíveis (image, video, videoplay, ptv, audio, myaudio, ptt). Em tipos não compatíveis, o campo é ignorado silenciosamente.

Exemplo: false

* obrigatório

Exemplos de corpo

Imagem

{
  "number": "5511999999999",
  "type": "image",
  "file": "https://exemplo.com/foto.jpg"
}

Imagem com legenda

{
  "number": "5511999999999",
  "type": "image",
  "file": "https://exemplo.com/foto.jpg",
  "text": "Veja esta foto!"
}

Imagem view once

{
  "number": "5511999999999",
  "type": "image",
  "file": "https://exemplo.com/foto.jpg",
  "text": "Abra uma vez",
  "viewOnce": true
}

Documento

{
  "number": "5511999999999",
  "type": "document",
  "file": "https://exemplo.com/contrato.pdf",
  "docName": "Contrato.pdf",
  "text": "Segue o documento solicitado"
}

Mensagem de voz

{
  "number": "5511999999999",
  "type": "ptt",
  "file": "https://exemplo.com/audio.ogg"
}

Vídeo

{
  "number": "5511999999999",
  "type": "video",
  "file": "https://exemplo.com/video.mp4",
  "text": "Confira este vídeo!"
}

Vídeo com autoplay

{
  "number": "5511999999999",
  "type": "videoplay",
  "file": "https://exemplo.com/video.mp4",
  "text": "Confira este vídeo"
}

Mensagem de vídeo

{
  "number": "5511999999999",
  "type": "ptv",
  "file": "https://exemplo.com/video.mp4"
}

Figurinha

{
  "number": "5511999999999",
  "type": "sticker",
  "file": "https://exemplo.com/sticker.webp"
}

Imagem para newsletter

{
  "number": "120363123456789012@newsletter",
  "type": "image",
  "file": "https://exemplo.com/foto.jpg",
  "text": "Imagem publicada no canal"
}

Documento para newsletter

{
  "number": "120363123456789012@newsletter",
  "type": "document",
  "file": "https://exemplo.com/contrato.pdf",
  "docName": "Contrato.pdf",
  "text": "Documento publicado no canal"
}

Respostas

  • 200Mídia enviada com sucesso
  • 400Requisição inválida
  • 401Não autorizado
  • 413Arquivo muito grande
  • 415Formato de mídia não suportado
  • 500Erro interno do servidor

Experimente

Atenção: a chamada é real. Ela roda na sua conexão e pode enviar mensagem de verdade. A chave fica só nesta tela e some ao sair dela; nunca é guardada.

Cole a chave gerada no painel.