Skip to main content

Sending Downlink Messages

Downlink messages allow you to send data from your servers to your satellite devices in the field. This page covers everything you need to know about sending messages to your devices.

Overview

The e-BSS API provides a straightforward way to send downlink messages to satellite devices identified by their IMSI number. These messages are queued for delivery when the device next connects to the satellite network.

Endpoint Details

POST /devices/{imsi}/downlink

Path Parameters

ParameterTypeRequiredDescription
imsistringYesThe IMSI number of the target device

Request Headers

HeaderValueRequiredDescription
x-api-keyYour API keyYesAPI key for authentication
Content-Typeapplication/jsonYesContent type of the request body

Request Body

The request body should contain your message payload according to the Message Relay Format specification. For detailed information about message formats, refer to our Message Relay Format documentation.

Example request body:

{
"messageType": "text",
"payload": "Check temperature sensor at location alpha"
}

Response

Upon successful submission, the API returns a string containing the message ID, which you can use to track the delivery status of the message.

Example response:

"0003505dcb762d67d8cde52d0001"