Point de terminaison des états des opérations de file d'attente

Vous pouvez utiliser le point de terminaison des états des opérations de file d'attente pour obtenir l'état de disponibilité d'une file d'attente avant d'y rediriger 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 "après les heures d'ouverture"

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

Point de terminaison :

Méthode : GET

Type : RAW

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 requête et de réponse

Cette section fournit un exemple de requête et de réponse.

Requête

https://{subdomain}.{domain}/apps/api/v1/queue_operation_statuses?menu_id=1&lang=en&channel_type=call

Réponse

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