API Documentation

POST api/transfer/{imei}?serviceMask={serviceMask}

Sends a GDB Transfer message.

URI Parameters

Name	Description	Type	Additional information
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.

Body Parameters

TransferObject

Name	Type	Additional information
DeliveryOptions	DeliveryOptions	None.
TransferData	Collection of byte	None.
RelayState	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "DeliveryOptions": {
    "RepeatOptions": {
      "Count": 1,
      "Interval": 2
    },
    "DeliveryTime": "2025-04-04T03:41:27.8367522+00:00",
    "ExpirationTime": "2025-04-04T03:41:27.8367522+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
      }
    ]
  },
  "TransferData": "QEA=",
  "RelayState": true
}

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.