Leads van uitgaande campagne weergeven | ElevenLabs Documentation

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

Toon de leads van een uitgaande campagne, één per ontvanger.

Padparameters

campaign_idstringVerplicht

Queryparameters

page_sizeintegerOptioneel1-500Standaard 100

Het maximale aantal items dat wordt geretourneerd.

searchstringOptioneel<=100 characters

Alleen leads waarvan de ID, gebruikers-ID of het telefoonnummer deze tekst bevat.

statusenumOptioneel

in_progress voor leads die nog worden gebeld, finished voor leads die niet opnieuw worden gebeld.

Toegestane waarden:

dispositionenumOptioneel

Alleen leads die op een van deze manieren zijn voltooid.

cursorstringOptioneel

Gebruikt om de volgende pagina op te halen. De cursor wordt teruggegeven in de response.

Response

Geslaagde response

leadslist of objects

has_moreboolean

next_cursorstringOptioneel

Fouten

422

Leads List Request Unprocessable Entity Error

Padparameters

Headers

Queryparameters

Response

Fouten