API Documentation
GET api/burstmessages/{messageId}
Accepts a unique message id and returns the status of the message from the Iridium Burst system
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| messageId |
The unique message id generated when this message was original sent |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
The response is serialization of a BurstResult object
BurstResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| RequestStatus | string |
None. |
|
| MessageStatus | string |
None. |
|
| MessageId | string |
None. |
|
| ResponseXml | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"RequestStatus": "sample string 2",
"MessageStatus": "sample string 3",
"MessageId": "sample string 4",
"ResponseXml": "sample string 5"
}