RESTAPI
Page tree
Skip to end of metadata
Go to start of metadata

Description

Retrieves the message history for a recipient for a set time frame.
The maximum time frame is 31 days. The maximum number of messages returned is 5000. sendDate is presented as Datetime

Available from

v6

Request path

GET [REST URL]/user/getMessageHistory

Query Parameters

Parameter

Type

Description

userId

Long

Start date of time frame in ISO 8601 date time format.

fromDate

String

Start date of time frame in ISO 8601 date time format.

toDate

String

End date of time frame in ISO 8601 date time format.

Example response

[
  {
    "messageID": [354476555],
    "externalTransactionId": {},
    "externalMessageID": {},
    "messageName": ["Test"],
    "messageSubject": ["Test"],
    "groupId": [353599854],
    "groupName": ["Test"],
    "groupEmail": ["test@test.com"],
    "sendDate": [1491216661590],
    "messageType": ["single"],
    "status": ["Sent"],
    "clicked": [true],
    "opened": [false]
  }
]
  • No labels