Our Data APIs enable you to retrieve many attributes and information types. Please refer to API Data Metrics for the different types of information and attributes which are retrievable via both our Historical and Real Time Data APIs.

The Conversational Cloud 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. The API supports CORS to enable 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 and token creation documentation for more information.

  3. Note the API terms of use.

Use cases

This is a complementary API for the Messaging Window API. It should be used to retrieve historical conversations when using the Messaging Window API for its various use cases and scenarios.