Contar o público de uma campanha

Conta quem recebe antes de a campanha existir, pelas mesmas regras do envio do canal. A origem é leads (uma seleção de leads, como na tela de Leads) ou list (o listId de uma lista enviada). Cada variável liga a um campo do lead; no WhatsApp, quando algum lead não tem o valor, a escolha entre text (texto padrão) e exclude (deixar de fora) é obrigatória e, enquanto falta, sendable vem nulo com o bloqueio variable_choice_required. No e-mail as variáveis são as tags do assunto e do documento, e sem escolha vale o texto padrão da própria tag. out conta cada destinatário uma vez, pelo primeiro motivo; variables[].missing conta cada lead sem o valor em cada variável. Campos por canal: whatsapp templateId (e businessPhoneId para contar o intervalo entre disparos), unofficial message (e instanceId), email subject e document, carrier kind. No WhatsApp o modelo (ou a mensagem) é opcional na contagem: sem ele a contagem já traz encontrados, com WhatsApp, quem recebe e quem fica de fora pelos motivos que não dependem do modelo (sem número, bloqueado, opt-out, outra campanha em andamento e, com businessPhoneId, o intervalo entre disparos), sem variáveis, com o bloqueio template_required (ou message_required no não oficial) até a escolha. Com o modelo, variables traz uma variável por parâmetro na ordem do envio: a do texto do cabeçalho primeiro (header: true), depois as do corpo; name é o nome da variável (nome nas nomeadas, 1, 2 nas numeradas) e key é a posição. No WhatsApp, workflowId e agentId são o fluxo e o agente da campanha: cada variável que eles pedem (a regra da criação, que segue agentes de nós de IA e ferramentas) vem em variables com kind: automation e neededBy; a variável de agente com valor padrão vem com optional: true e default e nunca bloqueia. Cada uma tem a escolha de origem das variáveis do modelo: um campo do lead em source, um texto fixo (source: literal com value) ou, numa lista, a coluna pelo nome do cabeçalho em column (nunca pela posição; a mesma coluna pode alimentar uma posição do modelo e uma variável); source: default mantém o padrão do agente. Numa lista, a coluna com o nome da variável vem sugerida (suggested: true). A linha sem valor segue missing (text ou exclude) e, sem a escolha, o bloqueio é variable_choice_required. Uma coluna que a lista não tem marca columnMissing e bloqueia com list_column_missing (422 audience_list_column_unknown na criação); column numa seleção de leads é 400 audience_variable_column_needs_list, column junto de source é 400 audience_variable_column_with_source e default numa variável sem padrão é 400 audience_variable_default_unavailable. Cada variável da automação traz type (kind, shape e options da declaração). Uma variável do tipo Planilha (sheet: true) vale para a campanha inteira: aceita só source: literal com o arquivo em value, começa pelo padrão da declaração (suggested: true) e nunca vira coluna da lista nem do modelo de lista; column, um campo do lead ou missing nela são 400 audience_variable_sheet_literal_only. O arquivo é conferido contra o que o fluxo ou o agente grava: sem arquivo o bloqueio é sheet_required, e um arquivo que não serve vem com sheetUnfit (o código do motivo) e o bloqueio sheet_unfit (422 audience_sheet_required ou audience_sheet_unfit na criação). No não oficial, um fluxo ou agente que grava em Planilha é 422 campaign_sheet_variables_official_only. Uma recusa causada por uma variável traz details.variable com a chave dela. Os valores resolvidos vão para os metadados de cada entrada, onde o fluxo (campvars) e o agente os leem. Exige a ação create do recurso do canal e, para leads, leads:read.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Canal

Allowed:
Body Params

Público e campos do canal

string
string
document
object
string
string
enum
Allowed:
string
message
object
selection
object
string
enum
Allowed:
string
string
variables
array of objects
variables
string
Headers
string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json