Skip to content
Longport WhaleLongport Whale
Announcement

Global Push Templates

group_id values:

  • 2 — Asset Movement
  • 6 — Order Status
  • 7 — Activity Related
  • 8 — Announcement
  • 9 — Account Message
  • 10 — Price Movement
  • 11 — IPO News
  • 12 — Community
  • 15 — College
  • 16 — My News
  • 17 — Today's Highlights
  • 30 — Holdings Daily
  • 31 — Market Data
  • 32 — Option Fluctuation
  • 33 — System Message
  • 34 — Dolphin Views
  • 36 — Recurring Investments
GEThttps://b-api.longbridge.xyz/v1/whaleapi/message/whale/global/push/templates

Authorization

AuthorizationstringheaderRequired

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

Parameters

pageinteger

Page number (page).

page_sizeinteger

Page size (page_size).

Responses

HTTP 200OK
Standard response envelopecodemessagedata
dataobjectdata structure
totalintegerrequired

total

templatesarray<object>required

templates

Child attributes
keystringrequired

key

namestringrequired

name

channelstringrequired

channel

group_idintegerrequired

group_id

localesarray<object>required

locales

Child attributes
languagestringrequired

language

titlestringrequired

title

bodystringrequired

body

configsobjectrequired

configs

Child attributes
push_configobjectrequired

push_config

Child attributes
coverstringrequired

cover

linkstringrequired

link

jsonstringrequired

json

push_device_typesarray<string>required

push_device_types

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