Communications
SBD Relaying
Feature Summary
SBD (Short Burst Data) Relaying is a GSatTrack API that transmits messages from your application to the Iridium network via a simple HTTP POST. It returns instant status feedback on the ground-station message queue, and avoids the binary parser and static-IP whitelisting that direct Iridium integration would otherwise require.
Additional Information
SBD Relaying Communication
To easily transmit messages from your application to the Iridium network, GSatTrack has created a simple-to-use API mechanism to communicate directly with the Iridium gateway. This API allows users to receive instantaneous information regarding the message queue status at the ground station.
To communicate directly with the Iridium ground station, users would typically need to develop a binary parser and submit a static IP address for whitelisting at Iridium, a process that takes approximately 2-3 weeks.
Iridium SBD relay requests are sent using an HTTP POST to the following URL format:
https://www.gsattrack.com/api/sbd/relay
The request body is JSON (Content-Type: application/json) with the following properties:
| Property | Name | Type | Description |
|---|---|---|---|
| key | SBD Key | String | The SBD Key that was set up for the customer. This identifies the customer making the request. |
| imei | IMEI | String | The IMEI of the device to receive the SBD message. |
| messageid | Message Identifier | Integer (0 to 65535) | The unique message identifier to associate with the SBD message. This identifier should be unique across your SBD messages. |
| message | Message | String (Base 64 encoded) | The binary SBD message you wish to send, encoded as a base-64 string. |
An SBD Key only reaches devices in its own account: the IMEI must be an active device in the account the key belongs to, and the account must be active. Any other IMEI is refused.
For example:
curl -X POST https://www.gsattrack.com/api/sbd/relay \
-H "Content-Type: application/json" \
-d '{"key": "YOUR-SBD-KEY", "imei": "YOUR-DEVICE-IMEI", "messageid": 1, "message": "SGVsbG8="}'
The relay answers with one of these HTTP statuses:
- 200: the Iridium gateway answered. The response body holds its confirmation, which says whether the message was queued for the device.
- 400: a property is missing or invalid. The response body names it.
- 401: the SBD Key is not recognized, its account is not active, or the IMEI is not an active device in the key's account.
- 415: the request body is not JSON, for example a form post.
- 500: the message could not be sent, for example because it is not valid base-64 or the Iridium gateway could not be reached.
Key Features
- Simple API Integration — send messages with a single HTTP POST, no binary parser or static-IP whitelisting required.
- Instant Feedback — message submissions return immediate ground-station queue status for quick verification and troubleshooting.
- Direct Iridium Communication — relays directly through the Iridium gateway to connected devices.
- Base64 Message Support — send binary SBD messages as base64-encoded strings.
- Error Handling — each kind of failure has its own HTTP status, and a missing or invalid property is named in the response.
Use Cases
- Remote Asset Monitoring — relay status from remote devices to your application for real-time monitoring.
- Emergency Alerts — send time-critical alerts or notifications over the Iridium network.
- Data Collection — gather operational metrics from field devices for analysis.
- Logistics and Fleet Management — track fleet movements and push real-time instructions to drivers.