Lançar campanha

POST 
/broadcasts/:id/launch

Congela o público e põe a campanha para enviar — agora, ou em scheduledAt (até um ano à frente). Mais de 60 segundos no futuro, a campanha fica scheduled; senão, começa a montar a lista de destinatários na hora.

Não aceita Idempotency-Key: um segundo lançamento responde 409, porque a campanha já não é mais rascunho.

Com uma API key restrita a alguns números, o público — salvo ou digitado como filtro — fica restrito aos contatos que têm conversa nesses números, e esse recorte é congelado no lançamento junto com o público. Uma campanha lançada por uma chave sem restrição vai para a base inteira.

Request

Responses

202

Campanha lançada ou agendada.

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

409

A campanha não está num estado que permite a ação (broadcast_invalid_state, com status).

422

A campanha não está pronta (os mesmos erros da estimativa), ou: audience_empty (ninguém pode receber), broadcast_limit_reached (acima do teto de destinatários, com limit), quota_exceeded (o plano não tem mensagens neste mês).

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.