Announcement Management

Query the operational announcement configuration delivered to the App client, used by operations staff to maintain and review announcements shown across App pages.

Request parameters

Combine business filters through filters (see the filter field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Each record represents one operational announcement and carries its notice ID, effective start and end time, announcement type, remark/reason, enable status, announcement status (not started / active / ended), and audit status.

Each announcement can be scoped by supported markets, display pages, and supported securities, and records the operator.

An announcement takes effect only after passing the review workflow, so records are commonly filtered by type, display page, audit status, or time range to track delivery and effectiveness.

Returns

On success, returns the matching record list with pagination. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/announce_saas_announcements

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

lb_hk_app.announcements

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

announcement_idstring

Filters results by Notice ID.

begin_atstring

Filters results by Begin At.

end_atstring

Filters results by End At.

announcement_typestring

Filters results by Announcement Type.

Allowed values: common General Announcement, normal_closed Regular Market Closure, ntemporary_closed Temporary Market Closure, passageway Channel Issue, only_shares Single Stock, assets_out Asset Withdrawal, assets_in Asset Deposit

Values

common: General Announcement
normal_closed: Regular Market Closure
ntemporary_closed: Temporary Market Closure
passageway: Channel Issue
only_shares: Single Stock
assets_out: Asset Withdrawal
assets_in: Asset Deposit

positionstring

Filters results by Position.

Allowed values: watchlist Follow, market, portfolio Assets, stockdetail Stock Details, trade Trading Hall, deposit Deposit Statement, withdrawal Withdrawal Bill, my_tab My Tab

Values

watchlist: Follow
market: Market
portfolio: Assets
stockdetail: Stock Details
trade: Trading Hall
deposit: Deposit Statement
withdrawal: Withdrawal Bill
my_tab: My Tab

review_statusstring

Filters results by Audit status.

Allowed values: 1 Pending, 2 In progress, 3 Approved, 4 Rejected, 5 Closed

Values

1: Pending
2: In progress
3: Approved
4: Rejected
5: Closed

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Announcement Management records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

idstring

Returned value: Unique identifier of the current record.

begin_atstring

Returned value: Begin At. The date or time format follows the value returned by the API.

end_atstring

Returned value: End At. The date or time format follows the value returned by the API.

announcement_typestring

Returned value: Announcement Type.

announcement_type_valstring

Raw value of announcement_type. The announcement_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

reasonstring

Returned value: Reason.

statusstring

Returned value: Status.

status_valstring

Raw value of status. The status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

announcement_statusstring

Returned value: Announcement Status.

announcement_status_valstring

Raw value of announcement_status. The announcement_status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

review_statusstring

Returned value: Audit status.

review_status_valstring

Raw value of review_status. The review_status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

positionsstring

Returned value: Positions.

positions_valstring

Raw value of positions. The positions field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

marketsstring

Returned value: Markets.

markets_valstring

Raw value of markets. The markets field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

counter_idsstring

Returned value: Counter Ids.

operatorstring

Returned value: Operator.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

HTTP 400Bad request. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/announce_saas_announcements' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "325824",
        "begin_at": "1784030469",
        "end_at": "1784116869",
        "announcement_type": "Temporary Closure",
        "announcement_type_val": "ntemporary_closed",
        "reason": "lb_公告测试_ntemporary_closed",
        "status": "Enable",
        "status_val": "2",
        "announcement_status": "Expired",
        "announcement_status_val": "2",
        "review_status": "Approved",
        "review_status_val": "3",
        "positions": "Watchlist,Assets,Stock Details,Trade,Withdrawal,My tab,Currency Exchange,Deposit",
        "positions_val": "watchlist,portfolio,stockdetail,trade,withdrawal,my_tab,currency_exchange,deposit",
        "markets": "HK,JP,US,UK,CN,DE,AU,SG",
        "markets_val": "HK,JP,US,UK,CN,DE,AU,SG",
        "counter_ids": "",
        "operator": "user@example.com"
      }
    ],
    "total": 91
  }
}