Skip to main content

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:

StatusDescription
queuedMessage has been received by the system and is waiting for the device to connect
deliveredMessage has been successfully delivered to the device
failedMessage delivery has failed after multiple attempts

Endpoint Details

GET /messages/{messageId}

Path Parameters

ParameterTypeRequiredDescription
messageIdstringYesThe ID of the message as returned by the send downlink message endpoint

Request Headers

HeaderValueRequiredDescription
x-api-keyYour API keyYesAPI 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

FieldTypeDescription
messageIdstringUnique identifier for the message
imsistringThe IMSI number of the target device
statusstringCurrent status of the message (queued, delivered, failed)
createdAtstringISO 8601 timestamp when the message was created
deliveredAtstringISO 8601 timestamp when the message was delivered (only present for delivered messages)