Consulte les détails des événements de salle d'attente pour une salle d'attente.
Description de l'opération
Consulte les détails de tous les événements de salle d'attente associés à un identifiant de site et un identifiant de salle d'attente spécifiés.
Testez maintenant
Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.
Test
Autorisation RAM
Paramètres de requête
|
Paramètre |
Type |
Requis |
Description |
Exemple |
| SiteId |
integer |
Oui |
L'identifiant du site. Vous pouvez appeler l'opération ListSites pour obtenir l'identifiant du site. |
7096621098**** |
| WaitingRoomId |
string |
Oui |
L'identifiant de la salle d'attente, qui identifie une salle d'attente spécifique. Vous pouvez appeler l'opération ListWaitingRooms pour obtenir l'identifiant de la salle d'attente. |
6a51d5bc6460887abd129**** |
| WaitingRoomEventId |
integer |
Non |
L'identifiant de l'événement de salle d'attente. Il s'agit d'un paramètre facultatif utilisé pour interroger un événement de salle d'attente spécifique. |
89677721098**** |
Éléments de réponse
|
Élément |
Type |
Description |
Exemple |
|
object |
Le corps de la réponse. |
||
| RequestId |
string |
L'identifiant de la requête, qui est utilisé pour tracer l'appel d'API. |
f3c3700a-4c0f-4a24-b576-fd7dbf9e7c55 |
| WaitingRoomEvents |
array<object> |
La liste des événements de salle d'attente, incluant les détails de chaque événement. |
|
|
object |
Les détails de l'événement de salle d'attente. |
||
| WaitingRoomEventId |
integer |
L'identifiant de l'événement qui identifie de manière unique un événement de salle d'attente. |
89677721098**** |
| WaitingRoomId |
string |
L'identifiant de la salle d'attente associée. |
5c938a045c9ca46607163d34966**** |
| Enable |
string |
L'état de l'événement. Valeurs valides :
|
on |
| Name |
string |
Le nom de l'événement, qui est une description personnalisée de l'événement. |
événement de test |
| TotalActiveUsers |
string |
Le nombre total d'utilisateurs actifs. |
22 |
| NewUsersPerMinute |
string |
Le nombre de nouveaux utilisateurs par minute. |
11 |
| SessionDuration |
string |
La durée de la session. Unité : minutes. |
3 |
| DisableSessionRenewalEnable |
string |
Indique si le renouvellement de session doit être désactivé. Valeurs valides :
|
off |
| QueuingMethod |
string |
La méthode de mise en file d'attente. Valeurs valides :
|
fifo |
| QueuingStatusCode |
string |
Le code d'état de la salle d'attente. Valeurs valides :
|
200 |
| JsonResponseEnable |
string |
Indique si les réponses JSON doivent être activées. Lorsque cette option est activée, les requêtes avec un en-tête Accept contenant « application/json » renvoient des données JSON. Valeurs valides :
|
off |
| Description |
string |
La description détaillée de l'événement. |
terraform-example |
| WaitingRoomType |
string |
Le type de salle d'attente. Valeurs valides :
|
custom |
| CustomPageHtml |
string |
Le contenu de la page personnalisée de la salle d'attente. Ce paramètre est requis lorsque le type de salle d'attente est personnalisé. Le contenu doit être encodé en URL. |
html-yets-maqi1111 |
| StartTime |
string |
L'heure de début de l'événement (horodatage UNIX). |
1719814398 |
| EndTime |
string |
L'heure de fin de l'événement (horodatage UNIX). |
1719814497 |
| PreQueueEnable |
string |
Indique si la pré-mise en file d'attente doit être activée. Valeurs valides :
|
on |
| PreQueueStartTime |
string |
L'heure de début de la pré-mise en file d'attente (horodatage UNIX). Ce paramètre prend effet uniquement lorsque la pré-mise en file d'attente est activée. |
1719814097 |
| RandomPreQueueEnable |
string |
Indique si la pré-mise en file d'attente aléatoire doit être activée. Valeurs valides :
|
on |
| Language |
string |
La langue de la page de la salle d'attente. Ce paramètre est requis lorsque le type de salle d'attente est par défaut. Valeurs valides :
|
zhcn |
Exemples
JSON format
{
"RequestId": "f3c3700a-4c0f-4a24-b576-fd7dbf9e7c55",
"WaitingRoomEvents": [
{
"WaitingRoomEventId": 0,
"WaitingRoomId": "5c938a045c9ca46607163d34966****",
"Enable": "on",
"Name": "test event",
"TotalActiveUsers": "22",
"NewUsersPerMinute": "11",
"SessionDuration": "3",
"DisableSessionRenewalEnable": "off",
"QueuingMethod": "fifo",
"QueuingStatusCode": "200",
"JsonResponseEnable": "off",
"Description": "terraform-example",
"WaitingRoomType": "custom",
"CustomPageHtml": "html-yets-maqi1111",
"StartTime": "1719814398",
"EndTime": "1719814497",
"PreQueueEnable": "on",
"PreQueueStartTime": "1719814097",
"RandomPreQueueEnable": "on",
"Language": "zhcn"
}
]
}Codes d'erreur
|
Code de statut HTTP |
Code d'erreur |
Message d'erreur |
Description |
|---|---|---|---|
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | Failed to call the service. Try again later or contact technical support. |
| 403 | Site.NotExist | The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system. | The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system. |
Consultez Codes d'erreur pour la liste complète.
Notes de version
Consultez Notes de version pour la liste complète.