Panggilan callback adalah panggilan yang diminta oleh pengguna akhir. Dengan API panggilan callback, Anda dapat menjadwalkan panggilan callback secara terprogram dan membatalkan panggilan terjadwal. Dengan kemampuan ini, Anda dapat membuat aplikasi yang memungkinkan pengguna akhir meminta panggilan callback dari antrean yang Anda tentukan. Pengguna akhir juga dapat membatalkan panggilan yang sebelumnya mereka jadwalkan. Untuk mengetahui informasi tentang autentikasi dengan API panggilan callback, lihat Autentikasi dasar.
Menggunakan API panggilan callback
Anda dapat menggunakan API panggilan callback untuk menjadwalkan panggilan callback dan membatalkan panggilan terjadwal.
Menjadwalkan panggilan
Untuk menjadwalkan panggilan, panggil POST https://<subdomain>.<domain>/apps/api/v1/calls
dan sertakan isi permintaan yang mirip dengan berikut:
{
"call_type": "ScheduledCall",
"menu_id": 12345,
"end_user_number": "+18005550100",
"scheduled_at": "2025-09-02T14:30:00Z"
}
Permintaan yang berhasil akan menampilkan objek panggilan, termasuk ID panggilan.
Membatalkan panggilan terjadwal
Untuk membatalkan panggilan terjadwal, panggil PATCH
https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/{id}/cancel. Tentukan ID panggilan yang ingin Anda batalkan.
Permintaan yang berhasil akan menampilkan informasi tentang panggilan yang dibatalkan.
Membatalkan beberapa panggilan terjadwal
Untuk membatalkan beberapa panggilan terjadwal, panggil PATCH
https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/cancel. Sertakan isi permintaan yang berisi array call_ids dari ID panggilan untuk panggilan yang akan dibatalkan.
Lihat contoh kode berikut:
{
"call_ids": [123, 456, 789]
}
Permintaan yang berhasil akan menampilkan respons dengan header respons yang berisi URL Location untuk memeriksa status pembatalan.
Menggunakan panggilan callback dengan CRM
Anda dapat menggunakan API panggilan callback dengan integrasi CRM Salesforce, Zendesk, dan ServiceNow.
Perilaku callback umum
Jika Anda menggunakan CRM yang didukung (Salesforce, Zendesk, atau ServiceNow), kondisi berikut akan memengaruhi perilaku callback terjadwal:
Catatan terbuka dan sudah memiliki panggilan terjadwal aktif: Jika pencarian ID tiket menunjukkan bahwa catatan terbuka dan sudah memiliki panggilan terjadwal aktif, panggilan tidak akan dijadwalkan. Komentar berikut dilampirkan ke catatan CRM:
A scheduled call was not created because the record already has an active scheduled call.CRM tidak dapat dijangkau: Jika pencarian ID tiket menunjukkan bahwa CRM tidak dapat dijangkau, panggilan akan dibatalkan. Komentar berikut dilampirkan ke catatan CRM:
A scheduled call was canceled because the CRM was unreachable.
Perilaku callback dengan catatan tertutup
Cara panggilan callback ditangani untuk catatan tertutup bervariasi bergantung pada CRM yang Anda gunakan:
Pengguna Zendesk dan ServiceNow: Jika pencarian ID tiket menunjukkan bahwa catatan ditutup, panggilan tidak akan dijadwalkan. Komentar berikut dilampirkan ke catatan CRM:
A scheduled call was not created because the record is closed.Pengguna Salesforce: Lihat Panggilan callback dengan Salesforce untuk mengonfigurasi cara instance Anda menangani panggilan terjadwal untuk catatan tertutup.
Panggilan callback dengan Salesforce
Jika telah mengintegrasikan CCAI Platform dengan Salesforce, Anda dapat mengonfigurasi cara instance menangani panggilan terjadwal untuk catatan tertutup. Berikut adalah opsi konfigurasi untuk integrasi Salesforce:
Periksa status catatan dan buka kembali catatan tertutup catatan.
Periksa status catatan dan batalkan panggilan terjadwal untuk catatan tertutup records.
Jangan periksa status catatan
Anda dapat mengonfigurasi CCAI Platform agar tidak memeriksa status catatan sebelum melakukan panggilan terjadwal. Dengan konfigurasi ini, panggilan akan dilakukan sesuai jadwal, terlepas dari apakah catatan terbuka atau tertutup.
Untuk mengonfigurasi CCAI Platform agar tidak memeriksa status catatan, ikuti langkah-langkah berikut:
Di portal CCAI Platform, klik Settings > Operation Management. Jika Anda tidak melihat menu Settings, klik Menu.
Buka CRM Record Creation Details > Closed record options when initiating an API-scheduled call.
Pilih Don't check the record status. Always initiate the API-scheduled call.
Klik Save General.
Periksa status catatan dan buka kembali catatan tertutup
Anda dapat mengonfigurasi CCAI Platform untuk memeriksa status catatan sebelum melakukan panggilan terjadwal dan membuka kembali catatan yang ditutup. Dengan konfigurasi ini, jika status catatan ditutup, tindakan berikut akan dilakukan:
Panggilan dilakukan sesuai jadwal.
Catatan dibuka kembali.
Komentar berikut dilampirkan ke catatan CRM:
The record was reopened at the time of a scheduled call.
Untuk mengonfigurasi CCAI Platform agar memeriksa status catatan dan membuka kembali catatan tertutup, ikuti langkah-langkah berikut:
Di portal CCAI Platform, klik Settings > Operation Management. Jika Anda tidak melihat menu Settings, klik Menu.
Buka CRM Record Creation Details > Closed record options when initiating an API-scheduled call.
Pilih Check the record status. If the record is closed > Reopen the record.
Klik Save General.
Periksa status catatan dan batalkan panggilan terjadwal untuk catatan tertutup
Anda dapat mengonfigurasi CCAI Platform untuk memeriksa status catatan sebelum melakukan panggilan terjadwal dan membatalkan panggilan terjadwal untuk catatan yang ditutup. Dengan konfigurasi ini, jika status catatan ditutup, tindakan berikut akan dilakukan:
Panggilan terjadwal dibatalkan.
Komentar berikut dilampirkan ke catatan CRM:
A scheduled call was canceled because the record is closed.
Untuk mengonfigurasi CCAI Platform agar memeriksa status catatan dan membatalkan panggilan terjadwal untuk catatan tertutup, ikuti langkah-langkah berikut:
Di portal CCAI Platform, klik Settings > Operation Management. Jika Anda tidak melihat menu Settings, klik Menu.
Buka CRM Record Creation Details > Closed record options when initiating an API-scheduled call.
Pilih Check the record status. If the record is closed > Cancel the scheduled call.
Klik Save General.