Introduction

The Visit Information API provides a way to pull data in real-time, when a session is active and exists in memory. After a maximum of 6 hours, the session will expire and be removed from memory, so a 404 response (internal code 12) will be returned.

The data is about the visitor, engagement, and session for the agent to use during the conversation. For example, referrer, engagement attributes, etc.

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:

    • smt

  2. This API requires authorization using either a login or an API key methodology.

    • Log a user into Conversational Cloud using the Login Service API. Provide a username and password, and receive an authorization token (bearer). Use this token as your authorization header in all API requests.

    • Follow the instructions, to create and use an API key.

  3. Note the API terms of use.

  4. When using this API, it is recommended that you implement our Retry Policy and KeepAlive best practices.

Use cases

This API can be used to display context information to agents about the session, visitor and engagement in a brand’s built Agent Workspace application. Examples include the click-to-call solution in which voice agents are not LivePerson users, or agents that don’t use Agent Workspace.

Example of how visitor information is displayed to agents within the Agent Workspace:

Screenshot of the Agent Workspace