Consultar disparo

GET/broadcasts/{broadcast_id}

Gerada do contrato OpenAPI

Devolve um Broadcast pelo ID, com o estado: use para acompanhar um envio até SENT. Os números de entregues, vistos, cliques e falhas não vêm aqui: ficam na lista Broadcasts (Resultados: entregues, abertos, clicados e falhas).

Requisição

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);

Autenticação

Mande a chave de API da conta no cabeçalho X-ACCESS-TOKEN de cada chamada. Veja Autenticação com a chave de API.

Parâmetros de caminho

broadcast_idintegerobrigatório

O ID do Broadcast (veja Listar disparos).

Respostas

200Sucesso

O Broadcast.

idinteger

O ID do Broadcast.

namestring

O nome do Broadcast, como na coluna Nome da lista.

statusstring

O estado: DRAFT (rascunho; Draft na lista), NOT_SENT (ainda não saiu, como um Broadcast Pendente ou Agendado), SENTING (Enviando; o nome é escrito assim mesmo), SENT (Enviado) ou CANCELLED (Cancelado).

Valores: DRAFT NOT_SENT SENTING SENT CANCELLED

sent_atstring (data e hora)

Quando o envio saiu, em UTC.

Exemplo: 2026-10-20 15:00:00

created_byinteger

O ID do administrador que criou.

created_atstring (data e hora)

Quando o Broadcast foi criado, em UTC.

Exemplo: 2026-10-20 14:45:00

404Não encontrado

O Broadcast não existe nesta conta.

401Chave inválida

A chave de API não veio no cabeçalho ou não vale (foi excluída ou está incompleta). Veja Autenticação.

Relacionados

Este conteúdo ajudou?

Obrigado! Sua resposta ajuda a melhorar a central.

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);

Autenticação

Parâmetros de caminho

Respostas

Relacionados

Limites, erros e boas práticas

Acompanhar, reenviar e cancelar disparos

Listar disparos

Reenviar disparo

Cancelar disparo