YELLOWBRICK V3 User Manual download pdf (Page 3)

Push API

The Push API will send every mobile-originated message from a device to your own web service as an HTTP POST. The parameters included in the POST can vary

depending on the type of device and the type of message, as described below.

You may conﬁgure multiple Push API endpoints via the Rock 7 Core user interface. Please contact your account manager if you require any assistance.

Response

It is essential that your web service implementation of the Push API endpoint responds correctly. Our service requires an HTTP 200 response to indicate successful

delivery - our service will then consider the message to be delivered, and no further retry attempts will be made.

Any other HTTP response will be considered a ‘temporary‘ failure, and our service will exponentially back off and retry for up to 1 week.

POST parameters

The table below describes the parameters which MAY be included.

Note that if the trigger parameter is set to CONFIG_REPORT, then you may also receive all/any of the parameters listed in the “Conﬁguration attribute reference” later in

this document.

Parameter

Description

Example/Possible values

imei

IMEI of Iridium device

15 digits

device_type

Type of device. This will usually be set to LEOPARD which refers to the family of products including

RockSTAR and Yellowbrick v3.

LEOPARD

ROCKBLOCK

serial

The serial number of the device.

An integer

momsn

The MOMSN of the SBD transmission. The MOMSN is a counter stored in the Iridium device,

incremented upon transmission.

An integer

transmit_time

Timestamp that the message was transmitted.

e.g. 2014-02-14T13:55:16Z

1 2 3 4 5 6 7 8 ... 17 18

Comments to this Manuals

No comments

YELLOWBRICK V3 User Manual Page 3

Comments to this Manuals

Related products and manuals for Navigators YELLOWBRICK V3