Get lead

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

Get one lead of an outbound campaign.

Path parameters

campaign_idstringRequired

lead_idstringRequired

Response

Successful Response

lead_idstring

phone_numberstring

The number the lead's next call dials. It changes when the lead moves on to another listed number or the contact asks to be called on a different one.

phone_numbers_indexinteger

The position in phone_numbers of the number being called.

user_idstring

The contact’s identity: the user_id submitted in conversation_initiation_client_data, else the lead’s phone number.

attempt_countinteger

Calls placed, counted against the policy’s max_total_calls.

failure_countinteger

Failed calls to the current number; resets on a new number.

callback_countinteger

Callbacks the contact asked for.

redirect_countinteger

Times the contact asked to be called on another number.

do_not_callboolean

Set when the contact asked not to be called, the lead was removed, or the campaign stopped. The lead isn't called again.

updated_at_unixinteger

dynamic_variablesmap from strings to any

The dynamic variables submitted for the lead, with secrets redacted.

overridesobject

The conversation overrides submitted for the lead.

recipient_idstringOptional

The id given to this recipient when the campaign was created.

phone_numberslist of stringsOptional

The lead's listed numbers, in calling order.

terminal_dispositionenumOptional

Why the lead won’t be called again; unset while it may be.

created_at_unixintegerOptional

When the lead joined the campaign; unset on older leads.

deliveryobjectOptional

The lead’s latest message delivery; set on message campaigns.

Errors

422

Leads Get Request Unprocessable Entity Error

Path parameters

Headers

Response

Errors