Pobierz kontakt kampanii wychodzącej

GET

/v1/convai/outbound-campaigns/campaigns/:campaign_id/leads/:lead_id

GET

/v1/convai/outbound-campaigns/campaigns/:campaign_id/leads/:lead_id

curl https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads/lead_id

{
  "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": {
    "language": "language",
    "first_message": "first_message",
    "prompt": "prompt",
    "voice_id": "voice_id"
  },
  "recipient_id": "recipient_id",
  "phone_numbers": [
    "phone_numbers"
  ],
  "terminal_disposition": "campaign_ended",
  "created_at_unix": 1,
  "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": "error_message"
  }
}

Pobierz jeden lead kampanii wychodzącej.

Parametry ścieżki

campaign_idstringWymagany

lead_idstringWymagany

Odpowiedź

Pomyślna odpowiedź

lead_idstring

phone_numberstring

Numer wybierany podczas następnego połączenia z leadem. Zmienia się, gdy lead przechodzi do innego numeru z listy lub kontakt prosi o połączenie na inny numer.

phone_numbers_indexinteger

Pozycja wybieranego numeru w phone_numbers.

user_idstring

Tożsamość kontaktu: user_id przesłane w conversation_initiation_client_data, a w przeciwnym razie numer telefonu leada.

attempt_countinteger

Wykonane połączenia, liczone względem max_total_calls w zasadach.

failure_countinteger

Nieudane połączenia z bieżącym numerem; licznik resetuje się przy nowym numerze.

callback_countinteger

Oddzwonienia, o które poprosił kontakt.

redirect_countinteger

Liczba próśb kontaktu o połączenie na inny numer.

do_not_callboolean

Ustawiane, gdy kontakt poprosił o zaprzestanie połączeń, lead został usunięty lub kampania została zatrzymana. Lead nie otrzyma kolejnego połączenia.

updated_at_unixinteger

dynamic_variablesmap from strings to any

Zmienne dynamiczne przesłane dla leada, z ukrytymi sekretami.

overridesobject

Nadpisania rozmowy przesłane dla leada.

recipient_idstringOpcjonalny

id przypisane temu odbiorcy podczas tworzenia kampanii.

phone_numberslist of stringsOpcjonalny

Numery leada na liście, w kolejności połączeń.

terminal_dispositionenumOpcjonalny

Dlaczego lead nie zostanie ponownie wybrany; nieustawione, dopóki może zostać wybrany.

created_at_unixintegerOpcjonalny

Kiedy lead dołączył do kampanii; nieustawione dla starszych leadów.

deliveryobjectOpcjonalny

Ostatnie dostarczenie wiadomości leada; ustawiane w kampaniach wiadomości.

Błędy

422

Leads Get Request Unprocessable Entity Error

Parametry ścieżki

Nagłówki

Odpowiedź

Błędy