Acompanhar, reenviar e cancelar disparos
Liste e consulte os Broadcasts da conta, acompanhe o status, reenvie e cancele pela API. Criar o Broadcast continua na tela da NexTags.
Os Broadcasts são criados na tela da NexTags, com o público, o fluxo e o horário. Pela API, o seu sistema acompanha o que já foi criado: lista os Broadcasts, consulta o status de cada um, reenvia e cancela. Use para montar um painel próprio ou para parar um envio agendado a partir de outro sistema.
Antes de começar
- A chave de API na variável de ambiente
NEXTAGS_API_KEY. Veja Autenticação com a chave de API. - Um Broadcast criado na NexTags. Veja Criar um Broadcast.
Passo a passo
Passo 1: Liste os Broadcasts
Use Listar disparos. A lista vem em data, com até 100 itens:
curl "https://app.nextagsai.com.br/api/broadcasts" \
-H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY"
const resposta = await fetch('https://app.nextagsai.com.br/api/broadcasts', {
headers: {
'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY,
},
});
const dados = await resposta.json();
console.log(resposta.status, dados);
import os
import requests
resposta = requests.get(
"https://app.nextagsai.com.br/api/broadcasts",
headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
timeout=30,
)
print(resposta.status_code, resposta.json())
<?php
$ch = curl_init('https://app.nextagsai.com.br/api/broadcasts');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'),
],
]);
$dados = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($dados);
{
"data": [
{
"id": 7001,
"name": "Promoção de Natal",
"status": "SENT",
"sent_at": "2026-10-20 15:00:00",
"created_by": 10001,
"created_at": "2026-10-20 14:40:00"
}
]
}O ID do Broadcast não aparece na tela: guarde o id que vem aqui.
Passo 2: Consulte um Broadcast
Use Consultar disparo, com o ID no caminho:
curl "https://app.nextagsai.com.br/api/broadcasts/7001" \
-H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY"
const resposta = await fetch('https://app.nextagsai.com.br/api/broadcasts/7001', {
headers: {
'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY,
},
});
const dados = await resposta.json();
console.log(resposta.status, dados);
import os
import requests
resposta = requests.get(
"https://app.nextagsai.com.br/api/broadcasts/7001",
headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
timeout=30,
)
print(resposta.status_code, resposta.json())
<?php
$ch = curl_init('https://app.nextagsai.com.br/api/broadcasts/7001');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'),
],
]);
$dados = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($dados);
A resposta tem os mesmos campos de cada item da lista. Se o ID não existe, a resposta é 404.
status | O que o nome indica |
|---|---|
DRAFT | Rascunho |
NOT_SENT | Ainda não enviado |
SENTING | Enviando |
SENT | Enviado |
CANCELLED | Cancelado |
Na tela, os Broadcasts aparecem como Agendado, Pendente, Enviando, Enviado e Cancelado. Confira no seu teste qual status corresponde a cada um, em especial Agendado e Pendente.
Passo 3: Reenvie um Broadcast
Use Reenviar disparo. A chamada não tem corpo:
curl -X POST "https://app.nextagsai.com.br/api/broadcasts/7001/resend" \
-H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY"
const resposta = await fetch('https://app.nextagsai.com.br/api/broadcasts/7001/resend', {
method: 'POST',
headers: {
'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY,
},
});
const dados = await resposta.json();
console.log(resposta.status, dados);
import os
import requests
resposta = requests.post(
"https://app.nextagsai.com.br/api/broadcasts/7001/resend",
headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
timeout=30,
)
print(resposta.status_code, resposta.json())
<?php
$ch = curl_init('https://app.nextagsai.com.br/api/broadcasts/7001/resend');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'),
],
]);
$dados = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($dados);
A resposta é {"success": true}. O Broadcast sai de novo: não repita a chamada para conferir. Na tela, a mesma ação fica no menu ⋮ do Broadcast, em Reenviar. Veja Reenviar, cancelar e exportar um Broadcast.
Passo 4: Cancele um Broadcast
Use Cancelar disparo. A chamada não tem corpo:
curl -X POST "https://app.nextagsai.com.br/api/broadcasts/7001/cancel" \
-H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY"
const resposta = await fetch('https://app.nextagsai.com.br/api/broadcasts/7001/cancel', {
method: 'POST',
headers: {
'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY,
},
});
const dados = await resposta.json();
console.log(resposta.status, dados);
import os
import requests
resposta = requests.post(
"https://app.nextagsai.com.br/api/broadcasts/7001/cancel",
headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
timeout=30,
)
print(resposta.status_code, resposta.json())
<?php
$ch = curl_init('https://app.nextagsai.com.br/api/broadcasts/7001/cancel');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'),
],
]);
$dados = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($dados);
A resposta é {"success": true}. Na tela, o Cancelar só aparece para Broadcasts Agendado, Pendente e no começo do Enviando: o que já saiu não volta. Consulte o Broadcast depois para ver se o status virou CANCELLED.
Pronto: como conferir
- Consultar disparo mostra o
statusnovo. - Na NexTags, a lista de Broadcasts mostra o mesmo estado e os resultados: enviados, entregues, abertos, clicados e falhas. Veja Resultados: entregues, abertos, clicados e falhas.
Se não funcionou
401 com "No valid API key provided."
A chave não chegou ou não vale. Veja Autenticação com a chave de API.
404 com "Broadcast not found"
O ID não existe nesta conta. Liste os Broadcasts de novo e use um id da lista.
O cancelamento não parou o envio
O Broadcast já tinha saído, ou estava no meio do envio. Na tela, só dá para cancelar o que está Agendado, Pendente ou começando a enviar.
Quero criar um Broadcast pela API
A API não cria Broadcasts. Crie na tela, com o público e o fluxo, e use a API para acompanhar. Para enviar a um contato só, use Enviar um fluxo para um contato.
Faça com a IA
Copie o pedido e cole no ChatGPT ou no Claude.
Leia https://docs.nextags.com.br/guias/disparos-pela-api.md.
Escreva, em [linguagem], um script que lista os Broadcasts da minha conta na NexTags, mostra o nome, o status e a data de envio de cada um e cancela o Broadcast [nome ou ID] se ele ainda não tiver saído. A chave vem da variável de ambiente NEXTAGS_API_KEY.
Relacionados
Este conteúdo ajudou?
Obrigado! Sua resposta ajuda a melhorar a central.