v1.0.0 (2026-08-15 18:56)
Popups & Modal Announcements
Overview
- Description: Fetch the current active popup ads or urgent notices (usually displayed when a visitor first enters the site or after a member logs in).
- Authentication: No Member Login Required. However, you must provide a Base Token to identify the Agent. See Authentication for details.
1. GET - Get Popups List
- Path:
/api/system/popups
Request Header
| Parameter | Type | Required | Description |
|---|---|---|---|
Authorization | String | Yes | Bearer BaseToken (to identify the Agent) |
Accept-Language | String | No | Target response language (e.g., zh-CN, en-US) |
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
device | String | No | Device type (e.g., pc, mobile) to request the appropriately sized images |
Response Example
json
{
"code": 0,
"msg": "Success",
"data": [
{
"id": 1,
"title": "System Maintenance",
"content": "Dear players, we will undergo a system upgrade at 3 AM this Thursday...",
"image_url": "https://cdn.domain.com/popups/maintenance.webp",
"target_url": "",
"show_once": true
}
]
}