Obtenir un prospect de la campagne d'appels sortants

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

Récupère un prospect d’une campagne sortante.

Paramètres de chemin

campaign_idstringRequis

lead_idstringRequis

Réponse

Réponse réussie

lead_idstring

phone_numberstring

Numéro composé lors du prochain appel du prospect. Il change lorsque le prospect passe à un autre numéro de sa liste ou que le contact demande à être appelé sur un autre numéro.

phone_numbers_indexinteger

La position, dans phone_numbers, du numéro appelé.

user_idstring

Identité du contact : le user_id transmis dans conversation_initiation_client_data, ou, à défaut, le numéro de téléphone du prospect.

attempt_countinteger

Appels passés, comptabilisés dans max_total_calls de la politique.

failure_countinteger

Appels échoués vers le numéro actuel ; se réinitialise avec un nouveau numéro.

callback_countinteger

Rappels demandés par le contact.

redirect_countinteger

Nombre de fois où le contact a demandé à être appelé sur un autre numéro.

do_not_callboolean

Défini lorsque le contact a demandé à ne plus être appelé, que le prospect a été supprimé ou que la campagne s’est arrêtée. Le prospect n’est plus appelé.

updated_at_unixinteger

dynamic_variablesmap from strings to any

Variables dynamiques transmises pour le prospect, avec les secrets masqués.

overridesobject

Remplacements de conversation transmis pour le prospect.

recipient_idstringOptionnel

L’id attribué à ce destinataire lors de la création de la campagne.

phone_numberslist of stringsOptionnel

Numéros répertoriés du prospect, dans l’ordre d’appel.

terminal_dispositionenumOptionnel

Raison pour laquelle le prospect ne sera plus appelé ; non défini tant qu’il peut encore l’être.

created_at_unixintegerOptionnel

Date et heure auxquelles le prospect a rejoint la campagne ; non défini pour les prospects plus anciens.

deliveryobjectOptionnel

Dernière livraison de message du prospect ; défini pour les campagnes de messages.

Erreurs

422

Leads Get Request Unprocessable Entity Error

Paramètres de chemin

En-têtes

Réponse

Erreurs