아웃바운드 캠페인 중지

POST

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

POST

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

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

{
  "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
}

아웃바운드 캠페인을 영구 중지합니다. 대기 중인 통화는 취소되고 어떤 리드에도 다시 통화하지 않습니다. 이미 시작된 통화가 마무리되는 동안에는 캠페인 stopping과 함께 202를 반환합니다.

경로 매개변수

campaign_idstring필수

응답

성공 응답

campaign_idstring

call_namestring

캠페인 이름입니다.

agent_idstring

channel_configobject

statusenum

attention은 해결되지 않은 주의 항목으로 인해 캠페인의 일부 통화가 보류되고 나머지는 진행됨을 의미합니다. stopping은 대기 중인 통화가 취소되고 이미 시작된 통화는 마무리 중임을 의미합니다.

policyobject

캠페인 생성 시 적용된 정책입니다.

variantenum

허용된 값:

created_at_unixinteger

updated_at_unixinteger

channelenum

허용된 값:

modeenum

허용된 값:

countsobject

agent_namestring기본값

sourceenum선택 사항

캠페인이 앱에서 생성되었는지 API를 통해 생성되었는지 여부입니다.

허용된 값:

outcomeobject선택 사항

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

scheduled_time_unixinteger선택 사항

캠페인이 통화를 시작하는 시점입니다. 설정하지 않으면 생성 즉시 시작합니다.

branch_idstring선택 사항

캠페인이 통화에 사용하는 에이전트 브랜치입니다.

environmentstring선택 사항

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

target_concurrency_limitinteger선택 사항

캠페인이 동시에 시작할 수 있는 최대 통화 수입니다.

오류

422

Outbound Campaigns Stop Request Unprocessable Entity Error

경로 매개변수

헤더

응답

오류