아웃바운드 캠페인 생성

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
}

정책의 통화 가능 시간대 내에서 에이전트가 각 수신자에게 전화하거나 메시지를 보내고, 허용되는 경우 재시도 및 후속 조치를 수행하는 아웃바운드 캠페인을 생성합니다. 새 캠페인에는 201을 반환합니다. idempotency_key 또는 요청 본문으로 일치하는 반복 요청은 기존 캠페인을 created가 false인 상태로 반환합니다.

요청

This endpoint expects an object.

call_namestring필수1-256 characters

캠페인 이름입니다.

agent_idstring필수1-256 characters

통화를 시작하는 에이전트입니다.

recipientslist of objects필수

통화할 대상입니다. 각 수신자는 캠페인의 리드가 됩니다.

channel_configobject필수

scheduled_time_unixinteger or null선택 사항>=0

통화를 시작할 시점입니다. 생략하면 지금 시작합니다. 통화는 다음 통화 가능 시간대까지 기다립니다.

timezonestring or null선택 사항

정책 설정을 재정의하여 통화 가능 시간대를 해석하는 IANA 시간대입니다.

branch_idstring or null선택 사항<=256 characters

통화에 사용할 에이전트 브랜치입니다.

environmentstring or null선택 사항<=256 characters

에이전트 환경 변수를 해석할 환경입니다.

target_concurrency_limitinteger or null선택 사항>=1

동시에 시작할 최대 통화 수입니다.

idempotency_keystring or null선택 사항1-256 characters

요청을 안전하게 재시도할 수 있게 합니다. 동일한 키로 반복 요청하면 생성된 캠페인을 반환합니다.

outcomeobject or null선택 사항

캠페인 통화에서 성공으로 간주되는 결과입니다.

policyobject or null선택 사항

캠페인에 스냅샷으로 적용할 정책입니다. 설정하면 워크스페이스 기본값 및 에이전트별 재정의 설정에 우선하며, 생략하면 워크스페이스 구성이 존재해야 하고 해당 구성이 정책을 제공합니다.

variantenum or null선택 사항

simple은 항상 열려 있는 통화 가능 시간대에서 수집 항목 없이 수신자당 한 번 시도하며, policy와 함께 사용할 수 없습니다. advanced는 policy 또는 워크스페이스 구성을 사용하며 전화 캠페인의 기본값입니다.

허용된 값:

응답

성공 응답

campaignobject

createdboolean

요청이 이전 요청을 반복하여 해당 캠페인을 반환한 경우 false입니다.

within_calling_windowboolean

다음 통화 가능 시간대가 아니라 즉시 통화를 시작할지 여부입니다.

오류

422

Unprocessable Entity Error

헤더

요청

응답

오류