Estimated Wait Time API

Endpoint API ini menampilkan perkiraan waktu tunggu (EWT) yang dihitung per antrean.

Hal ini dapat digunakan untuk tampilan EWT saluran dukungan kustom di halaman web atau aplikasi seluler di luar Contact Center AI Platform (CCAI Platform) SDK, atau untuk notifikasi atau pemicu kustom.

Contoh Permintaan

URL: http://{subdomain}.{domain}/apps/api/v1/wait_times

Parameter

ID Nama Kolom Jenis Wajib Deskripsi Nilai Catatan
1 menu_id id Tidak Respons akan memfilter semua menu (antrean) di sub-menu menu tersebut, termasuk menu tersebut Menu Root (default) Menu tertentu Jika tidak ada yang diteruskan, akan menampilkan seluruh struktur antrean
2 channel_type enum Tidak Menampilkan menu saluran tertentu voice_call chat Parameter opsional
3 menu_type enum Tidak Menampilkan menu jenis tertentu

ivr_menu

mobile_menu

web_menu

Semua (default)

opsional
4 wait[from] int Tidak Menampilkan catatan jika memiliki waktu tunggu yang lebih besar dari nilai Validasi:Hanya Int Positif
5 wait[to] int Tidak Menampilkan catatan jika memiliki waktu tunggu yang lebih kecil dari nilai Validasi:Hanya Int Positif
6 lang enum Ya Struktur antrean untuk mengambil ewt

Contoh: "en" "es" "fr" "de"

"it" "ja" "ko" "pt"

"pt-BR" "sv"

Respons

ID Nama Kolom Jenis Wajib Deskripsi
1 menu_id id ya Kunci asing ke endpoint API pengelola /menus
2 wait INT ya Waktu tunggu dalam menit
3 Jalur terwujud String Ya Jalur terwujud seperti yang ditemukan di /menus api

Contoh

http://{subdomain}.{domain}/apps/api/v1/wait_times?lang=en&menu_id=10

[
    {
        "menu_id": 10,
        "menu_type": "ivr_menu",
        "voice_call": 120,
        "materialized_path": "Subscription",
        "logged_in_agents": 3,
        "available_agents": 0,
        "breakthrough_agents": 1
    }
]

Kode Status: 200

Perkiraan waktu tunggu ID Menu 10 adalah 120 detik (atau dua menit)