Skip to main content

Get Messages (MO)

The platform provides a number of "push" methods for delivering Messages; this is the recommended approach for fast and reliable Message delivery. For maximum flexibility, the platform also provides a number of "pull" endpoints enabling Messages to be programmatically retrieved at any time.


Get Message Records (By Account)

Retrieve Messages for given time period across all Things in the Account

  • from - Date/Time from (ISO-8601) (e.g. 2023-10-08T16:22:53)
  • to - Date/Time from (ISO-8601) (e.g. 2023-10-08T16:22:53)
Data/GetMessageRecords?from=XXX&to=XXX
{
"messageRecords": [
{
"snippet": "0ACE010A2435363463376638322D333661652D343037392D393964392D3635663736383861393566381AA5010A39747970652E676F6F676C65617069732E636F6D2F726F73657474612E6365656661782E436565666178556E736F6C6963697465644576656E7412680A110A070809100A18E70F120608101014182D12530803",
"at": "2023-10-09T16:20:53",
"size": 209,
"id": "QKgLZjVmdexJrEZjjMrEMlyRpaNOkDoX",
"type": "IMT",
"thing": "dYrLZzemNQwPagBmmxByOqXbvMVjAoDG",
"direction": "MO",
"pulseRecord": "meJwgzdpXVxNRnoLxQMWMDlQGLPvAbky"
},
{
"snippet": "0ACE010A2465663737663765622D613136372D346366392D616632622D3538343433343333323031641AA5010A39747970652E676F6F676C65617069732E636F6D2F726F73657474612E6365656661782E436565666178556E736F6C6963697465644576656E7412680A110A070809100A18E70F12060810100A180312530803",
"at": "2023-10-09T16:10:10",
"size": 209,
"id": "labgrGXzpmLqPEybbdMBOyoKJdkeVNvw",
"type": "IMT",
"thing": "dYrLZzemNQwPagBmmxByOqXbvMVjAoDG",
"direction": "MO",
"pulseRecord": "obXGALqOdlzpaErzoXDENkwRPZgJjmyr"
}
]
}

Endpoint: Data/GetMessageRecords


Get Message Records (By Thing)

Retrieve Message for given time period for a given Thing

  • thing - Cloudloop Thing Identifier (e.g. dYrLZzemNQwPagBmmxByOqXbvMVjAoDG)
  • from - Date/Time from (ISO-8601) (e.g. 2023-10-08T16:22:53)
  • to - Date/Time from (ISO-8601) (e.g. 2023-10-08T16:22:53)
Data/GetMessageRecordsForThing?from=XXX&to=XXX
{
"messageRecords": [
{
"snippet": "0ACE010A2435363463376638322D333661652D343037392D393964392D3635663736383861393566381AA5010A39747970652E676F6F676C65617069732E636F6D2F726F73657474612E6365656661782E436565666178556E736F6C6963697465644576656E7412680A110A070809100A18E70F120608101014182D12530803",
"at": "2023-10-09T16:20:53",
"size": 209,
"id": "QKgLZjVmdexJrEZjjMrEMlyRpaNOkDoX",
"type": "IMT",
"thing": "dYrLZzemNQwPagBmmxByOqXbvMVjAoDG",
"direction": "MO",
"pulseRecord": "meJwgzdpXVxNRnoLxQMWMDlQGLPvAbky"
},
{
"snippet": "0ACE010A2465663737663765622D613136372D346366392D616632622D3538343433343333323031641AA5010A39747970652E676F6F676C65617069732E636F6D2F726F73657474612E6365656661782E436565666178556E736F6C6963697465644576656E7412680A110A070809100A18E70F12060810100A180312530803",
"at": "2023-10-09T16:10:10",
"size": 209,
"id": "labgrGXzpmLqPEybbdMBOyoKJdkeVNvw",
"type": "IMT",
"thing": "dYrLZzemNQwPagBmmxByOqXbvMVjAoDG",
"direction": "MO",
"pulseRecord": "obXGALqOdlzpaErzoXDENkwRPZgJjmyr"
}
]
}

Endpoint: Data/GetMessageRecords


Get LingoMO

Retrieve the full LingoMO Message which includes the entire Message payload, meta-data and any decoded representation.

  • messageRecord - Message Identifier [id] from above (e.g. QKgLZjVmdexJrEZjjMrEMlyRpaNOkDoX)
Data/GetLingoMo?messageRecord=XXX
{
"id": "3f1f2e5d-c894-46fc-ac0a-b64adace4db9",
"receivedAt": {
"year": 2023,
"month": 10,
"day": 9,
"hour": 16,
"minute": 20,
"second": 53
},
"identity": {
"accountId": "ejoGRxQrXpzkPJngbjBydwYZbqmDagNA",
"subscriber": {
"id": "yJGjpPobLlmOdanVkPWAKYzNMgwVZkrR",
"type": "SUBSCRIBER_TYPE_CERTUS",
"description": ""
},
"sim": {
"id": "JGjpPobLlmOdanVkMkAWAKYzNMgwVZkr",
"iccid": "8988169771000172669"
},
"hardware": {
"id": "LyjrgkpAemZqGWRvvMvWRvNVKxQPXdYo",
"imei": "300058060009380"
},
"identifier": "9771000172669",
"thingId": "dYrLZzemNQwPagBmmxByOqXbvMVjAoDG"
},
"imt": {
"cmid": "9771000172669",
"topicId": 125,
"messageId": 124,
"size": 211
},
"message": "Cs4BCiQ1NjRjN2Y4Mi0zNmFlLTQwNzktOTlkOS02NWY3Njg4YTk1ZjgapQEKOXR5cGUuZ29vZ2xlYXBpcy5jb20vcm9zZXR0YS5jZWVmYXguQ2VlZmF4VW5zb2xpY2l0ZWRFdmVudBJoChEKBwgJEAoY5w8SBggQEBQYLRJTCAMSEQoHCAkQChjnDxIGCBAQFBgsGS6VDSQVfElAIa9CXbN76\/S\/KAEwBDkzMzMzMzPzP0HNzMzMzKxYQEkAAAAAAIBHQFoCLTFpzczMzMx0dUA=",
"ceefaxMessages": {
...
}
}

Endpoint: Data/GetLingoMo