Outbound-Kampagne erstellen

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": "string",
  "agent_id": "string",
  "recipients": [
    {}
  ],
  "channel_config": {
    "agent_phone_number_id": "string"
  }
}'

{
  "campaign": {
    "campaign_id": "string",
    "call_name": "string",
    "agent_id": "string",
    "channel_config": {
      "channel": "phone",
      "agent_phone_number_id": "string",
      "mode_config": {
        "ringing_timeout_secs": 60,
        "twilio_call_recording_enabled": false,
        "twilio_machine_detection": {
          "mode": "enable",
          "actions": [
            {
              "action": "hang_up",
              "answered_by": [
                "human"
              ]
            }
          ]
        },
        "mode": "voice"
      }
    },
    "status": "active",
    "policy": {
      "timezone": "string",
      "retry": {
        "retry_delay_seconds": 600,
        "max_short_retries": 1,
        "max_total_calls": 6,
        "max_callbacks": 2,
        "max_redirects": 2,
        "interval_placement": "start",
        "rotate_step_seconds": 900,
        "max_consecutive_failures_per_number": 1
      },
      "calling_periods": [
        {
          "weekdays": [
            1
          ],
          "intervals": [
            {
              "start": "string",
              "end": "string"
            }
          ]
        }
      ],
      "data_collection": {
        "callback_time": "string",
        "redirect_phone_number": "string",
        "stop": "string",
        "mappings": {}
      },
      "followup_context": {
        "call_type": true,
        "previous_conversation_id": true,
        "previous_summary": true,
        "previous_transcript": true
      }
    },
    "variant": "simple",
    "source": "ui",
    "outcome": {
      "type": "evaluation_criteria",
      "criteria_id": "string"
    },
    "created_at_unix": 1,
    "scheduled_time_unix": 1,
    "updated_at_unix": 1,
    "branch_id": "string",
    "environment": "string",
    "target_concurrency_limit": 1,
    "channel": "phone",
    "mode": "voice",
    "counts": {
      "leads": 1,
      "terminal_leads": 1,
      "open_attention": 1,
      "delivery": {
        "sent": 0,
        "delivered": 0,
        "read": 0,
        "replied": 0,
        "failed": 0
      }
    },
    "agent_name": ""
  },
  "created": true,
  "within_calling_window": true
}

Erstellt eine Outbound-Kampagne, die jeden Empfänger mit dem Agenten anruft oder ihm Nachrichten sendet, innerhalb der Anruffenster der Richtlinie und mit den erlaubten Wiederholungen und Nachfassaktionen. Gibt für eine neue Kampagne 201 zurück. Eine wiederholte Anfrage, die über idempotency_key oder andernfalls über ihren Body abgeglichen wird, gibt die bestehende Kampagne mit created auf false zurück.

Anfrage

This endpoint expects an object.

call_namestringErforderlich1-256 characters

Der Name der Kampagne.

agent_idstringErforderlich1-256 characters

Der Agent, der die Anrufe tätigt.

recipientslist of objectsErforderlich

Wer angerufen werden soll. Jeder Empfänger wird zu einem Lead der Kampagne.

channel_configobjectErforderlich

scheduled_time_unixinteger or nullOptional>=0

Zeitpunkt, zu dem Anrufe beginnen sollen; weglassen, um sofort zu starten. Anrufe warten weiterhin auf das nächste Anruffenster.

timezonestring or nullOptional

IANA-Zeitzone zum Lesen der Anruffenster, die die der Richtlinie überschreibt.

branch_idstring or nullOptional<=256 characters

Der Agent-Zweig, mit dem angerufen wird.

environmentstring or nullOptional<=256 characters

Die Umgebung, in der die Umgebungsvariablen des Agenten aufgelöst werden sollen.

target_concurrency_limitinteger or nullOptional>=1

Die maximale Anzahl gleichzeitig zu tätigender Anrufe.

idempotency_keystring or nullOptional1-256 characters

Macht die Anfrage sicher wiederholbar: Eine Wiederholung mit demselben Schlüssel gibt die erstellte Kampagne zurück.

outcomeobject or nullOptional

Das Ergebnis, das für die Anrufe der Kampagne als Erfolg zählt.

policyobject or nullOptional

Richtlinie, die für die Kampagne als Snapshot gespeichert wird. Wenn sie gesetzt ist, hat sie Vorrang vor dem Workspace-Standard und allen Überschreibungen pro Agent; wenn sie nicht gesetzt ist, muss die Workspace-Konfiguration vorhanden sein und stellt die Richtlinie bereit.

variantenum or nullOptional

simple führt einen Versuch pro Empfänger mit durchgehend offenen Anruffenstern durch und erfasst keine Daten; es kann nicht mit policy kombiniert werden. advanced verwendet policy oder die Workspace-Konfiguration und ist der Standard für Telefonkampagnen.

Erlaubte Werte:

Antwort

Erfolgreiche Antwort

campaignobject

createdboolean

False, wenn die Anfrage eine frühere wiederholt und deren Kampagne zurückgegeben hat.

within_calling_windowboolean

Ob Anrufe sofort beginnen, statt erst im nächsten Anruffenster.

Fehler

422

Unprocessable Entity Error

Header

Anfrage

Antwort

Fehler