TextMessage

Introduction
A message to send or received from a device.
When working with text messages it is important to make the distinction between a "Reply" and a "Response".
  • Reply: A reply is a Text Message that is a Reply to another text message. For example: A text message is sent to a device and the device replies with a text message of it's own.
  • Response: A response is a predefined ("canned") response within a text message. For example: A text message is sent to a device with a number of canned responses to reply with (Yes, No, Maybe). One of those responses is selected by the driver and is the message of the Reply from the device.
Properties

activeFrom

The date and time the text message is active from.

activeTo

The date and time the text message is active to. For IOX-bound messages directed to a vehicle, if no explicit value is provided, the system automatically sets this to 30 days from creation.

delivered

The date and time the message was delivered. Default [MaxDate].

device

The Device the message was sent to. Default [Null].

id

The unique identifier for the specific Entity object in the Geotab system. See Id.

isDirectionToVehicle

If message is going to or from vehicle.

markedReadBy

The User who read the message or null if the message has not been read.

messageContent

The message content. A basic message can be sent via a TextContent or a message with predefined ("canned") responses by a CannedResponseContent or a series of LocationContent comprising a route.

parentMessage

The text message that this is the reply to. Only a reply message will have a parent.

read

The date and time the message was read or null if the message has not been read.

recipient

The User the message was sent to. Default [Null].

replyMessage

The text message reply to this message. A text message should only have one reply. (Should not reply to a reply). Default [Null]

sent

The date and time the message was sent. Default [MaxDate].

user

The User that the message was sent from or null. If the message was sent from a device or was generated by the system the user property will be null. Default [Null].

version

The version of the entity.
Rate limits
MethodDescriptionLimitPeriod
GetLimit of 99999 Get requests per 1s.999991s
SetLimit of 99999 Set requests per 1s.999991s
AddLimit of 99999 Add requests per 1s.999991s
RemoveLimit of 99999 Remove requests per 1s.999991s
GetCountOfLimit of 99999 GetCountOf requests per 1s.999991s
GetFeedLimit of 99999 GetFeed requests per 1s.999991s
Pagination

Results limit

5000

Supported sort

Id

Date sorts by the TextMessage.Sent property.

Timeout Limit
MethodDescriptionLimitStatus
GetFeed180Active

Loading API Runner...