Wyświetl kontakty kampanii wychodzącej | 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"
}

Wyświetl leady kampanii wychodzącej, po jednym na odbiorcę.

Parametry ścieżki

campaign_idstringWymagany

Parametry zapytania

page_sizeintegerOpcjonalny1-500Domyślnie 100

Maksymalna liczba zwracanych elementów.

searchstringOpcjonalny<=100 characters

Tylko leady, których ID, ID użytkownika lub numer telefonu zawiera ten tekst.

statusenumOpcjonalny

in_progress dla leadów, do których połączenia nadal są wykonywane, finished dla leadów, do których nie będzie kolejnych połączeń.

Dozwolone wartości:

dispositionenumOpcjonalny

Tylko leady zakończone w jeden z tych sposobów.

cursorstringOpcjonalny

Służy do pobrania następnej strony. Kursor jest zwracany w odpowiedzi.

Odpowiedź

Pomyślna odpowiedź

leadslist of objects

has_moreboolean

next_cursorstringOpcjonalny

Błędy

422

Leads List Request Unprocessable Entity Error

Parametry ścieżki

Nagłówki

Parametry zapytania

Odpowiedź

Błędy