Skip to main content
A API do Tivar permite enviar mensagens de texto para qualquer número de WhatsApp de forma programática. Neste guia, você vai obter sua API Key, conectar uma integração de WhatsApp e fazer sua primeira chamada à API — tudo em menos de 5 minutos.
A API aplica um limite de 60 requisições por minuto por workspace em todos os endpoints, com exceção do POST /api/external/messages/send, que não possui rate limit próprio.
1

Obtenha sua API Key

Toda chamada à API do Tivar requer uma API Key vinculada ao seu workspace.
  1. Acesse seu workspace no Tivar.
  2. Vá em Configurações → Workspace → API Key.
  3. Copie a chave exibida — ela tem o formato sk_live_xxxxx.
Guarde sua API Key em um local seguro. Ela concede acesso completo à API do seu workspace.
2

Conecte uma integração de WhatsApp

O endpoint POST /api/v1/send-message exige que ao menos uma integração de WhatsApp esteja conectada ao seu workspace.
  1. Vá em Configurações → Integrações.
  2. Clique em Adicionar integração e selecione WhatsApp Oficial (Meta Cloud API) ou WhatsApp via UAZAPI.
  3. Siga o fluxo de autenticação do canal escolhido.
  4. Confirme que o status da integração aparece como Conectado.
Se você omitir o campo integrationId na requisição, o Tivar usará automaticamente a integração conectada mais recente do canal informado.
3

Envie uma mensagem de texto

Com a API Key e a integração prontas, faça uma requisição POST /api/v1/send-message para enviar uma mensagem. Substitua <seu-dominio>, sk_live_xxxxx e o número de telefone pelos seus valores reais.
curl -X POST https://<seu-dominio>/api/v1/send-message \
  -H "Authorization: Bearer sk_live_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "5511999998888",
    "message": "Olá! Seu pedido foi confirmado.",
    "channel": "whatsapp-official"
  }'
CampoDescrição
phoneNúmero do destinatário em E.164 (+5511999998888) ou só dígitos com DDD (5511999998888). Mínimo 10 dígitos.
messageTexto a enviar. Entre 1 e 4096 caracteres.
channel"whatsapp-official" para Meta Cloud API ou "uazapi" para WhatsApp via UAZAPI.
4

Verifique a resposta

Uma chamada bem-sucedida retorna 200 OK com o seguinte JSON:
{
  "success": true,
  "conversationId": "uuid-da-conversa",
  "contactId": "uuid-do-contato",
  "messageId": "uuid-da-mensagem",
  "waMessageId": "wamid.xxxxx",
  "contactCreated": false,
  "conversationCreated": false,
  "sent_at": "2026-04-23T10:00:00.000Z"
}
CampoDescrição
conversationIdUUID da conversa no Tivar. Use este ID para enviar mensagens na mesma conversa via POST /api/external/messages/send.
contactIdUUID do contato no Tivar.
messageIdUUID da mensagem no banco de dados do Tivar.
waMessageIdID da mensagem retornado pelo provedor (Meta ou UAZAPI).
contactCreatedtrue se o contato foi criado nesta requisição; false se já existia.
conversationCreatedtrue se a conversa foi criada nesta requisição; false se já existia.
5

Próximos passos

Agora que você enviou sua primeira mensagem, explore o restante da plataforma:

Autenticação

Entenda como a API Key funciona e como proteger suas credenciais.

WhatsApp Oficial

Configure a integração com a Meta Cloud API e aprenda a enviar templates HSM.

Webhooks

Receba eventos como message.received em tempo real no seu n8n, Typebot ou Zapier.

Enviar template HSM

Alcance clientes fora da janela de 24 h do WhatsApp com templates pré-aprovados pela Meta.