Kampanye mengacu pada fitur panggilan otomatis keluar yang secara berurutan menghubungi daftar kontak, memulai panggilan keluar, dan menghubungkan setiap kontak ke agen yang tersedia. Endpoint kampanye memberikan akses ke data terkait kampanye, sehingga memungkinkan pengambilan objek kampanye dan kontak.
Objek kampanye: mewakili satu kampanye dalam platform
Objek kontak: merepresentasikan kontak kampanye individual dalam kampanye tertentu
Lihat model berikut untuk menentukan kolom mana yang mungkin berisi 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
}
}
]
Kolom status kampanye
Kolom status dapat berada dalam salah satu status berikut:
| Status Kampanye | Deskripsi |
|---|---|
| dibuat | Kampanye dibuat, tetapi belum mulai melakukan panggilan keluar. |
| dimulai | Kampanye yang telah mulai melakukan panggilan keluar belum mulai melakukan panggilan (percakapan). |
| memanggil | Kampanye melakukan panggilan keluar. |
| pause | Kampanye telah dijeda oleh agen atau pengelola. |
| selesai | Kampanye telah menyelesaikan semua panggilannya. |
Kolom mode kampanye
Kolom mode dapat berupa salah satu nilai berikut:
| Mode Kampanye | Deskripsi |
|---|---|
| pratinjau | Untuk kampanye pratinjau, agen terhubung ke pengguna akhir atau memilih tindakan yang akan dilakukan untuk kontak tertentu. Dalam kampanye pratinjau, kontak atau pengguna akhir diketahui. |
| prediktif | Untuk kampanye prediktif, agen terhubung ke panggilan reservasi. Kami mengaktifkan deteksi mesin untuk panggilan tersebut, yang memberi tahu kami apakah respons terhadap panggilan keluar berasal dari manusia atau mesin (misalnya, pesan suara), dan hanya menghubungkan agen dengan manusia. |
| progresif | Untuk Kampanye Progresif, dialer akan terhubung terlebih dahulu ke agen pertama yang tersedia. Setelah terhubung, dialer akan memanggil dan mengirimkan kontak pertama yang tersedia (kontak yang belum dipanggil untuk kampanye tertentu) kepada agen. |
Kolom jenis kampanye
Kolom campaign_type dapat berupa salah satu nilai berikut:
| Jenis Kampanye | Deskripsi |
|---|---|
| default | Kontak kampanye berasal dari file CSV yang diupload pengguna. |
| external_list | Kontak kampanye berasal dari layanan eksternal atau pihak ketiga. |
Daftar kampanye
Endpoint:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns
Contoh Permintaan/Respons lainnya:
Contoh permintaan: Daftar kampanye
Kueri: Tidak Ada
Isi: Tidak ada
Contoh respons: Daftar kampanye
[
{
"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
}
}
]
Kode Status: 200
Satu kampanye
Endpoint:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}
Contoh Permintaan/Respons lainnya:
Contoh permintaan: Satu kampanye
Kueri:
| Parameter | Wajib | Jenis Data | Definisi |
|---|---|---|---|
| campaign_id | TRUE | Bilangan bulat | ID kampanye yang ingin Anda ambil |
Isi: Tidak ada
Contoh respons: Satu kampanye
{
"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
}
}
Kode Status: 200
Daftar kontak
| Parameter | Wajib | Jenis Data | Definisi |
|---|---|---|---|
| campaign_id | TRUE | Bilangan bulat | ID kampanye yang kontaknya ingin Anda dapatkan |
Endpoint:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}/contacts
Contoh Permintaan/Respons lainnya:
Contoh permintaan: Daftar kontak
Kueri:
| Parameter | Wajib | Jenis Data | Definisi |
|---|---|---|---|
| campaign_id | TRUE | Bilangan bulat | ID kampanye yang kontaknya ingin Anda dapatkan |
Isi: Tidak ada
Contoh respons: Daftar kontak
[
{
"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"
}
]
Kode Status: 200