Halaman ini menjelaskan cara menggunakan penomoran halaman dan tailing saat memanggil endpoint manager API.
Penomoran halaman
Penomoran halaman didukung untuk sebagian besar endpoint API pengelola. Untuk pengecualian, lihat Membuntuti endpoint untuk data yang diperbarui.
Menetapkan ukuran halaman
Secara default, endpoint API pengelola menampilkan halaman yang berisi 100 data. Anda dapat
mengubah jumlah ini menggunakan parameter kueri per, hingga maksimum 100. Nilai yang lebih besar akan dikurangi menjadi 100.
Untuk menetapkan ukuran halaman, gunakan endpoint berikut:
/manager/api/v1/agents?per=50
Tindakan ini akan menetapkan ukuran halaman menjadi 50 data.
Meminta halaman tertentu
Anda dapat meminta halaman data tertentu menggunakan parameter kueri page.
Untuk meminta halaman tertentu, gunakan endpoint berikut:
/manager/api/v1/agents?page=2
Tindakan ini akan menampilkan halaman kedua kumpulan data
Mendapatkan semua data yang tersedia
Secara default, API pengelola menampilkan 100 data di halaman respons, meskipun Anda dapat mengubah jumlah data di halaman dengan menetapkan ukuran halaman. Untuk endpoint yang mendukung penomoran halaman,
header respons menyertakan jumlah total kumpulan data yang tersedia. Jika jumlah tersebut melebihi ukuran halaman, Anda harus memanggil API beberapa kali untuk mendapatkan semua data. Untuk endpoint yang mendukung penomoran halaman, responsnya
menyertakan header Link yang mengikuti RFC 5988. Link rel="next" akan muncul
setiap kali ada lebih banyak data yang tersedia, dan link rel="last" memberikan nomor
halaman terakhir. Respons juga menyertakan header Total dan Per-Page.
Untuk mendapatkan semua data yang tersedia, lakukan tindakan berikut:
Panggil endpoint API pengelola yang mendukung penomoran halaman. Untuk mengetahui informasi selengkapnya, lihat Penomoran halaman. Header respons menunjukkan jumlah data yang akan ditampilkan.
Bandingkan jumlah data yang akan ditampilkan dengan ukuran halaman Anda. Jika jumlah kumpulan data yang akan ditampilkan kurang dari ukuran halaman, semua kumpulan data telah ditampilkan. Jika tidak, lanjutkan ke langkah berikutnya.
Panggil endpoint lagi, dengan menentukan halaman data berikutnya. Untuk mengetahui informasi selengkapnya, lihat Meminta halaman tertentu. Ulangi langkah ini hingga semua data Anda ditampilkan.
Memantau endpoint untuk data yang diperbarui
Google tidak merekomendasikan penggunaan penomoran halaman untuk endpoint API panggilan, chat, dan aktivitas agen karena kami tidak dapat menjamin hasil yang optimal. Sebagai gantinya, sebaiknya ikuti endpoint API ini untuk mendapatkan data yang diperbarui. Melacak endpoint API berarti terus memanggilnya untuk mendapatkan data yang baru atau diperbarui sejak permintaan terakhir Anda.
Memantau endpoint API Panggilan
Setiap kali data panggilan diubah, stempel waktu updated_at-nya akan diperbarui. Anda dapat menggunakan stempel waktu untuk menentukan data panggilan yang ingin diambil saat memanggil endpoint Calls API.
Untuk memantau endpoint API Calls setiap 60 menit, ikuti langkah-langkah berikut:
Buat permintaan ke endpoint API Calls (
/manager/api/v1/calls), dengan menentukan parameter kueri berikut:updated_at[from]. Tentukan bahwa Anda menginginkan data yang diperbarui pada atau setelah waktu ini.sort_column. Tentukan kolom untuk mengurutkan data.sort_direction. Tentukan arah pengurutan data dalam respons.
Berikut adalah contoh skrip Bash yang menggunakan perintah
curl:# 1. Define your environment variables (usually set in your shell or .env file) export API_HOSTNAME="ccaip-host.uc1.ccaiplatform.com/" export API_USER="ccaip-host" export API_PASS="CCAI Platform API Key" # 2. Calculate the timestamp for 60 minutes ago in ISO 8601 format (UTC) # For macOS (BSD date): # TIMESTAMP=$(date -v-60M -u +"%Y-%m-%dT%H:%M:%SZ") # For Linux (GNU date): TIMESTAMP=$(date --date='60 minutes ago' -u +"%Y-%m-%dT%H:%M:%SZ") # 3. Execute the curl command # -u handles the Base64 encoding for Basic Auth automatically curl -g -u "${API_USER}:${API_PASS}" \ "https://${API_HOSTNAME}/manager/api/v1/calls?updated_at[from]=${TIMESTAMP}&sort_column=updated_at&sort_direction=asc" | jqCalls API menampilkan respons yang mirip dengan berikut ini:
[ { "id": 100, ... "updated_at": "2025-01-01T00:00:00Z" }, { "id": 98, ... "updated_at": "2025-01-02T00:00:00Z" }, { "id": 150, ... "updated_at": "2025-01-03T00:00:00Z" } ]Objek respons yang diperbarui pada atau setelah stempel waktu yang Anda tentukan akan ditampilkan, diurutkan berdasarkan tanggal, dalam urutan menaik. Gunakan stempel waktu
updated_atdari objek terakhir dalam respons ini untuk stempel waktu dalam panggilan berikutnya ke endpoint. Filterfrombersifat inklusif, sehingga respons berikutnya mengulangi data pada stempel waktu tersebut. Hapus duplikat pada ID data, atau catat ID yang sudah diproses pada stempel waktu tersebut dan lewati.Panggil endpoint API 60 menit kemudian. Data Panggilan yang diperbarui sejak permintaan terakhir Anda akan ditampilkan.
Ulangi langkah sebelumnya untuk terus mengikuti endpoint.
Memantau endpoint API Chats
Gunakan stempel waktu updated_at dari objek terakhir dalam respons ini untuk stempel waktu dalam panggilan berikutnya ke endpoint. Filter updated_at[from] bersifat inklusif, sehingga respons berikutnya mengulangi data pada stempel waktu tersebut. Lakukan penghapusan duplikat pada ID data, atau catat ID yang sudah diproses pada stempel waktu tersebut dan lewati ID tersebut.
Setiap kali data chat diubah, stempel waktu updated_at-nya akan diperbarui. Anda dapat menggunakan stempel waktu untuk menentukan data chat yang ingin diambil saat memanggil endpoint API Chats.
Untuk memantau endpoint API Chats setiap 60 menit, ikuti langkah-langkah berikut:
Buat permintaan ke endpoint API Chats (
/manager/api/v1/chats), dengan menentukan parameter kueri berikut:updated_at[from]. Tentukan bahwa Anda menginginkan data yang diperbarui pada atau setelah waktu ini.sort_column. Tentukan kolom untuk mengurutkan data.sort_direction. Tentukan arah pengurutan data dalam respons.
Berikut adalah contoh skrip Bash yang menggunakan perintah
curl:# 1. Define your environment variables (usually set in your shell or .env file) export API_HOSTNAME="ccaip-host.uc1.ccaiplatform.com/" export API_USER="ccaip-host" export API_PASS="CCAI Platform API Key" # 2. Calculate the timestamp for 60 minutes ago in ISO 8601 format (UTC) # For macOS (BSD date): # TIMESTAMP=$(date -v-60M -u +"%Y-%m-%dT%H:%M:%SZ") # For Linux (GNU date): TIMESTAMP=$(date --date='60 minutes ago' -u +"%Y-%m-%dT%H:%M:%SZ") # 3.. Execute the curl command # -u handles the Base64 encoding for Basic Auth automatically curl -g -u "${API_USER}:${API_PASS}" \ "https://${API_HOSTNAME}/manager/api/v1/chats?updated_at[from]=${TIMESTAMP}&sort_column=updated_at&sort_direction=asc" | jqChats API menampilkan respons yang mirip dengan berikut ini:
[ { "id": 100, ... "updated_at": "2025-01-01T00:00:00Z" }, { "id": 98, ... "updated_at": "2025-01-02T00:00:00Z" }, { "id": 150, ... "updated_at": "2025-01-03T00:00:00Z" } ]Objek respons yang diperbarui pada atau setelah stempel waktu yang ditentukan akan ditampilkan, diurutkan berdasarkan tanggal, dalam urutan menaik. Gunakan stempel waktu
updated_atdari objek terakhir dalam respons ini untuk stempel waktu dalam panggilan berikutnya ke endpoint.Panggil endpoint API lagi 60 menit kemudian. Data chat yang diperbarui sejak permintaan terakhir Anda akan ditampilkan.
Ulangi langkah sebelumnya untuk terus mengikuti endpoint.
Memantau endpoint API Agent Activity
Tidak seperti Chat dan Call, Agent Activity Logs tidak diperbarui dan
oleh karena itu tidak memiliki stempel waktu updated_at. Anda dapat menggunakan stempel waktu started_at
untuk menentukan data aktivitas yang ingin diambil saat memanggil
endpoint Agent Activity API. Filter started_at[from] bersifat inklusif, sehingga respons berikutnya mengulangi data pada stempel waktu tersebut. Hapus duplikat pada ID data, atau catat ID yang sudah diproses pada stempel waktu tersebut dan lewati.
Untuk memantau endpoint API Agent Activity setiap 60 menit, ikuti langkah-langkah berikut:
Buat permintaan ke endpoint API Agent Activity (
/manager/api/v1/agent_activity_logs), dengan menentukan parameter kueri berikut:started_at[from]. Tentukan bahwa Anda menginginkan log aktivitas yang dimulai pada atau setelah waktu ini.ended_at[from]. Tentukan bahwa Anda menginginkan log aktivitas yang berakhir pada atau setelah waktu ini. Gunakan ini, bukanstarted_at[from], untuk menangkap sesi yang dimulai sebelum periode Anda, tetapi berakhir di dalamnya.page. Sertakan parameter ini agar respons menampilkan header penomoran halaman. Tanpapage, respons dibatasi pada ukuran halaman default 100 data tanpa menampilkan headerLink,Total, atauPer-Page.sort_column. Tentukan kolom untuk mengurutkan data.sort_direction. Tentukan arah pengurutan data dalam respons.
Berikut adalah contoh skrip Bash yang menggunakan perintah
curl:# 1. Define your environment variables (usually set in your shell or .env file) export API_HOSTNAME="ccaip-host.uc1.ccaiplatform.com" export API_USER="ccaip-host" export API_PASS="CCAI Platform API Key" # 2. Calculate the timestamp for 60 minutes ago in ISO 8601 format (UTC) # For macOS (BSD date): # TIMESTAMP=$(date -v-60M -u +"%Y-%m-%dT%H:%M:%SZ") # For Linux (GNU date): TIMESTAMP=$(date --date='60 minutes ago' -u +"%Y-%m-%dT%H:%M:%SZ") # 3. Execute the curl command # -u handles the Base64 encoding for Basic Auth automatically curl -g -u "${API_USER}:${API_PASS}" \ "https://${API_HOSTNAME}/manager/api/v1/agent_activity_logs?started_at[from]=${TIMESTAMP}&sort_column=started_at&sort_direction=asc" | jqAgent Activity API menampilkan respons yang mirip dengan berikut ini:
[ { "id": 100, ... "started_at": "2025-01-01T00:00:00Z" }, { "id": 98, ... "started_at": "2025-01-02T00:00:00Z" }, { "id": 150, ... "started_at": "2025-01-03T00:00:00Z" } ]Objek respons yang dimulai pada atau setelah stempel waktu yang ditentukan akan ditampilkan, diurutkan berdasarkan tanggal, dalam urutan menaik. Gunakan stempel waktu
started_atdari objek terakhir dalam respons ini untuk stempel waktu dalam panggilan berikutnya ke endpoint.Panggil endpoint API Agent Activity lagi 60 menit kemudian. Data Log Aktivitas Agen yang diperbarui sejak permintaan terakhir Anda akan ditampilkan.
Ulangi langkah sebelumnya untuk terus mengikuti endpoint.