Vai alla navigazione
ElevenAgentsCampagne

Crea una campagna outbound

Crea una campagna in uscita che chiama o invia messaggi a ogni destinatario con l’agente, nelle finestre di chiamata della policy, riprovando e ricontattando quando consentito. Restituisce 201 per una nuova campagna. Una richiesta ripetuta, identificata tramite idempotency_key o altrimenti tramite il suo body, restituisce la campagna esistente con created impostato su false.

Header

xi-api-keystringOpzionale

Richiesta

This endpoint expects an object.
call_namestringObbligatorio1-256 characters
Il nome della campagna.
agent_idstringObbligatorio1-256 characters
L'agente che effettua le chiamate.
recipientslist of objectsObbligatorio
Chi chiamare. Ogni destinatario diventa un lead della campagna.
channel_configobjectObbligatorio
scheduled_time_unixinteger or nullOpzionale>=0

Quando iniziare a chiamare; ometti per iniziare subito. Le chiamate attendono comunque la successiva finestra di chiamata.

timezonestring or nullOpzionale
Fuso orario IANA in cui interpretare le finestre di chiamata, in sostituzione di quello della policy.
branch_idstring or nullOpzionale<=256 characters
Il ramo dell'agente da usare per chiamare.
environmentstring or nullOpzionale<=256 characters
L'ambiente in cui risolvere le variabili d'ambiente dell'agente.
target_concurrency_limitinteger or nullOpzionale>=1
Il numero massimo di chiamate da effettuare contemporaneamente.
idempotency_keystring or nullOpzionale1-256 characters

Rende la richiesta sicura da ritentare: una ripetizione con la stessa chiave restituisce la campagna creata.

outcomeobject or nullOpzionale
Il risultato considerato un successo per le chiamate della campagna.
policyobject or nullOpzionale

Policy di cui acquisire uno snapshot nella campagna. Se impostata, ha la precedenza sull’impostazione predefinita del workspace e su qualsiasi override per agente; se omessa, deve esistere la configurazione del workspace, che fornisce la policy.

variantenum or nullOpzionale

simple esegue un tentativo per destinatario con finestre di chiamata sempre attive e senza raccogliere dati, e non può essere combinato con policy. advanced usa policy o la configurazione del workspace ed è l’impostazione predefinita per le campagne telefoniche.

Valori consentiti:

Risposta

Risposta riuscita
campaignobject
createdboolean
False quando la richiesta ripete una richiesta precedente e restituisce la relativa campagna.
within_calling_windowboolean

Se le chiamate iniziano subito anziché alla successiva finestra di chiamata.

Errori

422
Unprocessable Entity Error