TOPSEND API

Consultar Campanha

Retorna os dados atuais de uma campanha.

GET

/api/v1/campaign/:campaignId

Retorna os dados de uma campanha. O :campaignId é o id retornado na criação da campanha. Requer autenticação Bearer (JWT); o usuário é extraído do token e apenas as campanhas do próprio usuário podem ser consultadas. A resposta reflete o estado atual da campanha: o status evolui durante o processamento e os demais campos são atualizados conforme a campanha avança.

Autorizações:

Bearer Token

Credenciais

Token

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NzYzNzQxNjUsInN1YiI6IjEifQ...

Obs: para pegar o seu token acesse a plataforma da TopSend e gere o token nas configurações de usuário.

Endpoint

/api/v1/campaign/:campaignId

Resposta

200Retorna os dados da campanha. api_campaign_id é o identificador da campanha na plataforma de disparo. cost é o valor da transação de débito da campanha menos a de reembolso, quando houver; vem 0 enquanto não existe transação de débito. Alguns campos são condicionais: aggregated, aggregation_closed e last_aggregated_at só aparecem quando a campanha é agregada; audio_id só aparece quando a campanha tem áudio; end_date só aparece quando a campanha já terminou.

{
  "id": "6a88acd8302919e5bc3c4468",
  "api_campaign_id": "934315e1-d198-4fd1-9d58-4d4238b5e985",
  "title": "Campanha teste DEV",
  "type": "SMSSHORT",
  "status": "IN_PROGRESS",
  "message": "Teste Dev Topsend",
  "quantity": 1,
  "cost": 0.07,
  "start_date": "2026-08-17T09:26:00Z",
  "created_at": "2026-08-21T19:54:00.46Z",
  "updated_at": "2026-08-21T19:54:00.46Z"
}

Possíveis Erros

404 Not Found

{
  "error": null,
  "message": "Campanha não encontrada",
  "message_translate": "Campanha inexistente ou de outro usuário",
  "meta": {},
  "type": "NOT_FOUND"
}

422 Unprocessable Entity

{
  "error": null,
  "message": "Dados inválidos",
  "message_translate": "campaignId ausente, ou usuário do JWT não encontrado",
  "meta": {},
  "type": "VALIDATION"
}

401 Unauthorized

{
  "error": null,
  "message": "Token JWT ausente ou inválido",
  "message_translate": "Token JWT ausente ou inválido",
  "meta": {},
  "type": "UNAUTHORIZED"
}

500 Internal Server Error

{
  "error": null,
  "message": "Falha ao consultar a plataforma de disparo",
  "message_translate": "Falha ao consultar a plataforma de disparo",
  "meta": {},
  "type": "INTERNAL"
}