Passer à la navigation
ElevenAgentsCampagnesProspects

Obtenir un prospect de la campagne d'appels sortants

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

Paramètres de chemin

campaign_idstringRequis
lead_idstringRequis

En-têtes

xi-api-keystringOptionnel

Réponse

Réponse réussie

lead_idstring
recipient_idstring or null

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

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é.

terminal_dispositionenum or null

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

created_at_unixinteger or null

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

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.
phone_numberslist of stringsOptionnel

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

deliveryobject or nullOptionnel

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

Erreurs

422
Unprocessable Entity Error