Listar os números de uma campanha oficial

Lista paginada dos números (contatos) da campanha id, cada um com o lead, o estado do envio, o erro da Meta quando houve e os dados da conversa. search busca pelo número; status filtra pelo estado do envio (PENDING, SENT, DELIVERED, READ, FAILED, NOT_ELIGIBLE_POSSIBLE_SPAM, SKIPPED_NOT_ON_WHATSAPP e os demais estados de pulo, sem diferenciar maiúsculas); stageId filtra pela etapa do funil; errorCode pelo código de erro do envio; toolName, messageType, hasToolCalls, minMessageCount e maxMessageCount filtram pela conversa (ferramenta de IA usada, tipo de mensagem, se houve chamada de ferramenta e quantidade de mensagens). sort aceita number, name, status, createdAt e updatedAt, com asc ou desc. Campanha de outro workspace ou de um departamento sem acesso responde 404 campaign_not_found. Exige whatsapp_campaigns:read.

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

ID da campanha

Query Params
integer

Página, a partir de 1

integer

Itens por página, de 1 a 100 (padrão 20)

string

Ordenação, ex.: status:asc

Busca pelo número

string

Estado do envio, ex.: FAILED

string

ID da etapa do funil

integer

Código de erro do envio

string

Ferramenta de IA usada na conversa

string

Tipo de mensagem presente na conversa

boolean

true para conversas com chamada de ferramenta

integer

Mínimo de mensagens na conversa

integer

Máximo de mensagens na conversa

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