For the complete documentation index, see llms.txt. This page is also available as Markdown.

MO Messages

Returns a list of mobile originated messages for the device This endpoint returns paged results of up to 1,000 records per response, using the X-CONTINUATIONTOKEN header. When the response includes this token, it indicates that additional records are available. To retrieve the next set of results, include the X-CONTINUATIONTOKEN token from the previous response header in the header of your subsequent request. This process can be repeated until no further continuation token is provided, indicating that you have reached the end of the dataset.

get
Path parameters
tenantVarCodestringRequired

Tenant Var Code

deviceIdstringRequired

Device Id

Query parameters
fromstring · date-timeOptional

From Date

tostring · date-timeOptional

To Date

filebooleanOptional

If true, result include Base64 encoded file

Default: false
Responses
200

OK

MessageIdstring · nullableOptional

A unique numeric identifier for the message (read only)

MessageTypestring · min: 1Required

A string representing the message type. Some typical message types are: AutomaticPositionReport, ManualPositionReport, ResponseToLocationRequest, SwitchOn, SystemTest, DiagnosticResponse, DeviceIdentifierResponse, Synchronise, FreeText, GeofenceCrossed, BeginMonitoring, EndMonitoring, CheckIn, CannedMessageSend, MessageAcknowledgement, PowerDown, Waypoint

Recipientsstring · nullableOptional

A comma separated list of address book lists to which the message will be sent if routable

Messagestring · nullableOptional

A string representing the message

Attachmentstring · byte · nullableOptional

A Base64 encoded byte array representing an attachment. The maximum size is 64Kb. This field is deprecated, use File property instead

SequenceNumberinteger · int32Optional

An integer value that can be used by the client to determine the order of the message. This is normally incremented by the client for each message

ReceivedAtServerstring · date-timeOptional

The time when the message was processed by the platform

SentFromDevicestring · date-timeRequired

A date and time that the device reports its position. This would normally be the GPS time but doesn't have to be

EmergencyStatestring · enumRequiredPossible values:
Filestring · byte · nullableOptional

A Base64 encoded byte array representing binary data. The maximum size is 4MB

MimeTypestring · nullableOptional

MIME type for file data

Filenamestring · nullableOptional

Filename for file data

ETagstring · nullableOptional

ETag value for handling optimistic concurrency control

get/V2/{tenantVarCode}/devices/{deviceId}/momessages
GET /V2/{tenantVarCode}/devices/{deviceId}/momessages HTTP/1.1
Accept: */*
200

OK

[
  {
    "MessageId": "text",
    "MessageType": "text",
    "Recipients": "text",
    "Message": "text",
    "Attachment": "Ynl0ZXM=",
    "Position": {
      "Latitude": 1,
      "Longitude": 1,
      "Speed": 1,
      "Heading": 1,
      "Altitude": 1,
      "GpsTimestamp": "2026-01-01T00:00:00.000Z",
      "Accuracy": "text",
      "LocationSource": "Gps"
    },
    "SequenceNumber": 1,
    "ReceivedAtServer": "2026-01-01T00:00:00.000Z",
    "SentFromDevice": "2026-01-01T00:00:00.000Z",
    "EmergencyState": "None",
    "Properties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "ContainingGeofences": [
      {
        "GeofenceId": "text",
        "GeofenceName": "text"
      }
    ],
    "File": "Ynl0ZXM=",
    "MimeType": "text",
    "Filename": "text",
    "ETag": "text"
  }
]

Stores and processes a mobile originated messages for the device

post

Please note that the size of the message data must be smaller than 48KB or the request will be rejected.

Path parameters
tenantVarCodestringRequired

Tenant Var Code

deviceIdstringRequired

Device Id

Query parameters
processSyncbooleanOptional

Process the message and return result

Default: false
Bodyobject · MoMessage[]
MessageIdstring · nullableOptional

A unique numeric identifier for the message (read only)

MessageTypestring · min: 1Required

A string representing the message type. Some typical message types are: AutomaticPositionReport, ManualPositionReport, ResponseToLocationRequest, SwitchOn, SystemTest, DiagnosticResponse, DeviceIdentifierResponse, Synchronise, FreeText, GeofenceCrossed, BeginMonitoring, EndMonitoring, CheckIn, CannedMessageSend, MessageAcknowledgement, PowerDown, Waypoint

Recipientsstring · nullableOptional

A comma separated list of address book lists to which the message will be sent if routable

Messagestring · nullableOptional

A string representing the message

Attachmentstring · byte · nullableOptional

A Base64 encoded byte array representing an attachment. The maximum size is 64Kb. This field is deprecated, use File property instead

SequenceNumberinteger · int32Optional

An integer value that can be used by the client to determine the order of the message. This is normally incremented by the client for each message

ReceivedAtServerstring · date-timeOptional

The time when the message was processed by the platform

SentFromDevicestring · date-timeRequired

A date and time that the device reports its position. This would normally be the GPS time but doesn't have to be

EmergencyStatestring · enumRequiredPossible values:
Filestring · byte · nullableOptional

A Base64 encoded byte array representing binary data. The maximum size is 4MB

MimeTypestring · nullableOptional

MIME type for file data

Filenamestring · nullableOptional

Filename for file data

ETagstring · nullableOptional

ETag value for handling optimistic concurrency control

Responses
200

OK

No content

post/V2/{tenantVarCode}/devices/{deviceId}/momessages
POST /V2/{tenantVarCode}/devices/{deviceId}/momessages HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 579

[
  {
    "MessageId": "text",
    "MessageType": "text",
    "Recipients": "text",
    "Message": "text",
    "Attachment": "Ynl0ZXM=",
    "Position": {
      "Latitude": 1,
      "Longitude": 1,
      "Speed": 1,
      "Heading": 1,
      "Altitude": 1,
      "GpsTimestamp": "2026-01-01T00:00:00.000Z",
      "Accuracy": "text",
      "LocationSource": "Gps"
    },
    "SequenceNumber": 1,
    "ReceivedAtServer": "2026-01-01T00:00:00.000Z",
    "SentFromDevice": "2026-01-01T00:00:00.000Z",
    "EmergencyState": "None",
    "Properties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "ContainingGeofences": [
      {
        "GeofenceId": "text",
        "GeofenceName": "text"
      }
    ],
    "File": "Ynl0ZXM=",
    "MimeType": "text",
    "Filename": "text",
    "ETag": "text"
  }
]
200

OK

No content

Returns a specific mobile originated message

get
Path parameters
tenantVarCodestringRequired

Tenant Var Code

deviceIdstringRequired

Device Id

messageIdstringRequired

Message Id

Query parameters
filebooleanOptional

If true, result include Base64 encoded file

Default: false
Responses
200

OK

MessageIdstring · nullableOptional

A unique numeric identifier for the message (read only)

MessageTypestring · min: 1Required

A string representing the message type. Some typical message types are: AutomaticPositionReport, ManualPositionReport, ResponseToLocationRequest, SwitchOn, SystemTest, DiagnosticResponse, DeviceIdentifierResponse, Synchronise, FreeText, GeofenceCrossed, BeginMonitoring, EndMonitoring, CheckIn, CannedMessageSend, MessageAcknowledgement, PowerDown, Waypoint

Recipientsstring · nullableOptional

A comma separated list of address book lists to which the message will be sent if routable

Messagestring · nullableOptional

A string representing the message

Attachmentstring · byte · nullableOptional

A Base64 encoded byte array representing an attachment. The maximum size is 64Kb. This field is deprecated, use File property instead

SequenceNumberinteger · int32Optional

An integer value that can be used by the client to determine the order of the message. This is normally incremented by the client for each message

ReceivedAtServerstring · date-timeOptional

The time when the message was processed by the platform

SentFromDevicestring · date-timeRequired

A date and time that the device reports its position. This would normally be the GPS time but doesn't have to be

EmergencyStatestring · enumRequiredPossible values:
Filestring · byte · nullableOptional

A Base64 encoded byte array representing binary data. The maximum size is 4MB

MimeTypestring · nullableOptional

MIME type for file data

Filenamestring · nullableOptional

Filename for file data

ETagstring · nullableOptional

ETag value for handling optimistic concurrency control

get/V2/{tenantVarCode}/devices/{deviceId}/momessages/{messageId}
GET /V2/{tenantVarCode}/devices/{deviceId}/momessages/{messageId} HTTP/1.1
Accept: */*
200

OK

{
  "MessageId": "text",
  "MessageType": "text",
  "Recipients": "text",
  "Message": "text",
  "Attachment": "Ynl0ZXM=",
  "Position": {
    "Latitude": 1,
    "Longitude": 1,
    "Speed": 1,
    "Heading": 1,
    "Altitude": 1,
    "GpsTimestamp": "2026-01-01T00:00:00.000Z",
    "Accuracy": "text",
    "LocationSource": "Gps"
  },
  "SequenceNumber": 1,
  "ReceivedAtServer": "2026-01-01T00:00:00.000Z",
  "SentFromDevice": "2026-01-01T00:00:00.000Z",
  "EmergencyState": "None",
  "Properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "ContainingGeofences": [
    {
      "GeofenceId": "text",
      "GeofenceName": "text"
    }
  ],
  "File": "Ynl0ZXM=",
  "MimeType": "text",
  "Filename": "text",
  "ETag": "text"
}

Deletes a specific mo message

delete
Path parameters
tenantVarCodestringRequired

Tenant Var Code

deviceIdstringRequired

Device Id

messageIdstringRequired

Id of message to delete

Responses
200

OK

No content

delete/V2/{tenantVarCode}/devices/{deviceId}/momessages/{messageId}
DELETE /V2/{tenantVarCode}/devices/{deviceId}/momessages/{messageId} HTTP/1.1
Accept: */*
200

OK

No content

Last updated