Wiki

Clone wiki

Numera.LibrisAPI / device.read_mailbox

Home > API Reference Documentation > device.read_mailbox

device.read_mailbox

The device.read_mailbox action will let you see the messages that are currently in the device's mailbox.

Input Parameters

PropertyRequiredDescription
idyes, or imeiThe id of the device
imeiyes, or idThe imei of the device

Output

The result object will contain an array called messages where each object has these properties:

PropertyDescription
topicmessage type
bodybody of the message
statusstatus
createdwhen it was created
alertedwhen device was notified
readwhen it was read

Possible Status Codes

Status CodeReasonDescription
1000NO_ID_OR_IMEIYou have to send in the device id or imei
1001DEVICE_DOES_NOT_EXISTCould not locate the device or the user does not have access to it

Updated