API — Mensagens
API — Mensagens
Section titled “API — Mensagens”Parâmetros de Envio (GET)
Section titled “Parâmetros de Envio (GET)”GET /v2/api/external/{ApiID}/params/Query params disponíveis:
| Parâmetro | Descrição |
|---|---|
body | Texto da mensagem |
number | Número do destinatário (formato: 5511999999999) |
externalKey | Chave única do seu sistema para controle do envio |
bearertoken | Token de autenticação |
isClosed | Define se o ticket será fechado após o envio |
Enviar Mensagem de Texto
Section titled “Enviar Mensagem de Texto”POST /v2/api/external/{ApiID}Body JSON (exemplo):
{ "number": "5511999999999", "body": "Olá! Como posso ajudar?", "externalKey": "ref-123"}Enviar Arquivo via URL
Section titled “Enviar Arquivo via URL”POST /v2/api/external/{ApiID}/urlBody JSON (exemplo):
{ "number": "5511999999999", "body": "Segue o documento:", "mediaUrl": "https://exemplo.com/arquivo.pdf", "fileName": "documento.pdf"}Enviar Mensagem de Voz (Áudio)
Section titled “Enviar Mensagem de Voz (Áudio)”POST /v2/api/external/{ApiID}/voiceBody JSON:
{ "number": "5511999999999", "mediaUrl": "https://exemplo.com/audio.mp3"}Enviar Arquivo em Base64
Section titled “Enviar Arquivo em Base64”POST /v2/api/external/{ApiID}/base64Body JSON:
{ "number": "5511999999999", "body": "Imagem em base64", "mediaBase64": "data:image/jpeg;base64,/9j/4AAQ...", "fileName": "imagem.jpg"}Boas Práticas
Section titled “Boas Práticas”- Sempre verificar status do canal antes de enviar (
showChanneloulistChannels) - Usar
externalKeyúnico por mensagem para rastreabilidade - Usar
sendPresencecomtype: "composing"antes de responder para parecer mais humano - Definir
isClosed: trueno envio para fechar ticket automaticamente após resposta
Próximos Passos
Section titled “Próximos Passos”- Mensagens em Grupo — Envie para grupos
- Tickets — Gerencie atendimentos