The LiveEngage Consumer Messaging History API allows retrieval of up to 13 months of historical conversations data, both metadata and content, for a specific consumer. This includes both archived and closed conversations.

This API is based on the REST architecture and supports the HTTPS GET protocol. All retrieved data is returned in JSON format. This API supports CORS which enables cross-domain data transfers.

Getting Started

A few things you'll need to get started with this API:

  1. Retrieve your domain. Use the LivePerson Domain API to retrieve this information by providing the following service name:

    • msgHist
  2. This API requires authorization using a JWT token passed in the authorization header of the request. Please see our Authentication document and Token creation document for more info.

  3. Here are the API terms of use.

Use Cases

This is a complementary API for the Messaging Window API. It should be used to retrieve the historical conversations when using the Messaging Window API for the different use cases / scenarios described here.