Lister les prospects de la campagne d'appels sortants

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

Répertorie les prospects d’une campagne sortante, à raison d’un par destinataire.

Paramètres de chemin

campaign_idstringRequis

Paramètres de requête

page_sizeintegerOptionnel1-500Par défaut 100

Nombre maximal d’éléments à renvoyer.

searchstring or nullOptionnel<=100 characters

Uniquement les prospects dont l’ID, l’ID utilisateur ou le numéro de téléphone contient ce texte.

statusenum or nullOptionnel

in_progress pour les prospects qui sont encore appelés, finished pour les prospects qui ne seront plus appelés.

Valeurs autorisées:

dispositionlist of enums or nullOptionnel

Uniquement les prospects terminés de l’une de ces manières.

cursorstring or nullOptionnel

Utilisé pour récupérer la page suivante. Le curseur est renvoyé dans la réponse.

Réponse

Réponse réussie

leadslist of objects

next_cursorstring or null

has_moreboolean

Erreurs

422

Unprocessable Entity Error

Paramètres de chemin

En-têtes

Paramètres de requête

Réponse

Erreurs