Iniciar automação

POST https://app.sendapp.ai/api/automations/{id}/start

Inicia de imediato, para um contacto, uma automação ativada que começa com o trigger Chamada de outro sistema. Faz o mesmo que o seu endereço secreto, mas basta o ID da automação. Se o contacto ainda não existir, é criado.

Os passos são executados mesmo: um passo «Enviar template» envia a mensagem de WhatsApp ao contacto. Para um teste usa uma automação com passos inofensivos, por exemplo «Adicionar tag».

O contacto: contact_id de um contacto da tua conta, ou então phone e/ou email (com name, ou first_name e last_name, para um contacto novo). Se não indicares nenhum dos três, o contacto é lido de data como faz o endereço da automação: os campos escolhidos no editor ou os nomes habituais (phone, email, name…).

Os campos de data usam-se nos passos como hook:nome; as chaves aninhadas tornam-se hook:order.id. No máximo 50 campos, 500 caracteres cada.

Respostas: 200 com ran, run_id, run_status (done, waiting, failed…), reason, contact_id e contact_created; com ran: false a automação não começou porque as suas condições («Se…») não se verificam para este contacto — 200 com status: duplicate se a mesma idempotency_key já foi usada nas últimas 24 horas — 404 se a automação ou o contacto não forem da tua conta — 409 se a automação estiver desativada — 413 se o corpo ultrapassar 64 KB — 422 se um dado não for válido.

Erros comuns: 401 se a chave API faltar ou estiver errada — 403 se o plano expirou ou não inclui o acesso API, ou se a app ligada (Zapier, Make) só tiver permissão de leitura — 429 se fizeres demasiados pedidos em pouco tempo, ou se a automação já recebeu 120 inícios no último minuto (contam também os do seu endereço): tenta de novo após os segundos indicados no cabeçalho Retry-After.

Parâmetros

9 · 2 obrigatórios

apikey obrigatório

A sua API Key (o cabeçalho X-API-Key também funciona).

id obrigatório

ID da automação (inteiro, no caminho). Usa GET /api/automations para o encontrar.

contact_id opcional

ID de um contacto da tua conta.

phone opcional

Telefone em formato internacional, por exemplo +393331234567. Usado se faltar contact_id.

email opcional

Email do contacto. Usado se faltar contact_id.

name opcional

Nome para um contacto novo (ou então first_name e last_name).

data opcional

Objeto com os campos que os passos leem como hook:nome, por exemplo {"order_id": "1234"}.

token opcional

Só para uma automação válida para todas as contas: o token da conta do contacto. Para uma automação de uma só conta omite-o ou passa o seu.

idempotency_key opcional

Uma chave tua, até 200 caracteres: com a mesma chave em 24 horas a automação não volta a começar e a resposta é status: duplicate. A chave é partilhada com o endereço secreto da mesma automação: uma chave já recebida lá (cabeçalho Idempotency-Key) responde duplicate também aqui, e vice-versa. Em alternativa o cabeçalho Idempotency-Key.

Precisa de ajuda com a integração? info@sendapp.live

curl -X POST 'https://app.sendapp.ai/api/automations/318/start' \ -H 'X-API-Key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "phone": "+393331234567", "name": "Anna Rossi", "data": { "order": { "id": "A-77", "total": "49.90" } }, "idempotency_key": "order-A-77" }'

<?php $ch = curl_init('https://app.sendapp.ai/api/automations/318/start'); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_HTTPHEADER => ['X-API-Key: YOUR_API_KEY', 'Content-Type: application/json'], CURLOPT_POSTFIELDS => json_encode([ 'phone' => '+393331234567', 'name' => 'Anna Rossi', 'data' => ['order' => ['id' => 'A-77', 'total' => '49.90']], 'idempotency_key' => 'order-A-77', ]), ]); echo curl_exec($ch); curl_close($ch);

const res = await fetch('https://app.sendapp.ai/api/automations/318/start', { method: 'POST', headers: { 'X-API-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' }, body: JSON.stringify({ phone: '+393331234567', name: 'Anna Rossi', data: { order: { id: 'A-77', total: '49.90' } }, idempotency_key: 'order-A-77' }) }); console.log(await res.json());