Crea una campagna outbound

POST

/v1/convai/outbound-campaigns/campaigns/submit

POST

/v1/convai/outbound-campaigns/campaigns/submit

curl -X POST https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/submit \
     -H "Content-Type: application/json" \
     -d '{
  "call_name": "call_name",
  "agent_id": "agent_id",
  "recipients": [
    {}
  ],
  "channel_config": {
    "channel": "phone",
    "agent_phone_number_id": "agent_phone_number_id"
  }
}'

{
  "campaign": {
    "campaign_id": "campaign_id",
    "call_name": "call_name",
    "agent_id": "agent_id",
    "channel_config": {
      "channel": "phone",
      "agent_phone_number_id": "agent_phone_number_id"
    },
    "status": "active",
    "policy": {
      "timezone": "timezone",
      "retry": {},
      "calling_periods": [
        {
          "weekdays": [
            1
          ],
          "intervals": [
            {
              "start": "start",
              "end": "end"
            }
          ]
        }
      ],
      "data_collection": {},
      "followup_context": {}
    },
    "variant": "simple",
    "created_at_unix": 1,
    "updated_at_unix": 1,
    "channel": "phone",
    "mode": "voice",
    "counts": {
      "leads": 1,
      "terminal_leads": 1,
      "open_attention": 1
    },
    "agent_name": "agent_name",
    "source": "ui",
    "outcome": {
      "type": "data_collection",
      "data_collection_id": "data_collection_id",
      "equals": [
        "equals"
      ]
    },
    "scheduled_time_unix": 1,
    "branch_id": "branch_id",
    "environment": "environment",
    "target_concurrency_limit": 1
  },
  "created": true,
  "within_calling_window": true
}

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.

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_unixintegerOpzionale>=0

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

timezonestringOpzionale

Fuso orario IANA in cui interpretare le finestre di chiamata, in sostituzione di quello della policy.

branch_idstringOpzionale<=256 characters

Il ramo dell'agente da usare per chiamare.

environmentstringOpzionale<=256 characters

L'ambiente in cui risolvere le variabili d'ambiente dell'agente.

target_concurrency_limitintegerOpzionale>=1

Il numero massimo di chiamate da effettuare contemporaneamente.

idempotency_keystringOpzionale1-256 characters

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

outcomeobjectOpzionale

Il risultato considerato un successo per le chiamate della campagna.

policyobjectOpzionale

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.

variantenumOpzionale

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

Outbound Campaigns Create Request Unprocessable Entity Error

Header

Richiesta

Risposta

Errori