Enumerar contactos de campañas salientes

{
  "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
}

Enumera los contactos de una campaña saliente, uno por destinatario.

Parámetros de ruta

campaign_idstringRequerido

Parámetros de consulta

page_sizeintegerOpcional1-500Valor predeterminado: 100

Número máximo de elementos que se devolverán.

searchstring or nullOpcional<=100 characters

Solo contactos cuyo ID, ID de usuario o número de teléfono contiene este texto.

statusenum or nullOpcional

in_progress para contactos a los que aún se está llamando; finished para contactos a los que no se volverá a llamar.

Valores permitidos:

dispositionlist of enums or nullOpcional

Solo contactos que finalizaron de una de estas formas.

cursorstring or nullOpcional

Se usa para obtener la página siguiente. El cursor se devuelve en la respuesta.

Respuesta

Respuesta correcta.

leadslist of objects

next_cursorstring or null

has_moreboolean

Errores

422

Unprocessable Entity Error

Parámetros de ruta

Encabezados

Parámetros de consulta

Respuesta

Errores