创建计划事件

当您希望在特定时间段内自定义等候室的行为时（例如更改排队方法或增加活动用户总数），请设置scheduled event（计划事件）。您可以通过仪表板或 API 执行此操作。

在事件持续期间，为事件设置的任何属性都将覆盖等候室的默认属性。

1. 在您的应用程序中，转到 Traffic（流量） > Waiting Room（等候室）。

2. 展开一个等候室并选择 Schedule event（安排事件）。

3. 自定义事件的详细信息：命名事件，添加描述（可选），并选择开始日期时间 (Start Date Time) 和结束日期时间 (End Date Time)。

4. 您还可以启用预排队 (pre-queueing)——在这种情况下，您需要定义一个预排队时间。您还可以选择 Shuffle at event start（在事件开始时随机洗牌），预排队中的所有用户将在事件开始时随机获准进入。

5. 选择 Next（下一步）。

6. 在 **Settings（设置）**部分，您可以为 Total active users（活动用户总数）、New users per minute（每分钟新用户数）、Session duration（会话持续时间）、Session Renewal（会话续订）和 Queueing Method（排队方法）定义新值。对于每一个设置，您还可以选择始终继承等候室中定义的值。使用此选项，如果您更改基础等候室的设置，相应的事件设置也会更新。

7. 选择 Next（下一步）。

8. 在自定义部分，您可以选择 Always inherit your waiting room’s template（始终继承您等候室的模板，默认）或者可以使用 Custom Event Template（自定义事件模板）覆盖它。在这种情况下，您需要导入您自己的模板。在继续之前，请务必预览结果。

9. 选择 **Next（下一步）**并检查您的事件详细信息和设置。

10. 选择 Save（保存）。

在您的等候室页面上，您可以在 **Next Event（下一个事件）**列中查看计划的下一个事件的日期。如果该等候室没有计划事件，此列将显示为 N/A。您可以随时挂起、编辑或删除您的事件。

要创建事件，请发出包含必需和可选参数的 POST 请求。在事件持续期间，为事件设置的任何属性都将覆盖等候室的默认属性。

如果您使用的是自定义模板，您可能希望在模板中添加相关变量（列在 json_response_enabled 参数下）。

尽管大多数参数与常规等候室中的参数相同，但创建事件时有一些特有的参数。有关事件设置的完整列表，请参阅创建事件。

• name（必需）：唯一的名称，包含字母数字字符、连字符和下划线。
• event_start_time（必需）：标记事件开始的 ISO 8601 时间戳。此时，将使用事件的配置来处理排队的用户。必须在 event_end_time 之前至少 1 分钟发生。
• event_end_time（必需）：标记事件结束的 ISO 8601 时间戳。
• shuffle_at_event_start：如果为 true 并且 prequeue_start_time 不为空，则预队列中的用户将在 event_start_time 时被随机洗牌。如果您的事件使用 FIFO 排队方法，通常用于确保公平性。
• prequeue_start_time：ISO 8601 时间戳，标记在事件开始前何时开始对所有用户进行排队。必须在 event_start_time 之前至少 5 分钟发生。
• description：提供有关事件更多详细信息的文本描述。
• suspended：如果为 true，则忽略该事件，并根据等候室的典型配置处理流量。

在设置事件时，您可能还希望调整等候室的默认排队方法。

当您希望正常允许流量，但在计划事件期间限制流量时，请将等候室的排队方法设置为 Passthrough。

当您希望正常阻止所有流量，但在特殊事件（如注册或门票销售）期间允许流量时，请将等候室的排队方法设置为 Reject。

设置一个“抽奖 (lottery)”系统，以奖励在您的事件开始时间之前进入队列的所有用户。

在预排队期间到达您的应用程序的用户，在事件开始时会被随机分配一个排队位置。如果事件使用 FIFO 排序，则在预排队期间之后到达您的应用程序的用户，将被分配在预队列用户之后的位置。

要设置“抽奖”，请在您的 API 请求中包含以下参数：

• prequeue_start_time
• shuffle_at_event_start

由于在事件持续期间，为事件设置的某些属性将覆盖等候室的默认属性，因此您应该在事件开始之前使用 API 来预览事件配置。

此命令会向您显示就像事件处于活动状态时的配置，这意味着从等候室继承的字段将显示其当前值。

要编辑事件，请使用 PATCH 请求。

您可以通过将事件的 suspended 参数设置为 true 来禁用事件。

此外，如果等候室本身是Disabled（已禁用），则事件不会变为活动状态。

如果您希望部署一个计划的维护页面，并且在维护窗口之前或之后无需排队，请按照以下步骤操作。

1. 启用 Passthrough 排队方法来创建一个等候室。
2. 启用 Reject 排队方法来为此房间创建一个等候室事件。

计划事件结束后，用户将可以访问您的网站。在计划事件结束前，您可以通过将事件设置为禁用来提前结束维护窗口。