Skip to content

API — Mensagens

GET /v2/api/external/{ApiID}/params/

Query params disponíveis:

ParâmetroDescrição
bodyTexto da mensagem
numberNúmero do destinatário (formato: 5511999999999)
externalKeyChave única do seu sistema para controle do envio
bearertokenToken de autenticação
isClosedDefine se o ticket será fechado após o envio
POST /v2/api/external/{ApiID}

Body JSON (exemplo):

{
"number": "5511999999999",
"body": "Olá! Como posso ajudar?",
"externalKey": "ref-123"
}
POST /v2/api/external/{ApiID}/url

Body JSON (exemplo):

{
"number": "5511999999999",
"body": "Segue o documento:",
"mediaUrl": "https://exemplo.com/arquivo.pdf",
"fileName": "documento.pdf"
}
POST /v2/api/external/{ApiID}/voice

Body JSON:

{
"number": "5511999999999",
"mediaUrl": "https://exemplo.com/audio.mp3"
}
POST /v2/api/external/{ApiID}/base64

Body JSON:

{
"number": "5511999999999",
"body": "Imagem em base64",
"mediaBase64": "data:image/jpeg;base64,/9j/4AAQ...",
"fileName": "imagem.jpg"
}
  1. Sempre verificar status do canal antes de enviar (showChannel ou listChannels)
  2. Usar externalKey único por mensagem para rastreabilidade
  3. Usar sendPresence com type: "composing" antes de responder para parecer mais humano
  4. Definir isClosed: true no envio para fechar ticket automaticamente após resposta