AMS DocumentationAMS

Message Details

When routing it is possible to include extra information about the messages being processed.

The data that is inserted will be placed under the ‘messageDetails’ key. This means that to access a value from the details of a message it is necessary tot prefix the item’s name with ‘messageDetails’ followed by a dot, ‘.’.

For example when inserting a merge field to access the display name of the mobile account that sent the message into a Word Document for a Document Transformation, the value ‘messageDetails.displayName’ should be used as the merge field label.

Values available under messageDetails include the following:

Key Value
id message id (uuid format)
replyToId The id this message is a reply to. May not be set.
username The username of the Mobile Account used to send this message.
displayName The display name of the Mobile Account used to send this message. Available if set in the Mobile Account
creationDate The timestamp of the time this message was created at the AMS Gateway. Will be in UTC time.
sentFromDevice The timestamp of the time this message was sent from the users phone. Available if message received by the gateway. Will be in UTC time.
deliveredDateTime The timestamp of the time this message was downloaded to the users phone. Available if message sent by the gateway. Will be in UTC time.
resent A boolean indicating if this was a resent message.
latitude A numeric value indicating the latitude this message was sent from. May not be set.
longitude numeric value indicating the longitude this message was sent from. May not be set.
altitude A numeric value indicating the altitude this message was sent from. May not be set.