API Documentation

Message

NameDescriptionTypeAdditional information
MessageId

Message identifier (an internal reference number)

integer

None.

CreatedOn

The date and time the message was sent

date

None.

MessageText

The text of the sent message

string

None.

DeliveryStatus

The status of a submitted message to the Iridium Burst system. This field will be empty if no delivery status check was performed from the portal.

string

None.

IridiumMessageId

A globally unique identifier returned from Iridium (to be used for support purposes)

string

None.

RepeatCount

The number of times the Iridium Burst system was instructed to repeat the message

integer

None.

RepeatInterval

Numeric value of the duration between repeated transmissions (in minutes)

integer

None.

BroadcastCoverageAreaCodes

Broadcast coverage area code (can contain multiple values separated by commas)

string

None.

Latitude

The latitude of the center of the requested delivery area

decimal number

None.

Longitude

The longitude of the center of the requested delivery area

decimal number

None.

Radius

The radius of the requested delivery area

integer

None.

ServiceMask

A bit mask containing the services that the pager should respond to

integer

None.

MessageCost

The cost based on the message size and delivery area in USD (This is an estimate. The actual charge for the message will be determined by Iridium)

decimal number

None.

Sender

The sender's user name (email address)

string

None.

AccountId

The Account identifier used for this message

integer

None.

CustomerNumber

The customer account number

integer

None.

Services

A list of services to which this message was targetted

Collection of string

None.