Vai alla navigazione

Ottieni un lead della campagna outbound

Ottieni un lead di una campagna in uscita.

Parametri di percorso

campaign_idstringObbligatorio
lead_idstringObbligatorio

Header

xi-api-keystringOpzionale

Risposta

Risposta riuscita
lead_idstring
recipient_idstring or null

L’id assegnato a questo destinatario alla creazione della campagna.

phone_numberstring
Il numero composto dalla prossima chiamata del lead. Cambia quando il lead passa a un altro numero nell'elenco o il contatto chiede di essere chiamato su un numero diverso.
phone_numbers_indexinteger

La posizione in phone_numbers del numero chiamato.

user_idstring

L’identità del contatto: l’user_id inviato in conversation_initiation_client_data, altrimenti il numero di telefono del lead.

attempt_countinteger

Chiamate effettuate, conteggiate rispetto a max_total_calls della policy.

failure_countinteger

Chiamate non riuscite al numero attuale; il conteggio si reimposta con un nuovo numero.

callback_countinteger
Richiamate richieste dal contatto.
redirect_countinteger
Le volte in cui il contatto ha chiesto di essere richiamato a un altro numero.
do_not_callboolean

Impostato quando il contatto ha chiesto di non essere chiamato, il lead è stato rimosso o la campagna è stata interrotta. Il lead non verrà più chiamato.

terminal_dispositionenum or null

Perché il lead non verrà più chiamato; non impostato finché può ancora esserlo.

created_at_unixinteger or null

Quando il lead è entrato nella campagna; non impostato per i lead meno recenti.

updated_at_unixinteger
dynamic_variablesmap from strings to any
Le variabili dinamiche inviate per il lead, con i segreti oscurati.
overridesobject
Gli override della conversazione inviati per il lead.
phone_numberslist of stringsOpzionale
I numeri elencati del lead, nell'ordine di chiamata.
deliveryobject or nullOpzionale

L’ultima consegna di messaggi del lead; impostata nelle campagne di messaggi.

Errori

422
Unprocessable Entity Error