Outbound-Kampagne abrufen

GET

/v1/convai/outbound-campaigns/campaigns/:campaign_id

GET

/v1/convai/outbound-campaigns/campaigns/:campaign_id

curl https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id

{
  "campaign_id": "campaign_id",
  "call_name": "call_name",
  "agent_id": "agent_id",
  "channel_config": {
    "channel": "phone",
    "agent_phone_number_id": "agent_phone_number_id",
    "mode_config": {
      "ringing_timeout_secs": 1,
      "twilio_call_recording_enabled": true,
      "mode": "voice"
    }
  },
  "status": "active",
  "policy": {
    "timezone": "timezone",
    "retry": {
      "retry_delay_seconds": 1,
      "max_short_retries": 1,
      "max_total_calls": 1,
      "max_callbacks": 1,
      "max_redirects": 1,
      "interval_placement": "start",
      "rotate_step_seconds": 1,
      "max_consecutive_failures_per_number": 1
    },
    "calling_periods": [
      {
        "weekdays": [
          1
        ],
        "intervals": [
          {
            "start": "start",
            "end": "end"
          }
        ]
      }
    ],
    "data_collection": {
      "callback_time": "callback_time",
      "redirect_phone_number": "redirect_phone_number",
      "stop": "stop",
      "mappings": {
        "key": "value"
      }
    },
    "followup_context": {
      "call_type": true,
      "previous_conversation_id": true,
      "previous_summary": true,
      "previous_transcript": true
    }
  },
  "variant": "simple",
  "created_at_unix": 1,
  "updated_at_unix": 1,
  "channel": "phone",
  "mode": "voice",
  "counts": {
    "leads": 1,
    "terminal_leads": 1,
    "open_attention": 1,
    "delivery": {
      "sent": 1,
      "delivered": 1,
      "read": 1,
      "replied": 1,
      "failed": 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
}

Ruft eine Outbound-Kampagne und ihre Lead-Anzahlen ab.

Pfadparameter

campaign_idstringErforderlich

Antwort

Erfolgreiche Antwort

campaign_idstring

call_namestring

Der Name der Kampagne.

agent_idstring

channel_configobject

statusenum

attention bedeutet, dass ein offener Prüfpunkt einige Anrufe der Kampagne zurückhält, während die übrigen fortgesetzt werden. stopping bedeutet, dass geplante Anrufe abgebrochen werden und bereits gestartete Anrufe beendet werden.

policyobject

Die Richtlinie, die die Kampagne bei ihrer Erstellung verwendet hat.

variantenum

Erlaubte Werte:

created_at_unixinteger

updated_at_unixinteger

channelenum

Erlaubte Werte:

modeenum

Erlaubte Werte:

countsobject

agent_namestringStandardwert ist

sourceenumOptional

Ob die Kampagne in der App oder über die API erstellt wurde.

Erlaubte Werte:

outcomeobjectOptional

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

scheduled_time_unixintegerOptional

Zeitpunkt, zu dem die Kampagne mit Anrufen beginnt; nicht gesetzt, um nach der Erstellung zu starten.

branch_idstringOptional

Der Agent-Zweig, mit dem die Kampagne anruft.

environmentstringOptional

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

target_concurrency_limitintegerOptional

Die maximale Anzahl von Anrufen, die die Kampagne gleichzeitig tätigt.

Fehler

422

Outbound Campaigns Get Request Unprocessable Entity Error

Pfadparameter

Header

Antwort

Fehler