API Documentation

POST api/textmessages/{imei}?message={message}&serviceMask={serviceMask}&pin={pin}&sendDirect={sendDirect}

Broadcast a message to one or more GDB Pagers

URI Parameters

Name	Description	Type	Additional information
message	The text of the message to be sent (max. 100 characters)	string	Required
serviceMask	[Optional] A single byte bit mask to determine which pagers will process the message. The service mask is ignored for addressed messages.	byte	Default value is 255
imei	[Optional] The address of a specific pager to which the message will be delivered.	string	None.
pin	[Optional] A string containing 4 non-repeating digits. Used for secure messages.	string	None.
sendDirect	Reserved for future use	boolean	Default value is True

Body Parameters

A serialisation of the delivery options.

DeliveryOptions

Name	Type	Additional information
RepeatOptions	RepeatOptions	None.
DeliveryTime	date	None.
ExpirationTime	date	None.
BroadcastCoverageAreas	Collection of BroadcastCoverageArea	None.
GlobalDeliveryAreas	Collection of integer	None.
DeliveryPoints	Collection of DeliveryPoint	None.

Request Formats

application/json, text/json

Sample:

{
  "RepeatOptions": {
    "Count": 1,
    "Interval": 2
  },
  "DeliveryTime": "2025-04-03T14:51:43.1429513+00:00",
  "ExpirationTime": "2025-04-03T14:51:43.1429513+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

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.