Utwórz kampanię wychodzącą

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
}

Utwórz kampanię wychodzącą, która dzwoni lub wysyła wiadomości do każdego odbiorcy z użyciem agenta, w oknach połączeń określonych przez zasady, ponawiając próby i wykonując follow-upy, jeśli zasady na to pozwalają. Dla nowej kampanii zwraca 201. Powtórzone żądanie, dopasowane przez idempotency_key lub treść, zwraca istniejącą kampanię z created ustawionym na false.

Żądanie

This endpoint expects an object.

call_namestringWymagany1-256 characters

Nazwa kampanii.

agent_idstringWymagany1-256 characters

Agent wykonujący połączenia.

recipientslist of objectsWymagany

Do kogo dzwonić. Każdy odbiorca staje się leadem kampanii.

channel_configobjectWymagany

scheduled_time_unixinteger or nullOpcjonalny>=0

Kiedy rozpocząć dzwonienie; pomiń, aby rozpocząć teraz. Połączenia i tak czekają na kolejne okno połączeń.

timezonestring or nullOpcjonalny

Strefa czasowa IANA, w której należy odczytywać okna połączeń, zastępująca tę z zasad.

branch_idstring or nullOpcjonalny<=256 characters

Gałąź agenta, z którą należy wykonać połączenie.

environmentstring or nullOpcjonalny<=256 characters

Środowisko, w którym należy rozwiązać zmienne środowiskowe agenta.

target_concurrency_limitinteger or nullOpcjonalny>=1

Maksymalna liczba połączeń do wykonania jednocześnie.

idempotency_keystring or nullOpcjonalny1-256 characters

Umożliwia bezpieczne ponowienie żądania: powtórzenie z tym samym kluczem zwraca utworzoną kampanię.

outcomeobject or nullOpcjonalny

Wynik uznawany za sukces połączeń kampanii.

policyobject or nullOpcjonalny

Zasady do zapisania w migawce kampanii. Jeśli są ustawione, mają pierwszeństwo przed domyślnymi zasadami workspace’u i nadpisaniami agenta; jeśli ich nie podano, musi istnieć konfiguracja workspace’u, która dostarczy zasady.

variantenum or nullOpcjonalny

simple wykonuje jedną próbę dla każdego odbiorcy, z zawsze aktywnymi oknami połączeń i bez zbierania danych; nie można go łączyć z policy. advanced używa policy lub konfiguracji workspace’u i jest domyślny dla kampanii telefonicznych.

Dozwolone wartości:

Odpowiedź

Pomyślna odpowiedź

campaignobject

createdboolean

False, gdy żądanie powtarza wcześniejsze i zwraca utworzoną przez nie kampanię.

within_calling_windowboolean

Czy dzwonienie zaczyna się od razu, a nie w następnym oknie połączeń.

Błędy

422

Unprocessable Entity Error

Nagłówki

Żądanie

Odpowiedź

Błędy