Callback call API

Panggilan balik adalah panggilan yang diminta oleh pengguna akhir. Dengan API panggilan balik, Anda dapat menjadwalkan panggilan balik secara terprogram dan membatalkan panggilan terjadwal. 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 dijadwalkan 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.

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 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 memengaruhi perilaku panggilan balik terjadwal:

  • Rekaman terbuka dan sudah memiliki panggilan terjadwal yang aktif: Jika pencarian ID tiket menunjukkan bahwa rekaman terbuka dan sudah memiliki panggilan terjadwal yang aktif, panggilan tidak 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 penelusuran 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 rekaman yang ditutup

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

  • Pengguna Zendesk dan ServiceNow: Jika penelusuran ID tiket menunjukkan bahwa catatan ditutup, panggilan tidak dijadwalkan. Komentar berikut dilampirkan ke catatan 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 rekaman yang ditutup.

Panggilan balik dengan Salesforce

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

Jangan periksa status rekaman

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

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

  1. Di portal Platform CCAI, klik Setelan > Pengelolaan Operasi. Jika Anda tidak melihat menu Setelan, klik Menu.

  2. Buka CRM Record Creation Details > Closed record options when initiating an API-scheduled call.

  3. Pilih Jangan periksa status catatan. Selalu mulai panggilan yang dijadwalkan API.

  4. Klik Simpan Umum.

Memeriksa status data dan membuka kembali data yang ditutup

Anda dapat mengonfigurasi Platform CCAI untuk memeriksa status rekaman sebelum melakukan panggilan terjadwal dan membuka kembali rekaman yang ditutup. Dengan konfigurasi ini, jika status rekaman 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 Platform CCAI guna memeriksa status data dan membuka kembali data yang ditutup, ikuti langkah-langkah berikut:

  1. Di portal Platform CCAI, klik Setelan > Pengelolaan Operasi. Jika Anda tidak melihat menu Setelan, klik Menu.

  2. Buka CRM Record Creation Details > Closed record options when initiating an API-scheduled call.

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

  4. Klik Simpan Umum.

Memeriksa status rekaman dan membatalkan panggilan terjadwal untuk rekaman yang ditutup

Anda dapat mengonfigurasi CCAI Platform untuk memeriksa status rekaman sebelum melakukan panggilan terjadwal dan membatalkan panggilan terjadwal untuk rekaman yang ditutup. Dengan konfigurasi ini, jika status rekaman 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 Platform CCAI agar memeriksa status rekaman dan membatalkan panggilan terjadwal untuk rekaman yang ditutup, ikuti langkah-langkah berikut:

  1. Di portal Platform CCAI, klik Setelan > Pengelolaan Operasi. Jika Anda tidak melihat menu Setelan, klik Menu.

  2. Buka CRM Record Creation Details > Closed record options when initiating an API-scheduled call.

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

  4. Klik Simpan Umum.