When implementing an API-based chat window in a non-monitored flow (when the Conversational Cloud Web Tag is not part of the flow), getting the Engagement is within the responsibility of the Chat API Based window Service.

In order to present a "Click to Chat" button with an updated state of availability, you must access the LP Monitoring system to create a visitor session and get an engagement. This call can be made by the Create Session method of the App Engagement API. Note: whenever you call this method, a new visitor will be created in the Visitor List. To avoid creating unnecessary load, it is advisable to use this method sparingly.

The App Engagement API exposes an eligibility and availability check for engagements for any specific consumer from an external application. This API enables you to start a session, and update the session with SDEs.

Note: This API works for engagements only of the MSDK or EXTERNAL type. If you do not have an engagement of either of these types, this API will not work. If you attempt to use this API on other types of engagements (for example, offsite or website engagements), the API calls will fail.

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:

    • msdkgw
  2. Note the API terms of use.

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

Use Cases

  • Incorporate Conversational Cloud chat window into a desktop application (gaming app, trading app, etc)

  • Add chat into dedicated desktop music application

  • Add chat into your mobile app