Hämta ett lead för utgående kampanj

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

Hämta ett lead från en utgående kampanj.

Sökvägsparametrar

campaign_idstringObligatorisk

lead_idstringObligatorisk

Svar

Lyckat svar

lead_idstring

phone_numberstring

Numret som leadets nästa samtal ringer. Det ändras när leadet går vidare till ett annat nummer i listan eller kontakten ber att bli uppringd på ett annat.

phone_numbers_indexinteger

Positionen i phone_numbers för numret som rings upp.

user_idstring

Kontaktens identitet: user_id som skickats i conversation_initiation_client_data, eller annars leadets telefonnummer.

attempt_countinteger

Genomförda samtal, räknade mot policyns max_total_calls.

failure_countinteger

Misslyckade samtal till det aktuella numret; återställs för ett nytt nummer.

callback_countinteger

Återuppringningar som kontakten har begärt.

redirect_countinteger

Antal gånger kontakten har bett om att bli uppringd på ett annat nummer.

do_not_callboolean

Ange när kontakten bad att inte bli uppringd, leadet togs bort eller kampanjen stoppades. Leadet rings inte upp igen.

updated_at_unixinteger

dynamic_variablesmap from strings to any

De dynamiska variabler som skickats för leadet, med hemligheter maskerade.

overridesobject

Konversationsåsidosättningarna som skickats för leadet.

recipient_idstringValfri

Det id som gavs till den här mottagaren när kampanjen skapades.

phone_numberslist of stringsValfri

Leadets listade nummer i uppringningsordning.

terminal_dispositionenumValfri

Varför leadet inte kommer att ringas igen; inte angivet så länge det fortfarande kan ringas.

created_at_unixintegerValfri

När leadet gick med i kampanjen; inte angivet för äldre leads.

deliveryobjectValfri

Leadets senaste meddelandeleverans; anges för meddelandekampanjer.

Fel

422

Leads Get Request Unprocessable Entity Error

Sökvägsparametrar

Headers

Svar

Fel