Penerapan referensi EspoCRM

Dokumen ini memberikan contoh integrasi dengan CRM kustom Contact Center AI Platform (CCAI Platform) menggunakan EspoCRM. EspoCRM adalah aplikasi CRM open source gratis yang membantu bisnis mengelola penjualan, pemasaran, dan dukungan pelanggan dengan antarmuka yang dapat disesuaikan. Aplikasi ini menawarkan fitur seperti pengelolaan kontak, pelacakan aktivitas, otomatisasi penjualan, dan pengelolaan inventaris, dengan opsi untuk hosting mandiri atau deployment cloud.

Untuk menyiapkan instance EspoCRM Anda sendiri, lihat halaman penginstalan EspoCRM.

Sebelum memulai

Lakukan tindakan berikut:

  • Konfigurasi firewall Anda untuk mengizinkan traffic dari Platform CCAI.

  • Buat pengguna API di instance EspoCRM Anda—misalnya, google_integration_user. Untuk mengetahui informasi selengkapnya, lihat API di Dokumentasi EspoCRM.

  • Buat peran di instance EspoCRM Anda dengan tindakan Buat, Baca, dan Perbarui yang mengakses hal berikut:

    • Kontak: untuk menemukan atau membuat penelepon
    • Kasus: untuk menelusuri dan mencatat tiket

    Untuk mengetahui informasi selengkapnya, lihat Pengelolaan Peran dalam dokumentasi ExpoCRM.

Mengonfigurasi koneksi dari EspoCRM ke Platform CCAI

Untuk mengonfigurasi koneksi dari EspoCRM ke Platform CCAI, ikuti langkah-langkah berikut:

  1. Di portal Platform CCAI, klik Setelan > Setelan Developer. Jika Anda tidak melihat menu Setelan, klik Menu.
  2. Untuk Agent Platform, pilih Custom CRM.
  3. Klik tombol Tampilkan CRM di portal CCAI Platform ke posisi aktif.
  4. Di kolom URL yang ditampilkan, masukkan URL yang akan disematkan di portal Platform CCAI–misalnya, https://YOUR_ESPO_DOMAIN/#Case/view/{RECORD_ID}.
  5. Untuk CRM lookup method, pilih Generic API.
  6. Untuk melakukan autentikasi menggunakan header kustom, lakukan hal berikut:
    1. Di bagian Authentication Method, pilih Custom Header.
    2. Klik Tambahkan kolom. Dialog Tambahkan Kolom akan muncul.
      1. Di kolom Field Key, masukkan X-Api-Key.
      2. Di kolom Nilai Kolom, masukkan kunci API yang dibuat saat Anda membuat pengguna API di EspoCRM.
      3. Klik Simpan.
  7. Untuk menyetel URL pencarian CRM, lakukan langkah-langkah berikut:
    1. Di bagian URL pencarian CRM, di kolom URL pencarian data, masukkan URL untuk mencari data—misalnya, https://YOUR_ESPO_DOMAIN/#Case/view/{RECORD_ID}.
    2. Di kolom URL pencarian akun, masukkan URL untuk mencari akun—misalnya, https://YOUR_ESPO_DOMAIN/#Contact/view/{ACCOUNT_ID}.
    3. Klik Simpan. ## Mengonfigurasi endpoint API

Konfigurasi endpoint yang kompatibel dengan EspoCRM untuk memastikan integrasi Anda memiliki komponen untuk mencari akun (kontak) dan data (kasus). Untuk mengetahui informasi selengkapnya tentang variabel yang kompatibel, lihat Ringkasan API dalam dokumentasi EspoCRM.

Mengonfigurasi endpoint akun API

Bagian ini menjelaskan cara mengonfigurasi endpoint akun API.

Mengonfigurasi endpoint Find an account by query

Untuk mengonfigurasi Find an account by query endpoint, ikuti langkah-langkah berikut:

  1. Di Platform CCAI, klik Setelan > Setelan Developer. Jika Anda tidak melihat menu Setelan, klik Menu.
  2. Di panel CRM, buka bagian API account.
  3. Untuk Find an account by query endpoint, klik Setup. Halaman Generic API Endpoint Setup akan muncul.
  4. Di kolom URL, masukkan URL untuk mencari akun–misalnya, https://YOUR_ESPO_DOMAIN/api/v1/Contact.
  5. Untuk Method, pilih GET.

  6. Untuk mengonfigurasi parameter permintaan, lakukan hal berikut:

    1. Untuk mengonfigurasi parameter permintaan pertama, ikuti langkah-langkah berikut:
      1. Klik Tambahkan kolom. Dialog Tambahkan Kolom akan muncul.
      2. Di kolom Field Key, masukkan where[0][attribute].
      3. Di kolom Nilai Kolom, masukkan phoneNumber.
      4. Klik Simpan.

    2. Untuk mengonfigurasi parameter permintaan lainnya, ulangi langkah-langkah sebelumnya menggunakan informasi dalam tabel berikut. Anda telah membuat parameter permintaan pertama.

      Kunci Kolom Nilai Kolom
      where[0][attribute] phoneNumber
      where[0][type] equals
      where[0][value] {PHONE_NUMBER}
      sortBy createdAt
      asc false

  7. Di kolom Response Data Location, masukkan data.list.

  8. Klik Simpan.

  9. Klik Kembali ke Setelan Developer untuk kembali ke halaman Setelan Developer.

Mengonfigurasi endpoint Temukan akun berdasarkan ID

Untuk mengonfigurasi Find an account by ID endpoint, ikuti langkah-langkah berikut:

  1. Di panel CRM, buka bagian API account.
  2. Untuk Find an account by ID endpoint, klik Setup. Halaman Generic API Endpoint Setup akan muncul.
  3. Di kolom URL, masukkan URL untuk mencari akun–misalnya, https://YOUR_ESPO_DOMAIN/api/v1/Contact/{ACCOUNT_ID}.
    1. Untuk Method, pilih GET.
  4. Tetapkan Response Data Location ke data.
  5. Klik Simpan.
  6. Klik Kembali ke setelan developer untuk kembali ke halaman Setelan Developer.

Mengonfigurasi endpoint Buat akun

Untuk mengonfigurasi Create an account endpoint, ikuti langkah-langkah berikut:

  1. Di panel CRM, buka bagian API account.
  2. Untuk Create an account endpoint, klik Setup. Halaman Generic API Endpoint Setup akan muncul.
  3. Di kolom URL, masukkan URL untuk mencari akun–misalnya, https://YOUR_ESPO_DOMAIN/api/v1/Contact.
  4. Untuk Method, pilih POST.

  5. Untuk mengonfigurasi Parameter Permintaan, lakukan hal berikut:

    1. Untuk mengonfigurasi parameter permintaan pertama, ikuti langkah-langkah berikut:
      1. Untuk Parameter Permintaan, klik Tambahkan kolom. Dialog Tambahkan Kolom akan muncul.
      2. Di kolom Field Key, masukkan phoneNumber.
      3. Di kolom Nilai Kolom, masukkan {PHONE_NUMBER}.
      4. Klik Simpan.

    2. Untuk mengonfigurasi parameter permintaan lainnya, ulangi langkah sebelumnya, menggunakan informasi dalam tabel berikut. Anda telah membuat parameter permintaan pertama.

      Parameter Kunci Nilai Parameter
      phoneNumber {PHONE_NUMBER}
      firstName New Caller
      lastName {CALL_ID}
      name New Caller {CALL_ID}

  6. Tetapkan Lokasi data respons ke data.

  7. Tetapkan Object ID location ke id.

  8. Klik Simpan.

  9. Klik Kembali ke setelan developer untuk kembali ke halaman Setelan Developer.

Mengonfigurasi endpoint Perbarui akun

Untuk mengonfigurasi Update an account endpoint, ikuti langkah-langkah berikut:

  1. Di panel CRM, buka bagian API account.
  2. Untuk Perbarui endpoint akun, klik Siapkan. Halaman Generic API Endpoint Setup akan muncul.
  3. Di kolom URL, masukkan URL untuk mencari akun–misalnya, https://YOUR_ESPO_DOMAIN/api/v1/Contact.
  4. Untuk Method, pilih PUT.

  5. Untuk mengonfigurasi Parameter Permintaan, lakukan hal berikut:

    1. Untuk mengonfigurasi parameter permintaan pertama, ikuti langkah-langkah berikut:
      1. Untuk Parameter Permintaan, klik Tambahkan kolom. Dialog Tambahkan Kolom akan muncul.
      2. Di kolom Field Key, masukkan contactId.
      3. Di kolom Nilai Kolom, masukkan {PHONE_NUMBER}.
      4. Klik Simpan.

    2. Untuk mengonfigurasi parameter permintaan lainnya, ulangi langkah sebelumnya, menggunakan informasi dalam tabel berikut. Anda telah membuat parameter permintaan pertama.

      Parameter Kunci Nilai Parameter
      contactId {PHONE_NUMBER}
      phoneNumber New Caller

  6. Tetapkan Lokasi data respons ke data.

  7. Klik Simpan.

  8. Klik Kembali ke setelan developer untuk kembali ke halaman Setelan Developer.

Mengonfigurasi endpoint rekaman API

Bagian ini menjelaskan cara mengonfigurasi endpoint rekaman API.

Mengonfigurasi endpoint Temukan data menurut kueri

Untuk mengonfigurasi Find a record by query endpoint, ikuti langkah-langkah berikut:

  1. Di panel CRM, buka bagian API record.
  2. Untuk Find a record by query endpoint, klik Setup. Halaman Generic API Endpoint Setup akan muncul.
  3. Di kolom URL, masukkan URL untuk mencari akun–misalnya, https://YOUR_ESPO_DOMAIN/api/v1/Case.
  4. Untuk Method, pilih GET.

  5. Untuk mengonfigurasi Parameter Permintaan, lakukan hal berikut:

    1. Untuk mengonfigurasi parameter permintaan pertama, ikuti langkah-langkah berikut:
      1. Untuk Parameter Permintaan, klik Tambahkan kolom. Dialog Tambahkan Kolom akan muncul.
      2. Di kolom Field Key, masukkan where[0][attribute].
      3. Di kolom Nilai Kolom, masukkan contactId.
      4. Klik Simpan.

    2. Untuk mengonfigurasi parameter permintaan lainnya, ulangi langkah sebelumnya, menggunakan informasi dalam tabel berikut. Anda telah membuat parameter permintaan pertama.

      Kunci Kolom Nilai Kolom
      where[0][attribute] contactId
      where[0][type] equals
      where[0][value] {ACCOUNT_ID}
      contactId {ACCOUNT_ID}
      sortBy createdAt
      asc false

  6. Di kolom Response Data Location, masukkan data.list.

  7. Klik Simpan.

  8. Klik Kembali ke setelan developer untuk kembali ke halaman Setelan Developer.

Mengonfigurasi endpoint Temukan data menurut ID

Sering digunakan dalam interaksi berbasis SDK, hal ini memungkinkan Anda meneruskan ID rekaman tertentu untuk mengaitkan interaksi. Untuk mengonfigurasi Find a record by ID endpoint, ikuti langkah-langkah berikut:

  1. Di panel CRM, buka bagian API record.
  2. Untuk Find a record by ID endpoint, klik Setup. Halaman Generic API Endpoint Setup akan muncul.
  3. Di kolom URL, masukkan URL untuk mencari akun–misalnya, https://YOUR_ESPO_DOMAIN/api/v1/Case/{RECORD_ID}.
  4. Untuk Method, pilih GET.
  5. Di kolom Response Data Location, masukkan data.
  6. Klik Simpan.
  7. Klik Kembali ke setelan developer untuk kembali ke halaman Setelan Developer.

Mengonfigurasi endpoint Buat data

Untuk mengonfigurasi Create a record endpoint, ikuti langkah-langkah berikut:

  1. Di panel CRM, buka bagian API record.
  2. Untuk Create a record endpoint, klik Setup. Halaman Generic API Endpoint Setup akan muncul.
  3. Di kolom URL, masukkan URL untuk mencari akun–misalnya, https://YOUR_ESPO_DOMAIN/api/v1/Case.
  4. Untuk Method, pilih POST.

  5. Untuk mengonfigurasi Parameter Permintaan, lakukan hal berikut:

    1. Untuk mengonfigurasi parameter permintaan pertama, ikuti langkah-langkah berikut:
      1. Untuk Parameter Permintaan, klik Tambahkan kolom. Dialog Tambahkan Kolom akan muncul.
      2. Di kolom Field Key, masukkan description.
      3. Di kolom Nilai Kolom, masukkan CALL Session:{CALL_ID}.
      4. Klik Simpan.

    2. Untuk mengonfigurasi parameter permintaan lainnya, ulangi langkah sebelumnya, menggunakan informasi dalam tabel berikut. Anda telah membuat parameter permintaan pertama.

      Parameter Kunci Nilai Parameter
      description Call Session: {CALL_ID}
      name Inbound Call from {ANI}
      contactId {ACCOUNT_ID}
      status New
      cchatId {CHAT_ID}
      ccallId {CALL_ID}
      cChannel {CHANNEL}
      Type {SESSION_TYPE}

  6. Di kolom Response Data Location, masukkan data.

  7. Di kolom Object ID Location, masukkan id.

  8. Klik Simpan.

  9. Klik Kembali ke setelan developer untuk kembali ke halaman Setelan Developer.

Mengonfigurasi endpoint Perbarui data

Untuk mengonfigurasi Update a record endpoint, ikuti langkah-langkah berikut:

  1. Di panel CRM, buka bagian API record.
  2. Untuk Update a record endpoint, klik Setup. Halaman Generic API Endpoint Setup akan muncul.
  3. Di kolom URL, masukkan URL untuk mencari akun–misalnya, https://YOUR_ESPO_DOMAIN/api/v1/Case/{RECORD_ID}.
  4. Untuk Method, pilih PUT.

  5. Untuk mengonfigurasi Parameter Permintaan, lakukan hal berikut:

    1. Untuk mengonfigurasi parameter permintaan pertama, ikuti langkah-langkah berikut:
      1. Untuk Parameter Permintaan, klik Tambahkan kolom. Dialog Tambahkan Kolom akan muncul.
      2. Di kolom Field Key, masukkan parentId.
      3. Di kolom Nilai Kolom, masukkan {RECORD_ID}.
      4. Klik Simpan.

    2. Untuk mengonfigurasi parameter permintaan lainnya, ulangi langkah sebelumnya, menggunakan informasi dalam tabel berikut. Anda telah membuat parameter permintaan pertama.

      Parameter Kunci Nilai Parameter
      parentId {RECORD_ID}
      parentType Case
      status New
      description {TICKET_DESCRIPTION}

  6. Di kolom Response data location, masukkan data.

  7. Klik Simpan.

  8. Klik Kembali ke setelan developer untuk kembali ke halaman Setelan Developer.