Hooks de Campanha

Endpoints para sistemas externos disparar ações ou puxar dados de uma campanha F19 (ex.: fazer o WhatsApp da campanha chamar um contato que a equipe está abordando).

Catálogo de hooks

POST  send_contact_campaign

Faz o WhatsApp da campanha chamar um contato que a equipe está abordando. Ao receber, o F19:

1. Envia a mensagem da campanha para o contato.
2. Salva o contato na agenda do WhatsApp da campanha como 🟡 CA - <Nome> <Sobrenome> - <data> - <equipe>.

Campos (JSON)

Exemplos

curl -X POST https://www.hook.w19.com.br/campanha/send_contact_campaign \
  -H "Content-Type: application/json" \
  -H "X-Hook-Token: SEU_TOKEN_DA_CAMPANHA" \
  -d '{
    "id_campaign": 22,
    "contact_first_name": "Vivian",
    "contact_last_name": "Amaral",
    "contact_phone": "5519999999999",
    "apoiador": "nao",
    "contact_instagram": "@vivian",
    "data": "20/08",
    "equipe": "Equipe Murilo",
    "equipe_nome": "Murilo Coghi",
    "equipe_telefone": "5519991277010"
  }'

<?php
$payload = [
  "id_campaign"        => 22,
  "contact_first_name" => "Vivian",
  "contact_last_name"  => "Amaral",
  "contact_phone"      => "5519999999999",
  "apoiador"           => "nao",
  "data"               => "20/08",
  "equipe"             => "Equipe Murilo",
  "equipe_nome"        => "Murilo Coghi",
];
$ch = curl_init("https://www.hook.w19.com.br/campanha/send_contact_campaign");
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST           => true,
  CURLOPT_HTTPHEADER     => [
    "Content-Type: application/json",
    "X-Hook-Token: SEU_TOKEN_DA_CAMPANHA",
  ],
  CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
]);
$resp = curl_exec($ch);
echo $resp;

const r = await fetch("https://www.hook.w19.com.br/campanha/send_contact_campaign", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Hook-Token": "SEU_TOKEN_DA_CAMPANHA",
  },
  body: JSON.stringify({
    id_campaign: 22,
    contact_first_name: "Vivian",
    contact_last_name: "Amaral",
    contact_phone: "5519999999999",
    data: "20/08",
    equipe: "Equipe Murilo",
    equipe_nome: "Murilo Coghi",
  }),
});
console.log(await r.json());

Resposta

{
  "ok": true,
  "contact_phone": "5519999999999",
  "message_sent": true,
  "messages": 3,
  "message_id": "3EB0...",
  "contact_added": true,
  "apoiador_registered": true,
  "agenda_name": "🟡 CA - Vivian Amaral - 20/08 - Equipe Murilo",
  "campaign": "Murilo Coghi",
  "line_phone": "5519982085305",
  "errors": []
}

apoiador_registered: true cadastrado (ou já era) · null não pediu (apoiador≠sim) · false erro.

Mensagem enviada ao contato

São enviadas como 3 mensagens separadas (cada bloco chega em sequência, ~1,2s entre elas):

[1] Oi Vivian, Murilo aqui ... Murilo passou seu numero.
    Já salva o meu contato 🙏🏻

[2] Quando puder acessa o site, para ver o cronograma das aulas do rotina
    https://araras.org/rotina/

[3] Mas me fala ... Gostou do projeto?

Códigos de retorno

GET  list_dispatched_contacts

Retorna os contatos que receberam disparo da campanha (módulo DISPAROS + listas de transmissão dos apoiadores), deduplicados por telefone — com nome, telefone e data do disparo mais recente.

Parâmetros

Exemplo

curl "https://www.hook.w19.com.br/campanha/list_dispatched_contacts?id_campaign=22&limit=100" \
  -H "X-Hook-Token: SEU_TOKEN_DA_CAMPANHA"

Resposta

{
  "ok": true,
  "campaign": "Murilo Coghi",
  "total": 2943,
  "contacts": [
    { "nome": "Milene Guedes", "telefone": "5519996823976", "data": "01/09/2026" },
    { "nome": "Val Academia",  "telefone": "5519971265723", "data": "31/08/2026" }
  ]
}

Inclui quem recebeu por qualquer disparo da campanha (drips do módulo DISPAROS e LTs dos apoiadores). data = disparo mais recente.

POST  save_contact

Salva um contato na agenda do(s) WhatsApp(s) da campanha. Como pode haver várias linhas, salva em todas as conectadas por padrão; com numerocampanha específico, só nela.

Parâmetros

Exemplo

curl -X POST https://www.hook.w19.com.br/campanha/save_contact \
  -H "Content-Type: application/json" -H "X-Hook-Token: SEU_TOKEN" \
  -d '{"id_campaign":22,"nome":"🟢RA - Flavia Caroline - Yara - 01/09","contact_phone":"19971338253","numerocampanha":"any"}'

{ "ok": true, "contact_phone": "5519971338253", "saved_lines": 2, "total_lines": 2, "failed_lines": [] }

POST  send_message

Envia mensagem(ns) personalizada(s) a um contato por uma linha da campanha. Cada item de msgs é uma mensagem separada. numerocampanha: any sorteia entre as linhas conectadas; número específico envia por ela.

Parâmetros

Exemplo

curl -X POST https://www.hook.w19.com.br/campanha/send_message \
  -H "Content-Type: application/json" -H "X-Hook-Token: SEU_TOKEN" \
  -d '{"id_campaign":22,"numero":"19971338253","numerocampanha":"any",
       "msgs":["Oi, Flavia... consegue entrar na comunidade para receber as aulas?",
               "*Convite Comunidade*\nhttps://chat.whatsapp.com/EbBc0Cm1r7EJjbwqWx1Tup"]}'

{ "ok": true, "contact_phone": "5519971338253", "from_line": "5519982085305", "sent": 2, "messages": 2 }