REreteno
Behavior tracking

Get contact's message history

The method returns the contact's message history.<br/>Supported media types: Email, SMS, Mobile Push, Web Push, App Inbox.

get/api/v2/contacts/messages

Request

Query parameters

dateFromstring required

The initial date or date and time of the history period. The date/time values are passed in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO_8061</a> format.<br> Date format: YYYY-MM-DD<br> Date with time format: YYYY-MM-DDTHH:mm

dateTostring required

The final date or date amd time of the history period. The date/time values are passed in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO_8061</a> format.<br> Date format: YYYY-MM-DD<br> Date with time format: YYYY-MM-DDTHH:mm

emailstring

Contact's email address (either contactId, or externalCustomerId, or email, or phone number must be specified)

phonestring

Contact's phone number (either contactId, or externalCustomerId, or email, or phone number must be specified)

contactIdinteger

Contact ID number (either contactId, or externalCustomerId, or email, or phone number must be specified)

externalCustomerIdstring

External Customer ID (either contactId, or externalCustomerId, or email, or phone number must be specified)

channelTypesstring

Comma separated list of user messages channel types that will be included to the response.

offsetinteger

Offset from the first item. For pagination purposes

maxrowsinteger

Max number of items in the response. Default value is 10. Maximum value is 100

Response

contactIdinteger
emailstring
phonestring
messageIdinteger

Message ID. <br> 0 for test messages or those sent using the following methods:<i>/v1/message/email</i> <i>/v1/message/sms</i> <i>/v1/message/viber</i>

messageInstanceIdinteger

ID of the message instance. <br> 0 for test messages or those sent using the following methods: <i>/v1/message/email</i> <i>/v1/message/sms</i> <i>/v1/message/viber</i>

messageTagsstring[]
channelType'email' | 'sms' | 'viber' | 'mobilepush' | 'webpush' | 'appinbox' | 'widget' | 'inapp' | 'telegrambot' | 'email' | 'sms' | 'viber'
sentDateTimestring
activityStatus'DELIVERED' | 'UNDELIVERED' | 'READ' | 'UNSUBSCRIBED' | 'SUBSCRIPTION_CHANGED' | 'CLICKED' | 'SPAM'

Activity status<br/><br/> <b>DELIVERED</b> - message delivered<br/> <b>UNDELIVERED</b> - message not delivered<br/> <b>READ</b> - message read<br/> <b>UNSUBSCRIBED</b> - contact unsubscribed from mailing<br/> <b>SUBSCRIPTION_CHANGED</b> - contact changed subscription categories<br/> <b>CLICKED</b> - contact followed the links in the message<br/> <b>SPAM</b> - contact complained about spam

fromstring

Message sender.

subjectstring

Message subject. Only for emails.

textstring

Message text. Only for Viber/SMS.

viewMessageLinkstring

Contains the link to a message. Only for emails.

Changes

No recorded changes to this operation across all 2 revisions of this API.