Lead einer Outbound-Kampagne abrufen

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

Ruft einen Lead einer Outbound-Kampagne ab.

Pfadparameter

campaign_idstringErforderlich

lead_idstringErforderlich

Antwort

Erfolgreiche Antwort

lead_idstring

recipient_idstring or null

Die diesem Empfänger bei der Erstellung der Kampagne zugewiesene id.

phone_numberstring

Die Nummer, die der nächste Anruf des Leads wählt. Sie ändert sich, wenn der Lead zu einer anderen angegebenen Nummer wechselt oder die Kontaktperson darum bittet, unter einer anderen Nummer angerufen zu werden.

phone_numbers_indexinteger

Die Position der angerufenen Nummer in phone_numbers.

user_idstring

Die Identität der Kontaktperson: die in conversation_initiation_client_data übermittelte user_id, andernfalls die Telefonnummer des Leads.

attempt_countinteger

Getätigte Anrufe, die auf max_total_calls der Richtlinie angerechnet werden.

failure_countinteger

Fehlgeschlagene Anrufe an die aktuelle Nummer; wird bei einer neuen Nummer zurückgesetzt.

callback_countinteger

Von der Kontaktperson angeforderte Rückrufe.

redirect_countinteger

Anzahl der Fälle, in denen der Kontakt um einen Anruf unter einer anderen Nummer gebeten hat.

do_not_callboolean

Wird gesetzt, wenn die Kontaktperson darum gebeten hat, nicht angerufen zu werden, der Lead entfernt wurde oder die Kampagne beendet wurde. Der Lead wird nicht erneut angerufen.

terminal_dispositionenum or null

Warum der Lead nicht erneut angerufen wird; nicht gesetzt, solange ein erneuter Anruf möglich ist.

created_at_unixinteger or null

Zeitpunkt, zu dem der Lead der Kampagne beigetreten ist; bei älteren Leads nicht gesetzt.

updated_at_unixinteger

dynamic_variablesmap from strings to any

Die für den Lead übermittelten dynamischen Variablen mit geschwärzten Geheimnissen.

overridesobject

Die für den Lead übermittelten Gesprächsüberschreibungen.

phone_numberslist of stringsOptional

Die angegebenen Nummern des Leads in Anrufreihenfolge.

deliveryobject or nullOptional

Die letzte Nachrichtenzustellung des Leads; wird bei Nachrichtenkampagnen gesetzt.

Fehler

422

Unprocessable Entity Error

Pfadparameter

Header

Antwort

Fehler