Points de terminaison de la file d'attente

Les points de terminaison d'état de la file d'attente renvoient des informations sur la file d'attente pour déterminer s'il faut rediriger un appel.

État de la file d'attente

Fournit des données en temps réel pour les files d'attente, y compris les temps d'attente estimés, la disponibilité des agents, la capacité des créneaux de rappel, les heures d'ouverture et les jours fériés. Utilisez cette option pour permettre aux systèmes d'IA vocale de décider de manière dynamique s'il faut transférer un appel à un agent en direct ou proposer des plages de rappel planifiées à l'appelant. Pour en savoir plus, consultez Point de terminaison de l'état de la file d'attente.

Exemple de requête

Méthode : GET

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

Headers

Clé	Valeur	Description
Content-Type	application/json
Accepter	application/json

Requête

Clé	Valeur	Description
lang	string	Code de langue à deux lettres de la file d'attente, au format ISO 639-1 (par exemple, en ou es). Obligatoire.
menu_id[]	string	ID de file d'attente unique ou tableau de plusieurs ID de files d'attente. Obligatoire.
menu_type	string	Type de menu. Les valeurs possibles sont ivr_menu, mobile_menu et web_menu. Obligatoire.
callback_period_hours	entier	Durée totale de la période future (en heures) pour laquelle renvoyer les périodes de créneaux de rappel. Doit être inférieure ou égale à huit heures. La valeur par défaut est de quatre heures. Facultatif.
callback_start_from	string	Début de la période de recherche de créneaux de rappel, au format date/heure ISO 8601 dans le fuseau horaire de la file d'attente ou de l'entreprise. Si elle est omise, la valeur par défaut est l'heure actuelle (heure du serveur convertie au fuseau horaire de la file d'attente ou de l'entreprise). Elle ne doit pas être antérieure et ne doit pas être postérieure de plus de 24 heures. Facultatif.

Exemple de réponse

{
    "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"
            }
        }
    ]
}

Disponibilité de la file d'attente

Obtenez l'état de disponibilité d'une file d'attente avant d'y transférer une session. Ce point de terminaison renvoie les propriétés booléennes suivantes :

• after_hours : true si la file d'attente est indisponible, car elle est en état "hors horaires d'ouverture"

• overcapacity : true si la file d'attente est indisponible, car elle est en état de surcapacité

Exemple de requête

Méthode : GET

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

Requête

Clé	Valeur	Description
menu_id	entier	ID de la file d'attente pour laquelle vous souhaitez obtenir des informations sur la disponibilité. Obligatoire.
lang	string	Code de langue à deux lettres pour la file d'attente, au format ISO 639-1. Obligatoire.
channel_type	string	Type de canal. Les valeurs possibles sont call et chat. Obligatoire.

Exemple de réponse

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