캠페인은 연락처 목록에 순차적으로 연결하고, 아웃바운드 통화를 시작하고, 각 연락처를 사용 가능한 상담사에게 연결하는 아웃바운드 자동 다이얼러 기능을 말합니다. 캠페인 엔드포인트는 캠페인 관련 데이터에 대한 액세스를 제공하여 캠페인 및 연락처 객체를 검색할 수 있도록 합니다.
캠페인 객체: 플랫폼 내에서 단일 캠페인을 나타냅니다.
연락처 객체: 개별 캠페인 연락처를 나타냅니다. 특정 캠페인 내에서
다음 모델을 참고하여 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 필드는 다음 상태 중 하나일 수 있습니다.
| 캠페인 상태 | 설명 |
|---|---|
| 생성됨 | 캠페인이 생성되었지만 아웃바운드 통화를 시작하지 않았습니다. |
| 시작됨 | 캠페인이 아웃바운드 통화를 시작했지만 다이얼링 (대화)을 시작하지 않았습니다. |
| 다이얼링 | 캠페인이 아웃바운드 통화를 다이얼링하고 있습니다. |
| 일시중지 | 상담사 또는 관리자가 캠페인을 일시중지했습니다. |
| 완료됨 | 캠페인이 모든 통화를 완료했습니다. |
캠페인 모드 필드
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
단일 캠페인
엔드포인트:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}
요청/응답 예시 더보기:
요청 예시: 단일 캠페인
검색어:
| 매개변수 | 필수 | 데이터 유형 | 정의 |
|---|---|---|---|
| campaign_id | TRUE | 정수 | 검색하려는 캠페인의 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 | 정수 | 연락처를 가져오려는 캠페인의 ID |
엔드포인트:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}/contacts
요청/응답 예시 더보기:
요청 예시: 연락처 목록
검색어:
| 매개변수 | 필수 | 데이터 유형 | 정의 |
|---|---|---|---|
| campaign_id | TRUE | 정수 | 연락처를 가져오려는 캠페인의 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