Skip to main content
POST
/
user
/
whatsapp
/
send
curl -X POST "https://suasofia.online/api/user/whatsapp/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sender_id": 12,
    "template_id": 45,
    "recipient_phone": "+1234567890",
    "recipient_name": "João Silva",
    "variables": {
      "1": "João",
      "2": "15 de janeiro, 2026",
      "3": "14:00"
    }
  }'
{
  "success": true,
  "conversation_id": 1234,
  "message_id": 567,
  "whatsapp_message_id": 890,
  "message_sid": "SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "status": "queued"
}
Este endpoint envia uma mensagem do WhatsApp usando um template pré-aprovado. Mensagens de template são necessárias ao iniciar uma conversa com um usuário pela primeira vez ou ao enviar mensagens fora da janela de mensagens de 24 horas.
Este endpoint tem limite de taxa de 5 requisições por segundo por usuário.

Corpo da Requisição

sender_id
integer
required
O ID do remetente WhatsApp para enviar (obtido do endpoint Obter Remetentes)
template_id
integer
required
O ID do template de mensagem a ser usado (obtido do endpoint Obter Templates)
recipient_phone
string
required
O número de telefone do destinatário em formato internacional (ex: +1234567890)
recipient_name
string
O nome do destinatário, máximo 255 caracteres (usado para rastreamento de conversa e finalidades de CRM)
variables
object
Pares chave-valor para variáveis do template. As chaves devem corresponder aos nomes das variáveis do template. Se o template tiver variáveis {{1}}, {{2}}, etc., forneça-as como {"1": "valor1", "2": "valor2"} ou usando as chaves nomeadas do array variables do template.

Campos da Resposta

success
boolean
Se a mensagem foi enviada com sucesso
conversation_id
integer
O ID da conversa (nova ou existente) associada a esta mensagem
message_id
integer
O ID do registro de mensagem da conversa
whatsapp_message_id
integer
O ID do registro da mensagem WhatsApp
message_sid
string
O SID da mensagem Twilio para rastreamento de entrega
status
string
O status inicial de entrega da mensagem (ex: queued, sent)

Respostas de Erro

402 Saldo Insuficiente
404 Não Encontrado
422 Entidade Não Processável
curl -X POST "https://suasofia.online/api/user/whatsapp/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sender_id": 12,
    "template_id": 45,
    "recipient_phone": "+1234567890",
    "recipient_name": "João Silva",
    "variables": {
      "1": "João",
      "2": "15 de janeiro, 2026",
      "3": "14:00"
    }
  }'
{
  "success": true,
  "conversation_id": 1234,
  "message_id": 567,
  "whatsapp_message_id": 890,
  "message_sid": "SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "status": "queued"
}

Observações

  • Mensagens de template devem usar templates aprovados. Templates com status pendente ou rejeitado falharão.
  • O remetente deve estar online. Remetentes offline não podem enviar mensagens.
  • Os custos das mensagens são automaticamente deduzidos do saldo da sua conta (créditos para usuários tenant, minutos para usuários diretos).
  • Após enviar uma mensagem de template, uma janela de mensagens de 24 horas se abre. Durante esta janela, você pode enviar mensagens livres sem precisar de um template.
  • Se uma conversa já existe com o destinatário, a mensagem é adicionada à conversa existente.
  • Limite de taxa: 5 requisições por segundo por usuário.