MT Messages

Returns a list of mobile terminated 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

Responses

200

OK

MessageIdstring · nullableOptional

A unique numeric identifier for the message (read only)

Attachmentstring · byte · nullableOptional

A Base64 encoded byte array representing the binary attachment send to the device

Messagestring · nullableOptional

A string representing the message text

MessageTypestring · min: 1Required

A string representing the message type. Currently supported message types are: FreeText, PositionRequest, ChangeSettings, CheckInRequest

SenderAddressstring · min: 1Required

The email address of the sender

TimeSentstring · date-timeOptional

A date and time that the platform sent the message

get/V2/{tenantVarCode}/devices/{deviceId}/mtmessages

GET /V2/{tenantVarCode}/devices/{deviceId}/mtmessages HTTP/1.1
Accept: */*

200

OK

[
  {
    "MessageId": "text",
    "Attachment": "Ynl0ZXM=",
    "Message": "text",
    "MessageType": "text",
    "SenderAddress": "text",
    "TimeSent": "2026-01-01T00:00:00.000Z",
    "Properties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]

Enqueues a new mobile terminated messages that should be delivered to the device

post

Path parameters

tenantVarCodestringRequired

Tenant Var Code

deviceIdstringRequired

Device Id

Body

MessageIdstring · nullableOptional

A unique numeric identifier for the message (read only)

Attachmentstring · byte · nullableOptional

A Base64 encoded byte array representing the binary attachment send to the device

Messagestring · nullableOptional

A string representing the message text

MessageTypestring · min: 1Required

A string representing the message type. Currently supported message types are: FreeText, PositionRequest, ChangeSettings, CheckInRequest

SenderAddressstring · min: 1Required

The email address of the sender

TimeSentstring · date-timeOptional

A date and time that the platform sent the message

Responses

200

OK

No content

post/V2/{tenantVarCode}/devices/{deviceId}/mtmessages

POST /V2/{tenantVarCode}/devices/{deviceId}/mtmessages HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "MessageId": "text",
  "Attachment": "Ynl0ZXM=",
  "Message": "text",
  "MessageType": "text",
  "SenderAddress": "text",
  "TimeSent": "2026-01-01T00:00:00.000Z",
  "Properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

200

OK

No content

get

Path parameters

tenantVarCodestringRequired

deviceIdstringRequired

messageIdstringRequired

Responses

200

OK

MessageIdstring · nullableOptional

A unique numeric identifier for the message (read only)

Attachmentstring · byte · nullableOptional

A Base64 encoded byte array representing the binary attachment send to the device

Messagestring · nullableOptional

A string representing the message text

MessageTypestring · min: 1Required

A string representing the message type. Currently supported message types are: FreeText, PositionRequest, ChangeSettings, CheckInRequest

SenderAddressstring · min: 1Required

The email address of the sender

TimeSentstring · date-timeOptional

A date and time that the platform sent the message

get/V2/{tenantVarCode}/devices/{deviceId}/mtmessages/{messageId}

GET /V2/{tenantVarCode}/devices/{deviceId}/mtmessages/{messageId} HTTP/1.1
Accept: */*

200

OK

{
  "MessageId": "text",
  "Attachment": "Ynl0ZXM=",
  "Message": "text",
  "MessageType": "text",
  "SenderAddress": "text",
  "TimeSent": "2026-01-01T00:00:00.000Z",
  "Properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Deletes a specific mt 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}/mtmessages/{messageId}

DELETE /V2/{tenantVarCode}/devices/{deviceId}/mtmessages/{messageId} HTTP/1.1
Accept: */*

200

OK

No content