Skip to main content

LingoMT

Mobile Originated (MT) Messages sent from the platform to Devices.

The structured Message format comprises the following five top-level fields:

  • ID - Unique Identifier for each Message generated by the Customer (or Platform, if not supplied)
  • Received At - Time the Message was first received from the Network (UTC)
  • Identity - Identifiers for this Thing in Cloudloop (e.g. Account, Subscriber, Device etc)
  • Message - Raw Message payload sent from the Device in Bytes
  • Encoded - Interpreted Message payload (where possible)
    • P6 - Messages originated from a Ground Control tracking Device (e.g. RockSTAR)
    • IOT - "IoT Gateway" Message originating from RockREMOTE
    • Ceefax - CDM Message originating from RockREMOTE
    • IES - Message transmitted from an Iridium Edge Solar Device

Anatomy of an MT Message (SBD)​

Below is an example SBD Message transmitted to a RockAIR; we'll break down each section and discuss in detail

{
  "id": "c0eb3dd4-0ab5-41f2-8fbd-b71083161fba",
  "identity": {
    "thingId": "DgXeoxwVPMyrdOBJeEGlqKRJLbajQkzZ"
  },
  "p6": {
    "mt": {
      "encrypted": false,
      "type": "MT_MESSAGE_START_WATCHING_ME",
      "watchConfirmation": {
        "watching": true
      }
    }
  }
}

1. Preamble​

All Messages have the following common field

  • id - Unique Identifier for each Message generated by the Customer (or Platform, if not supplied)
{
  "id": "c0eb3dd4-0ab5-41f2-8fbd-b71083161fba"
}

2. Identity​

In order to correctly route Messages the identity of the target needs to be established; Customers should provide one of these four Identifiers to unambiguously identify the Thing in the Account.

  • identity
    • subscriber - Object representing the Cloudloop Subscriber
      • id - Cloudloop Subscriber Identifier (e.g. XgwyNPpDmebJLWXmwgEoARqxMdZOVGva)
    • hardware - Object representing the Cloudloop Hardware (where applicable)
      • id - Cloudloop Hardware Identifier (e.g. joGRxQrXpzkPJEglMOBydwYZbqmDagNA)
      • imei - IMEI of Device transmitting
    • thingId - Cloudloop Thing Identifier (e.g. DgXeoxwVPMyrdOBJeEGlqKRJLbajQkzZ)
{
  "identity": {
    "thingId": "DgXeoxwVPMyrdOBJeEGlqKRJLbajQkzZ"
  }
}

By Cloudloop Subscriber Identifier​

{
  "identity": {
    "subscriber": {
      "id": "XgwyNPpDmebJLWXmwgEoARqxMdZOVGva"
    }
  }
}

By Cloudloop Subscriber Hardware Identifier​

{
  "identity": {
    "hardware": {
      "id": "joGRxQrXpzkPJEglMOBydwYZbqmDagNA"
    }
  }
}

By Cloudloop Subscriber Hardware IMEI​

{
  "identity": {
    "hardware": {
      "imei": "300234065366010"
    }
  }
}
Identity Verfication

The platform will validate that the Identity provided against your Account; if an invalid identifier (or one residing in another Account) is used the request will fail; and applicable Pulses and/or LingoStatus Messages will be generated.


3. Message (Optional)​

The raw bytes as transmitted to be transmitted to the Device; provide this or Encoded Message.

{
  "message": "JgBreyuiF+0IgswAAAQBR2QnBQ=="
}

4. Encoded (Optional)​

The Message to be encoded - one of the following should be populated.

The full details of these protocols are extensive; for example P6 encompasses all Messages the Device can send and receive (~100 Message types); therefore more comprehensive documentation for each protocol can be found using the links above.

{
  "p6": {
    "mt": {
      "encrypted": false,
      "type": "MT_MESSAGE_START_WATCHING_ME",
      "watchConfirmation": {
        "watching": true
      }
    }
  }
}

Example showing a "Start Watching Me" Message to the Device