Callback call API

Panggilan telepon balik adalah panggilan yang diminta oleh pengguna akhir. Dengan API panggilan balik, Anda dapat menjadwalkan panggilan balik dan membatalkan panggilan terjadwal secara terprogram. Dengan kemampuan ini, Anda dapat membuat aplikasi yang memungkinkan pengguna akhir meminta panggilan balik dari antrean yang Anda tentukan. Pengguna akhir juga dapat membatalkan panggilan yang telah mereka jadwalkan sebelumnya. Untuk mengetahui informasi tentang autentikasi dengan API panggilan balik, lihat Autentikasi dasar.

Menggunakan API panggilan balik

Anda dapat menggunakan API panggilan balik untuk menjadwalkan panggilan balik dan membatalkan panggilan terjadwal.

Jadwalkan panggilan telepon

Untuk menjadwalkan panggilan, panggil POST https://<subdomain>.<domain>/apps/api/v1/calls dan sertakan isi permintaan yang mirip dengan berikut ini:

{
    "call_type": "ScheduledCall",
    "menu_id": 12345,
    "end_user_number": "[phone]",
    "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 200 OK dengan objek panggilan yang diperbarui. status objek panggilan adalah cancelled saat panggilan menunggu waktu yang dijadwalkan atau sedang memasuki atau menunggu dalam antrean, dan completed saat Anda membatalkan callback agen virtual aktif yang telah melakukan upaya panggilan pertamanya. Jika panggilan sudah dibatalkan, permintaan akan menampilkan 204 No Content dengan isi kosong. Permintaan panggilan yang telah gagal karena alasan selain pembatalan, atau yang berada dalam status yang tidak dapat dibatalkan, akan menampilkan 400.

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 ID panggilan untuk panggilan yang akan dibatalkan.

Lihat contoh kode berikut:

{
    "call_ids": [123, 456, 789]
}

Permintaan yang berhasil akan menampilkan 202 Accepted dengan header respons Location yang mengarah ke resource tugas yang dapat Anda polling untuk penyelesaian. Respons 202 Accepted tidak berarti setiap panggilan sudah dibatalkan; ikuti header Location untuk mengonfirmasi penyelesaian dan memeriksa kegagalan parsial.

Menggunakan panggilan balik dengan CRM

Anda dapat menggunakan API panggilan balik 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:

• Data terbuka dan sudah memiliki panggilan terjadwal yang aktif: Jika pencarian ID tiket menunjukkan bahwa data terbuka dan sudah memiliki panggilan terjadwal yang aktif, panggilan tidak akan dijadwalkan. Komentar berikut dilampirkan ke data 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 data CRM: A scheduled call was canceled because the CRM was unreachable.

Perilaku callback dengan data tertutup

Cara panggilan telepon balik ditangani untuk data yang ditutup bervariasi bergantung pada CRM yang Anda gunakan:

• Pengguna Zendesk dan ServiceNow: Jika pencarian ID tiket menunjukkan bahwa data ditutup, panggilan tidak akan dijadwalkan. Komentar berikut dilampirkan ke data CRM: A scheduled call was not created because the record is closed.

• Pengguna Salesforce: Lihat Panggilan balik dengan Salesforce untuk mengonfigurasi cara instance Anda menangani panggilan terjadwal untuk data yang ditutup.

Panggilan balik dengan Salesforce

Jika telah mengintegrasikan CCAI Platform dengan Salesforce, Anda dapat mengonfigurasi cara instance menangani panggilan terjadwal untuk data yang ditutup. Berikut opsi konfigurasi untuk integrasi Salesforce:

• Jangan periksa status data.

• Periksa status data dan buka kembali data yang ditutup.

• Periksa status data dan batalkan panggilan terjadwal untuk data yang ditutup.

Catatan: Pencarian ID tiket untuk memeriksa status rekaman dilakukan lima menit sebelum hitung mundur panggilan terjadwal dimulai. Hitung mundur panggilan terjadwal adalah jumlah menit antara waktu panggilan ditetapkan ke agen dan waktu panggilan terjadwal dimulai. Untuk mengetahui informasi selengkapnya, lihat Mengonfigurasi panggilan terjadwal.

Jangan periksa status data

Anda dapat mengonfigurasi CCAI Platform agar tidak memeriksa status data sebelum melakukan panggilan terjadwal. Dengan konfigurasi ini, panggilan dilakukan sesuai jadwal, terlepas dari apakah data terbuka atau tertutup.

Untuk mengonfigurasi CCAI Platform agar tidak memeriksa status rekaman, ikuti langkah-langkah berikut:

1. Di portal CCAI Platform, klik Settings > Operation Management. Jika Anda tidak melihat menu Setelan, klik Menu.

2. Buka Detail Pembuatan Data CRM > Opsi data tertutup saat memulai panggilan terjadwal API.

3. Pilih Jangan periksa status data. Selalu mulai panggilan terjadwal API.

4. Klik Save General.

Memeriksa status data dan membuka kembali data yang ditutup

Anda dapat mengonfigurasi CCAI Platform untuk memeriksa status data sebelum melakukan panggilan terjadwal dan membuka kembali data yang ditutup. Dengan konfigurasi ini, jika status data ditutup, tindakan berikut akan dilakukan:

• Panggilan dilakukan sesuai jadwal.

• Catatan dibuka kembali.

• Komentar berikut dilampirkan ke data CRM: The record was reopened at the time of a scheduled call.

Untuk mengonfigurasi CCAI Platform agar memeriksa status data dan membuka kembali data yang ditutup, ikuti langkah-langkah berikut:

1. Di portal CCAI Platform, klik Settings > Operation Management. Jika Anda tidak melihat menu Setelan, klik Menu.

2. Buka Detail Pembuatan Data CRM > Opsi data tertutup saat memulai panggilan terjadwal API.

3. Pilih Periksa status data. Jika data ditutup > Buka kembali data.

4. Klik Save General.

Memeriksa status data dan membatalkan panggilan terjadwal untuk data yang ditutup

Anda dapat mengonfigurasi CCAI Platform untuk memeriksa status data sebelum melakukan panggilan terjadwal dan membatalkan panggilan terjadwal untuk data yang ditutup. Dengan konfigurasi ini, jika status data ditutup, tindakan berikut akan dilakukan:

• Panggilan terjadwal dibatalkan.

• Komentar berikut dilampirkan ke data CRM: A scheduled call was canceled because the record is closed.

Untuk mengonfigurasi CCAI Platform agar memeriksa status data dan membatalkan panggilan terjadwal untuk data yang ditutup, ikuti langkah-langkah berikut:

1. Di portal CCAI Platform, klik Settings > Operation Management. Jika Anda tidak melihat menu Setelan, klik Menu.

2. Buka Detail Pembuatan Data CRM > Opsi data tertutup saat memulai panggilan terjadwal API.

3. Pilih Periksa status data. Jika data ditutup > Batalkan panggilan terjadwal.

4. Klik Save General.