API Documentation

POST api/burstmessages

Sends a raw Burst message. This should not be used with a GDB Pager. Pager messages use a proprietary encoding and are encrypted.

URI Parameters

None.

Body Parameters

The BurstMessage to send

BurstMessage
NameDescriptionTypeAdditional information
MessagePayload

Collection of byte

None.

DeliveryOptions

DeliveryOptions

None.

Request Formats

application/json, text/json

Sample:
{
  "MessagePayload": "QEA=",
  "DeliveryOptions": {
    "RepeatOptions": {
      "Count": 1,
      "Interval": 2
    },
    "DeliveryTime": "2025-04-04T03:41:24.6017459+00:00",
    "ExpirationTime": "2025-04-04T03:41:24.6017459+00:00",
    "BroadcastCoverageAreas": [
      {
        "Code": "sample string 1",
        "Name": "sample string 2",
        "GdaCount": 3,
        "Gdas": [
          1,
          2
        ]
      },
      {
        "Code": "sample string 1",
        "Name": "sample string 2",
        "GdaCount": 3,
        "Gdas": [
          1,
          2
        ]
      }
    ],
    "GlobalDeliveryAreas": [
      1,
      1
    ],
    "DeliveryPoints": [
      {
        "Latitude": 1.1,
        "Longitude": 2.1,
        "Radius": 3
      },
      {
        "Latitude": 1.1,
        "Longitude": 2.1,
        "Radius": 3
      }
    ]
  }
}

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.