Listar leads da campanha de chamadas ativas

{
  "leads": [
    {
      "lead_id": "string",
      "recipient_id": "string",
      "phone_number": "string",
      "phone_numbers_index": 1,
      "user_id": "string",
      "attempt_count": 1,
      "failure_count": 1,
      "callback_count": 1,
      "redirect_count": 1,
      "do_not_call": true,
      "terminal_disposition": "campaign_ended",
      "created_at_unix": 1,
      "updated_at_unix": 1,
      "dynamic_variables": {},
      "overrides": {
        "language": "string",
        "first_message": "string",
        "prompt": "string",
        "voice_id": "string"
      },
      "phone_numbers": [
        "string"
      ],
      "delivery": {
        "status": "pending",
        "stage": "queued",
        "sent_at_unix": 1,
        "delivered_at_unix": 1,
        "read_at_unix": 1,
        "replied_at_unix": 1,
        "failed_at_unix": 1,
        "error_message": "string"
      }
    }
  ],
  "next_cursor": "string",
  "has_more": true
}

Liste os leads de uma campanha ativa, um por destinatário.

Parâmetros de caminho

campaign_idstringObrigatório

Parâmetros de consulta

page_sizeintegerOpcional1-500Padrão é 100

Número máximo de itens a retornar.

searchstring or nullOpcional<=100 characters

Somente leads cujo ID, ID de usuário ou número de telefone contém este texto.

statusenum or nullOpcional

in_progress para leads que ainda estão recebendo chamadas, finished para leads que não receberão mais chamadas.

Valores permitidos:

dispositionlist of enums or nullOpcional

Somente leads que foram finalizados de uma destas formas.

cursorstring or nullOpcional

Usado para buscar a próxima página. O cursor é retornado na resposta.

Resposta

Resposta bem-sucedida

leadslist of objects

next_cursorstring or null

has_moreboolean

Erros

422

Unprocessable Entity Error

Parâmetros de caminho

Cabeçalhos

Parâmetros de consulta

Resposta

Erros