Estimar alcance e custo

POST 
/broadcasts/:id/estimate

Confere a campanha inteira e calcula quem ela alcançaria agora: quantos contatos, quantos ficam de fora e por quê, o teto de destinatários, a cota do plano, o limite de mensagens do número na Meta e o custo estimado por país. Não muda nada.

Com uma API key restrita a alguns números, a estimativa conta só os contatos do público que têm conversa nesses números.

Request

Responses

200

Registro encontrado.

401

Token ausente, malformado, desconhecido ou revogado (authentication), ou conta suspensa (tenant_inactive).

402

Sem direito de uso (payment_required). O corpo traz o motivo em reason e a saída em action: o que fazer (kind) e a página do painel onde se faz (url).

403

O recurso informado não pertence à sua conta (forbidden), ou o caminho está na lista de bloqueio do espelho (forbidden_endpoint), ou a sua API key é restrita a alguns números e a operação é da conta inteira (forbidden).

404

Recurso inexistente (not_found).

422

A campanha não está pronta: broadcast_incomplete, template_not_found, template_not_approved, template_not_supported, variable_unmapped (com issues), audience_invalid, audience_filter_invalid ou audience_too_complex.

429

Limite de requisições excedido (rate_limit).

Response Headers

Retry-After

Segundos a aguardar antes de tentar de novo.

X-RateLimit-Category

Categoria do limite aplicada — send, media ou default.

X-RateLimit-Scope

Qual balde os outros headers descrevem — key (a API key), session (o painel) ou account (o teto da conta).

X-RateLimit-Limit

Teto de requisições da categoria na janela atual.

X-RateLimit-Remaining

Requisições restantes na janela atual.