Lister les prospects de la campagne d'appels sortants

curl -G https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads \
     -d cursor=cursor \
     -d disposition=campaign_ended \
     -d page_size=1 \
     -d search=search \
     -d status=in_progress

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

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.

searchstringOptionnel<=100 characters

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

statusenumOptionnel

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

Valeurs autorisées:

dispositionenumOptionnel

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

cursorstringOptionnel

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

has_moreboolean

next_cursorstringOptionnel

Erreurs

422

Leads List Request Unprocessable Entity Error

Paramètres de chemin

En-têtes

Paramètres de requête

Réponse

Erreurs