Check Message Status
After sending a downlink message to a satellite device, you'll often want to track its delivery status. This page explains how to verify whether your message has been successfully delivered to the target device.
Overview
The e-BSS API provides a dedicated endpoint to check the status of previously sent downlink messages. This allows you to monitor message delivery and implement retry logic for failed deliveries if necessary.
Message Status Lifecycle
A message can have one of the following statuses:
Status | Description |
---|---|
queued | Message has been received by the system and is waiting for the device to connect |
delivered | Message has been successfully delivered to the device |
failed | Message delivery has failed after multiple attempts |
Endpoint Details
GET /messages/{messageId}
Path Parameters
Parameter | Type | Required | Description |
---|---|---|---|
messageId | string | Yes | The ID of the message as returned by the send downlink message endpoint |
Request Headers
Header | Value | Required | Description |
---|---|---|---|
x-api-key | Your API key | Yes | API key for authentication |
Response
The API responds with a JSON object containing information about the message status.
Example response:
{
"messageId": "0003505dcb762d67d8cde52d0001",
"imsi": "123456789012345",
"status": "delivered",
"createdAt": "2025-03-14T17:30:00Z",
"deliveredAt": "2025-03-14T17:31:42Z"
}
Response Fields
Field | Type | Description |
---|---|---|
messageId | string | Unique identifier for the message |
imsi | string | The IMSI number of the target device |
status | string | Current status of the message (queued, delivered, failed) |
createdAt | string | ISO 8601 timestamp when the message was created |
deliveredAt | string | ISO 8601 timestamp when the message was delivered (only present for delivered messages) |