アウトバウンドキャンペーンを作成
ポリシーの発信時間帯に、許可された再試行とフォローアップを行いながら、エージェントが各受信者へ電話またはメッセージを送るアウトバウンドキャンペーンを作成します。新しいキャンペーンの場合は201を返します。idempotency_key、または指定されていない場合はリクエスト本文が一致する重複リクエストでは、既存のキャンペーンをcreated がfalseの状態で返します。
ヘッダー
リクエスト
キャンペーン名。
通話を発信するエージェント。
発信先。各受信者はキャンペーンのリードになります。
発信を開始する日時。省略すると今すぐ開始します。ただし、通話は次の発信可能時間帯まで待機します。
発信時間帯の解釈に使用するIANAタイムゾーン。ポリシーの設定を上書きします。
通話に使用するエージェントブランチ。
エージェントの環境変数を解決する環境。
同時に発信する最大通話数。
リクエストを安全に再試行できるようにします。同じキーで再度リクエストすると、そのキーで作成されたキャンペーンが返されます。
キャンペーンの通話で成功と見なされる結果。
キャンペーンにスナップショットとして保存するポリシー。設定すると、ワークスペースのデフォルトおよびエージェントごとのオーバーライドより優先されます。省略する場合はワークスペース設定が必要で、そこからポリシーが適用されます。
simple は、常時有効な発信時間帯で受信者ごとに1回だけ発信し、データは収集しません。policy とは併用できません。advanced はpolicy またはワークスペース設定を使用し、電話キャンペーンのデフォルトです。
レスポンス
成功レスポンス。
以前のリクエストと重複し、そのキャンペーンが返された場合はfalseです。
次の発信可能時間帯を待たず、すぐに発信を開始するかどうか。