Guia rápido

Autenticar, criar um contato e disparar uma campanha WhatsApp só com a documentação.

Este guia cobre o caminho mínimo de um integrador externo.

1. Autenticar

Crie uma API key com pelo menos:

  • crm:contacts:write
  • whatsapp:campaigns:write
  • whatsapp:campaigns:read (opcional, para listar)
export LIP_KEY=lip_SUA_CHAVE
curl -s "https://external-api.lip7.com.br/api/external/v1/me" \
  -H "x-api-key: $LIP_KEY"

Detalhes: Autenticação.

2. Criar um contato

curl -X POST "https://external-api.lip7.com.br/api/external/v1/contacts" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $LIP_KEY" \
  -d '{
    "firstName": "Ana",
    "phone": "+5511987654321"
  }'

Telefone em E.164. Veja Criar contato.

3. Criar e disparar campanha WhatsApp

  1. Criar campanha com template e audiência (segmento ou lista).
  2. Disparar com header obrigatório Idempotency-Key.
curl -X POST "https://external-api.lip7.com.br/api/external/v1/whatsapp/campaigns/CMP_ID/send" \
  -H "x-api-key: $LIP_KEY" \
  -H "Idempotency-Key: campanha-ana-001"

Isso consome quota mensal. Acompanhe em Consultar status ou via webhooks.

Alternativa: mensagem avulsa

Se não precisar de campanha, use Enviar mensagem com to + content (e opcionalmente mediaId de Upload de mídia).