Een lead van uitgaande campagne ophalen

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

Haal één lead van een uitgaande campagne op.

Padparameters

campaign_idstringVerplicht

lead_idstringVerplicht

Response

Geslaagde response

lead_idstring

phone_numberstring

Het nummer dat de volgende oproep van de lead belt. Dit verandert wanneer de lead doorgaat naar een ander opgegeven nummer of de contactpersoon vraagt om op een ander nummer te worden gebeld.

phone_numbers_indexinteger

De positie in phone_numbers van het nummer dat wordt gebeld.

user_idstring

De identiteit van de contactpersoon: de user_id die is ingediend in conversation_initiation_client_data, anders het telefoonnummer van de lead.

attempt_countinteger

Geplaatste oproepen, meegeteld voor max_total_calls van het beleid.

failure_countinteger

Mislukte oproepen naar het huidige nummer; wordt gereset bij een nieuw nummer.

callback_countinteger

Terugbelverzoeken van de contactpersoon.

redirect_countinteger

Het aantal keren dat de contactpersoon vroeg om op een ander nummer te worden gebeld.

do_not_callboolean

Ingesteld wanneer de contactpersoon heeft gevraagd niet te worden gebeld, de lead is verwijderd of de campagne is gestopt. De lead wordt niet opnieuw gebeld.

updated_at_unixinteger

dynamic_variablesmap from strings to any

De dynamische variabelen die voor de lead zijn ingediend, waarbij geheimen zijn weggelaten.

overridesobject

De gespreksoverschrijvingen die voor de lead zijn ingediend.

recipient_idstringOptioneel

De id die aan deze ontvanger is gegeven toen de campagne werd gemaakt.

phone_numberslist of stringsOptioneel

De opgegeven nummers van de lead, in belvolgorde.

terminal_dispositionenumOptioneel

Waarom de lead niet opnieuw wordt gebeld; niet ingesteld zolang dit nog mogelijk is.

created_at_unixintegerOptioneel

Wanneer de lead aan de campagne is toegevoegd; niet ingesteld voor oudere leads.

deliveryobjectOptioneel

De meest recente berichtbezorging van de lead; ingesteld bij berichtencampagnes.

Fouten

422

Leads Get Request Unprocessable Entity Error

Padparameters

Headers

Response

Fouten