Global Push Templates

GEThttps://b-api.longbridge.xyz/v1/whaleapi/message/whale/global/push/templates

Authorization

AuthorizationstringheaderRequired

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

Parameters

pageintegerOptional

page_sizeintegerOptional

Responses

HTTP 200Fields are taken from the real responses definition for this operation in the published Whale OpenAPI spec (whale-openapi/Whale-openapi.json).

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

Request

curl --request GET \
  --url 'https://b-api.longbridge.xyz/v1/whaleapi/message/whale/global/push/templates' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "total": 0,
    "templates": [
      {
        "key": "string",
        "name": "string",
        "channel": "string",
        "group_id": 0,
        "locales": [
          {
            "language": "string",
            "title": "string",
            "body": "string",
            "configs": {
              "push_config": {
                "cover": "string",
                "link": "string",
                "json": "string",
                "push_device_types": [
                  "string"
                ]
              }
            }
          }
        ]
      }
    ]
  }
}