Get contact's message history

get

https://yespo.io/api/v2/contacts/messages

The method returns the contact's message history.
Supported media types: Email, SMS, Viber, Mobile Push, Web Push, App Inbox, Telegram.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Note
The dateFrom parameter can't be older than 1 year. For an earlier date, the API returns the error dateFrom mustn't be older than a year.

Query Params

dateFrom

string

required

The initial date or date and time of the history period. The date/time values are passed in the ISO_8061 format.

Date format: YYYY-MM-DD

Date with time format: YYYY-MM-DDTHH:mm

dateTo

string

required

The final date or date amd time of the history period. The date/time values are passed in the ISO_8061 format.

Date format: YYYY-MM-DD

Date with time format: YYYY-MM-DDTHH:mm

string

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

phone

string

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

contactId

int64

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

externalCustomerId

string

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

channelTypes

string

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

offset

int32

Defaults to 0

Offset from the first item. For pagination purposes

maxrows

int32

Defaults to 10

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

Response

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json; charset=UTF-8

Note

200