API Documentation
Introduction
Our API provides a simple way to programatically send messages to your GDB devices from any programming language.
To send a message you must be a customer of ours and have the appropriate credentials. For more information please contact us
The API is entirely HTTP-based. Methods to retrieve data from the API require a GET request. Methods that submit, change, or destroy data require a POST. API Methods that require a particular HTTP method will return an error if you do not make your request with the correct verb. HTTP Response Codes are meaningful. The API is a RESTful resource. The API attempts to conform to the design principles of Representational State Transfer (REST).
API Key
Each API call requires that an API key is present in the request headers.Your API key is available on your My Account page. If you do not have access to the My Account page, please contact your administrator.
X-GDB-APIKEY: HnDA8ZGkU4AFY626x48DTZEtqXtg+PtnW8eLcmDixtsCmlKBw==
Messages
Send messages to one or more GDB devices or retrieve a list of sent messages
| API | Description |
|---|---|
| POST api/textmessages/{imei}?message={message}&serviceMask={serviceMask}&pin={pin}&sendDirect={sendDirect} |
Broadcast a message to one or more GDB Pagers |
| GET api/textmessages?startDate={startDate}&endDate={endDate} |
Returns list of sent messages for your account. A maximum of 1000 records are returned. If you need more, then please narrow the date range. Dates are specified in the following format YYYY-MM-DDTHH:MM:SS |
| POST api/repeatmessages |
No documentation available. |
BurstMessages
Allows you to send a raw Burst message and retrieve the current message status from the Iridium Burst ground system
| API | Description |
|---|---|
| GET api/burstmessages/{messageId} |
Accepts a unique message id and returns the status of the message from the Iridium Burst system |
| 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. |
Subscriptions
Provides access to the subscriptions associated with the account.
| API | Description |
|---|---|
| GET api/subscriptions |
Fetch a list of Subscriptions for the account |
Transfer
| API | Description |
|---|---|
| POST api/transfer/{imei}?serviceMask={serviceMask} |
Sends a GDB Transfer message. |
BurstVpnStatus
| API | Description |
|---|---|
| GET api/BurstVpnStatus |
Determines if the Paging service is available. |