アウトバウンドキャンペーンを停止

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

アウトバウンドキャンペーンを完全に停止します。キュー内の通話はキャンセルされ、どのリードにも再度電話しません。発信済みの通話がまだ終了処理中の場合、キャンペーンがstopping の状態で202を返します。

パスパラメータ

campaign_idstring必須

レスポンス

成功レスポンス。

campaign_idstring

call_namestring

キャンペーン名。

agent_idstring

channel_configobject

statusenum

attention は、未解決の対応項目によってキャンペーンの一部の通話が保留され、残りは進行中であることを示します。stopping は、キュー内の通話がキャンセルされ、発信済みの通話が終了処理中であることを示します。

policyobject

キャンペーン作成時に適用されたポリシー。

variantenum

許可された値:

sourceenum or null

キャンペーンがアプリとAPIのどちらから作成されたか。

許可された値:

outcomeobject or null

キャンペーンの通話で成功と見なされる結果。

created_at_unixinteger

scheduled_time_unixinteger or null

キャンペーンが発信を開始する日時。未設定の場合は、作成後に開始します。

updated_at_unixinteger

branch_idstring or null

キャンペーンが通話に使用するエージェントブランチ。

environmentstring or null

エージェントの環境変数を解決する環境。

target_concurrency_limitinteger or null

キャンペーンが同時に発信する最大通話数。

channelenum

許可された値:

modeenum

許可された値:

countsobject

agent_namestringデフォルト値

エラー

422

Unprocessable Entity Error

パスパラメータ

ヘッダー

レスポンス

エラー