ナビゲーションにスキップ

アウトバウンドキャンペーンを作成

ポリシーの発信時間帯に、許可された再試行とフォローアップを行いながら、エージェントが各受信者へ電話またはメッセージを送るアウトバウンドキャンペーンを作成します。新しいキャンペーンの場合は201を返します。idempotency_key、または指定されていない場合はリクエスト本文が一致する重複リクエストでは、既存のキャンペーンをcreated がfalseの状態で返します。

ヘッダー

xi-api-keystringオプション

リクエスト

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 は、常時有効な発信時間帯で受信者ごとに1回だけ発信し、データは収集しません。policy とは併用できません。advanced はpolicy またはワークスペース設定を使用し、電話キャンペーンのデフォルトです。

許可された値:

レスポンス

成功レスポンス。

campaignobject
createdboolean

以前のリクエストと重複し、そのキャンペーンが返された場合はfalseです。

within_calling_windowboolean

次の発信可能時間帯を待たず、すぐに発信を開始するかどうか。

エラー

422
Unprocessable Entity Error