Endpoint antrean

Endpoint status antrean menampilkan informasi antrean untuk menentukan apakah akan mengalihkan panggilan.

Status antrean

Menyediakan data real-time untuk antrean daun, termasuk perkiraan waktu tunggu, ketersediaan agen, kapasitas slot panggilan balik, jam operasional, dan hari libur. Gunakan ini agar sistem AI suara dapat memutuskan secara dinamis apakah akan mengalihkan panggilan ke agen live atau menawarkan jendela callback terjadwal kepada pemanggil. Untuk mengetahui informasi selengkapnya, lihat Endpoint status antrean.

Contoh permintaan

Metode: GET

URL: https://{subdomain}.{domain}/apps/api/v1/queues/status

Header

Kunci	Nilai	Deskripsi
Content-Type	application/json
Terima	application/json

Kueri

Kunci	Nilai	Deskripsi
lang	string	Kode bahasa dua huruf untuk antrean, dalam format ISO 639-1 (misalnya, en atau es). Wajib diisi.
menu_id[]	string	Satu ID antrean atau array beberapa ID antrean. Wajib.
menu_type	string	Jenis menu. Nilai yang mungkin adalah ivr_menu, mobile_menu, dan web_menu. Wajib.
callback_period_hours	integer	Total durasi periode mendatang dalam jam untuk menampilkan periode slot panggilan balik. Harus kurang dari atau sama dengan 8 jam. Nilai defaultnya adalah 4 jam. Opsional.
callback_start_from	string	Awal jendela penelusuran slot panggilan balik, dalam format tanggal dan waktu ISO 8601 di zona waktu antrean atau perusahaan. Jika tidak ada, defaultnya adalah waktu saat ini (waktu server yang dikonversi ke zona waktu antrean atau perusahaan). Tidak boleh di masa lalu dan harus paling lama 24 jam di masa mendatang. Opsional.

Contoh respons

{
    "queues": [
        {
            "menu_id": 2,
            "menu_type": "ivr_menu",
            "lang": "en",
            "materialized_path": "IVR Support",
            "current_queue_ewt": 18000,
            "scheduled_callback_ewt": 0,
            "logged_in_agents": 0,
            "available_agents": 0,
            "breakthrough_agents": 0,
            "callback_periods": [
                {
                    "date": "20260225",
                    "start_time": "17:30",
                    "end_time": "17:45",
                    "scheduled_calls": 0,
                    "max_slots": 1
                },
                {
                    "date": "20260225",
                    "start_time": "17:45",
                    "end_time": "18:00",
                    "scheduled_calls": 0,
                    "max_slots": 1
                }
            ],
            "hoops": {
                "current_status": 0,
                "time_zone": "America/Los_Angeles",
                "start_of_hoops": "2026-02-25T09:00:00-08:00",
                "end_of_hoops": "2026-02-25T18:00:00-08:00",
                "hoops_early_cutoff_minutes": null
            },
            "holiday": {
                "current_status": 0,
                "holiday_name": null,
                "time_range_all_day": null,
                "time_range_start_time": null,
                "time_range_end_time": null,
                "time_zone": "America/Los_Angeles"
            }
        }
    ]
}

Ketersediaan antrean

Dapatkan status ketersediaan untuk antrean sebelum Anda mengalihkan sesi ke antrean tersebut. Endpoint ini menampilkan properti boolean berikut:

• after_hours: true jika antrean tidak tersedia karena berada dalam status di luar jam kerja

• overcapacity: true jika antrean tidak tersedia karena dalam status kelebihan kapasitas

Contoh permintaan

Metode: GET

URL: https://{subdomain}.{domain}/apps/api/v1/queue_operation_statuses

Kueri

Kunci	Nilai	Deskripsi
menu_id	integer	ID untuk antrean yang ingin Anda dapatkan informasi ketersediaannya. Wajib.
lang	string	Kode bahasa dua huruf untuk antrean, dalam format ISO 639-1. Wajib.
channel_type	string	Jenis saluran. Nilai yang mungkin adalah call dan chat. Wajib.

Contoh respons

{
  "menu_id": 1,
  "lang": "en",
  "channel_type": "call",
  "after_hour": false,
  "overcapacity": true
}