Skapa en utgående kampanj

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
}

Skapa en utgående kampanj som ringer upp eller skickar meddelanden till varje mottagare med agenten, inom policyns samtalsfönster, med nya försök och uppföljningar enligt vad som tillåts. Returnerar 201 för en ny kampanj. En upprepad begäran, som matchas via idempotency_key eller annars via sin brödtext, returnerar den befintliga kampanjen med created satt till false.

Förfrågan

This endpoint expects an object.

call_namestringObligatorisk1-256 characters

Kampanjens namn.

agent_idstringObligatorisk1-256 characters

Agenten som genomför samtalen.

recipientslist of objectsObligatorisk

Vem som ska ringas. Varje mottagare blir ett lead i kampanjen.

channel_configobjectObligatorisk

scheduled_time_unixinteger or nullValfri>=0

När uppringningen ska börja; utelämna för att börja nu. Samtal väntar fortfarande på nästa tidsfönster för uppringning.

timezonestring or nullValfri

IANA-tidszon att läsa samtalsfönstren i, som åsidosätter policyns.

branch_idstring or nullValfri<=256 characters

Agentgrenen att ringa med.

environmentstring or nullValfri<=256 characters

Miljön där agentens miljövariabler ska lösas.

target_concurrency_limitinteger or nullValfri>=1

Det högsta antalet samtal att genomföra samtidigt.

idempotency_keystring or nullValfri1-256 characters

Gör begäran säker att försöka igen: en upprepning med samma nyckel returnerar kampanjen den skapade.

outcomeobject or nullValfri

Resultatet som räknas som lyckat för kampanjens samtal.

policyobject or nullValfri

Policy att spara som en ögonblicksbild för kampanjen. När den anges har den företräde framför arbetsytans standard och eventuella åsidosättningar per agent; när den utelämnas måste arbetsytans konfiguration finnas och tillhandahåller policyn.

variantenum or nullValfri

simple gör ett försök per mottagare med alltid öppna samtalsfönster och utan att samla in något, och kan inte kombineras med policy. advanced använder policy eller arbetsytans konfiguration och är standard för telefonkampanjer.

Tillåtna värden:

Svar

Lyckat svar

campaignobject

createdboolean

False när begäran upprepade en tidigare begäran och returnerade dess kampanj.

within_calling_windowboolean

Om uppringningen börjar direkt i stället för vid nästa tidsfönster för uppringning.

Fel

422

Unprocessable Entity Error

Headers

Förfrågan

Svar

Fel