Skip to content
Longport WhaleLongport Whale
Announcement Management

Announcement Detail

Retrieves the full configuration of a single announcement by its ID, used to populate an edit form or display announcement details.

Request parameters

  • Required: id (announcement ID), passed as the query string parameter ?id=.

Response

On success, returns the complete configuration object for the announcement, including its title, content, display channels, effective time, user scope, and status. Multi-language fields such as title and description are returned as JSON strings and must be parsed by the caller.

GEThttps://b-api.longbridge.xyz/v1/announcement

Authorization

AuthorizationstringheaderRequired

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

Parameters

idintegerRequired

Unique identifier of the announcement to retrieve.

Responses

HTTP 200On success, returns the complete configuration object for the announcement.
Standard response envelopecodemessagedata
dataobjectdata structure

Returned value: Complete configuration object for the announcement.

announcement_typestring

Returned value: Announcement type.

titlestring

Returned value: Multi-language title, returned as a JSON string keyed by language code such as zh-CN, zh-HK, and en.

descriptionstring

Returned value: Multi-language announcement content, returned as a JSON string.

rich_descstring

Returned value: Multi-language rich-text content, returned as a JSON string.

channelobject

Returned value: Display channel configuration. A map from platform keys such as ios, android, and pc to booleans indicating whether the announcement shows on that channel. Version-gated channels additionally carry <platform>_low and <platform>_up fields for the effective version range.

closableboolean

Returned value: Whether the user is allowed to manually dismiss the announcement.

conditionsstring

Returned value: Display conditions for the announcement, returned as a JSON string.

user_scopeobject

Returned value: Target user scope configuration, including the account channel (account_channel), user cluster (user_cluster, cluster_id), and organizations (org_ids).

linkstring

Returned value: Redirect link opened when the announcement is clicked.

buttonstring

Returned value: Multi-language button copy, returned as a JSON string.

priorityinteger

Returned value: Announcement priority; a larger value means higher priority.

reasonstring

Returned value: Reason for publishing or changing the announcement.

show_beginstring

Returned value: Time when the announcement starts showing, as a Unix timestamp in seconds.

show_endstring

Returned value: Time when the announcement stops showing, as a Unix timestamp in seconds.

statusinteger

Returned value: Announcement status.

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

Whale Docs