キャンペーンとは、連絡先リストに順番に連絡し、発信通話を開始して、各連絡先を対応可能なエージェントに接続するアウトバウンド自動ダイヤル機能のことです。キャンペーン エンドポイントはキャンペーン関連のデータへのアクセスを提供し、キャンペーン オブジェクトと連絡先オブジェクトの取得を可能にします。
キャンペーン オブジェクト: プラットフォーム内の 1 つのキャンペーンを表します
Contact オブジェクト: 特定のキャンペーン内の個々のキャンペーンの連絡先を表します
次のモデルを参照して、どのフィールドに PII が含まれている可能性があるかを確認します。
[
{
"campaign_type" : "default",
"id" : 67,
"external_campaign_id" : null,
"max_abandonment_percent" : 3,
"max_redial_count" : 3,
"mode" : "preview",
"name" : "string",
"overdial_adjustment_multiplier" : 1,
"queue" : {
"deleted" : false,
"hidden" : false,
"id" : 60,
"menu_type" : "ivr_menu",
"name" : "string",
"output_msg" : null,
"parent_id" : 59,
"position" : 4
},
"redial_interval_minutes" : 120,
"status" : "dialing",
"target_number_to_process" : 1000,
"created_at" : "2023-04-01T23:23:43.000Z",
"starts_at" : "2023-04-01T23:28:08.000Z",
"ends_at" : null,
"updated_at" : "2023-04-01T23:28:08.000Z",
"contact_stats" : {
"Abandoned by Contact" : 0,
"Abandoned by Dialer" : 0,
"Average Redials per Number" : 0,
"Carrier Error" : 0,
"Completed" : 50,
"Connected" : 0,
"Contacts" : 1000,
"Dialer General Error" : 0,
"Dialing" : 0,
"Do Not Call" : 0,
"Finished" : 40,
"Invalid Number or Name" : 0,
"Invalid outbound number" : 0,
"Not Picked Up" : 0,
"Not Reached to Contact" : 0,
"Not reached" : 10,
"Not yet reached" : 960,
"Queued" : 0,
"Reached" : 0,
"Redial Scheduled" : 0,
"Redials" : 0,
"Remaining" : 950,
"Running" : 0,
"Skipped" : 0,
"Skipped & Closed" : 10,
"Transferred" : 0,
"Transferred and Finished" : 0,
"Upcoming" : 950,
"Voicemail Hung Up" : 0
}
}
]
キャンペーンのステータス フィールド
status フィールドは次のいずれかの状態になります。
| キャンペーンのステータス | 説明 |
|---|---|
| created | キャンペーンは作成されていますが、アウトバウンド通話はまだ開始されていません。 |
| 開始済み | キャンペーンが発信を開始しましたが、通話を開始していません（会話）。 |
| ダイヤル | キャンペーンでアウトバウンド コールが発信されている。 |
| pause | キャンペーンがエージェントまたは管理者によって一時停止されました。 |
| 終了 | キャンペーンのすべての通話が完了しました。 |
キャンペーン モード フィールド
mode フィールドは次のいずれかの値になります。
| キャンペーン モード | 説明 |
|---|---|
| プレビュー | プレビュー キャンペーンでは、エージェントはエンドユーザーに接続するか、特定の連絡先に対して行うアクションを選択します。プレビュー キャンペーンでは、連絡先またはエンドユーザーがわかっています。 |
| 予測 | 予測キャンペーンの場合、エージェントは予約通話に接続されます。この通話で機械検出をオンにすると、アウトバウンド コールへの応答が人間によるものか機械（ボイスメールなど）によるものかがわかり、エージェントは人間のみに接続されます。 |
| 改革志向 | プログレッシブ キャンペーンの場合、ダイヤラーはまず最初に使用可能なエージェントに接続します。接続されると、電話アプリが発信し、最初に使用可能な連絡先（特定のキャンペーンでまだ電話をかけていない連絡先）をエージェントに配信します。 |
キャンペーン タイプ フィールド
campaign_type フィールドは次のいずれかの値になります。
| キャンペーン タイプ | 説明 |
|---|---|
| デフォルト | キャンペーンの連絡先は、ユーザーがアップロードした CSV ファイルから取得されます。 |
| external_list | キャンペーンの連絡先は、外部サービスまたはサードパーティ サービスからのものです。 |
キャンペーン リスト
エンドポイント:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns
リクエスト/レスポンスのその他の例:
リクエストの例: キャンペーン リスト
クエリ: なし
本文: なし
レスポンスの例: キャンペーン リスト
[
{
"campaign_type": "default",
"id": 67,
"external_campaign_id": null,
"max_abandonment_percent": 3,
"max_redial_count": 3,
"mode": "preview",
"name": "string",
"overdial_adjustment_multiplier": 1,
"queue": {
"deleted": false,
"hidden": false,
"id": 60,
"menu_type": "ivr_menu",
"name": "string",
"output_msg": null,
"parent_id": 59,
"position": 4
},
"redial_interval_minutes": 120,
"status": "dialing",
"target_number_to_process": 1000,
"created_at": "2023-04-01T23:23:43.000Z",
"starts_at": "2023-04-01T23:28:08.000Z",
"ends_at": null,
"updated_at": "2023-04-01T23:28:08.000Z",
"contact_stats": {
"Abandoned by Contact": 0,
"Abandoned by Dialer": 0,
"Average Redials per Number": 0,
"Carrier Error": 0,
"Completed": 50,
"Connected": 0,
"Contacts": 1000,
"Dialer General Error": 0,
"Dialing": 0,
"Do Not Call": 0,
"Finished": 40,
"Invalid Number or Name": 0,
"Invalid outbound number": 0,
"Not Picked Up": 0,
"Not Reached to Contact": 0,
"Not reached": 10,
"Not yet reached": 960,
"Queued": 0,
"Reached": 0,
"Redial Scheduled": 0,
"Redials": 0,
"Remaining": 950,
"Running": 0,
"Skipped": 0,
"Skipped & Closed": 10,
"Transferred": 0,
"Transferred and Finished": 0,
"Upcoming": 950,
"Voicemail Hung Up": 0
}
}
]
ステータス コード: 200
1 つのキャンペーンの場合
エンドポイント:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}
リクエスト/レスポンスのその他の例:
リクエストの例: 単一のキャンペーン
クエリ:
| パラメータ | 必須 | データ型 | 定義 |
|---|---|---|---|
| campaign_id | TRUE | Integer | 取得するキャンペーンの ID |
本文: なし
回答の例: 単一のキャンペーン
{
"campaign_type": "default",
"id": 67,
"external_campaign_id": null,
"max_abandonment_percent": 3,
"max_redial_count": 3,
"mode": "preview",
"name": "string",
"overdial_adjustment_multiplier": 1,
"queue": {
"deleted": false,
"hidden": false,
"id": 60,
"menu_type": "ivr_menu",
"name": "string",
"output_msg": null,
"parent_id": 59,
"position": 4
},
"redial_interval_minutes": 120,
"status": "dialing",
"target_number_to_process": 1000,
"created_at": "2023-04-01T23:23:43.000Z",
"starts_at": "2023-04-01T23:28:08.000Z",
"ends_at": null,
"updated_at": "2023-04-01T23:28:08.000Z",
"contact_stats": {
"Abandoned by Contact": 0,
"Abandoned by Dialer": 0,
"Average Redials per Number": 0,
"Carrier Error": 0,
"Completed": 50,
"Connected": 0,
"Contacts": 1000,
"Dialer General Error": 0,
"Dialing": 0,
"Do Not Call": 0,
"Finished": 40,
"Invalid Number or Name": 0,
"Invalid outbound number": 0,
"Not Picked Up": 0,
"Not Reached to Contact": 0,
"Not reached": 10,
"Not yet reached": 960,
"Queued": 0,
"Reached": 0,
"Redial Scheduled": 0,
"Redials": 0,
"Remaining": 950,
"Running": 0,
"Skipped": 0,
"Skipped & Closed": 10,
"Transferred": 0,
"Transferred and Finished": 0,
"Upcoming": 950,
"Voicemail Hung Up": 0
}
}
ステータス コード: 200
連絡先リスト
| パラメータ | 必須 | データ型 | 定義 |
|---|---|---|---|
| campaign_id | TRUE | Integer | 連絡先を取得するキャンペーンの ID |
エンドポイント:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}/contacts
リクエスト/レスポンスのその他の例:
リクエストの例: 連絡先リスト
クエリ:
| パラメータ | 必須 | データ型 | 定義 |
|---|---|---|---|
| campaign_id | TRUE | Integer | 連絡先を取得するキャンペーンの ID |
本文: なし
レスポンスの例: 連絡先リスト
[
{
"assigned_call_id": 32001,
"assigned_participant_id": 54321,
"campaign_id": 240,
"created_at": "2023-04-01T17:15:38.000Z",
"id": 16312,
"name": "string",
"outbound_number": null,
"priority": null,
"status": "Upcoming",
"unique_id": "string",
"updated_at": "2023-04-01T17:15:38.000Z"
},
{
"assigned_call_id": 32002,
"assigned_participant_id": 54330,
"campaign_id": 240,
"created_at": "2023-04-01T17:15:38.000Z",
"id": 16313,
"name": "string",
"outbound_number": null,
"priority": null,
"status": "Upcoming",
"unique_id": "string",
"updated_at": "2023-04-01T17:15:38.000Z"
}
]
ステータス コード: 200