### LivePerson Functions Getting Started Source: https://developers.liveperson.com/liveperson-functions-event-sources-chat-post-survey.html Guides for getting started with LivePerson Functions, including development and configuration. ```APIDOC ## LivePerson Functions Getting Started ### Your First Function Guide to creating and deploying your first LivePerson Function. ### Development Deep Dive (UI) In-depth guide to developing LivePerson Functions using the UI. ### Development Deep Dive (CLI) In-depth guide to developing LivePerson Functions using the Command Line Interface. ### Configuration Information on configuring LivePerson Functions. ### Monitoring Guidance on monitoring the performance and status of LivePerson Functions. ``` -------------------------------- ### LivePerson Functions Getting Started Source: https://developers.liveperson.com/mobile-app-messaging-sdk-for-android-resources-sample-app.html Guides for getting started with LivePerson Functions, including first function, development, configuration, and monitoring. ```APIDOC ## LivePerson Functions Getting Started ### Your First Function Guide to creating your first LivePerson Function. ### Development Deep Dive (UI) In-depth guide to developing LivePerson Functions using the UI. ### Development Deep Dive (CLI) In-depth guide to developing LivePerson Functions using the CLI. ### Configuration Information on configuring LivePerson Functions. ### Monitoring Guidance on monitoring LivePerson Functions. ``` -------------------------------- ### LivePerson Functions V2 Getting Started Source: https://developers.liveperson.com/liveperson-functions-event-sources-chat-post-survey.html Guides for getting started with LivePerson Functions V2, including development and configuration. ```APIDOC ## LivePerson Functions V2 Getting Started ### Your First Function Guide to creating and deploying your first LivePerson Function V2. ### Development Deep Dive CLI In-depth guide to developing LivePerson Functions V2 using the Command Line Interface. ### Configuration Information on configuring LivePerson Functions V2. ### Monitoring Guidance on monitoring the performance and status of LivePerson Functions V2. ``` -------------------------------- ### LivePerson Functions V2 Getting Started Source: https://developers.liveperson.com/mobile-app-messaging-sdk-for-android-resources-sample-app.html Guides for getting started with LivePerson Functions V2, including first function, development, configuration, and monitoring. ```APIDOC ## LivePerson Functions V2 Getting Started ### Your First Function Guide to creating your first LivePerson Function V2. ### Development Deep Dive CLI In-depth guide to developing LivePerson Functions V2 using the CLI. ### Configuration Information on configuring LivePerson Functions V2. ### Monitoring Guidance on monitoring LivePerson Functions V2. ``` -------------------------------- ### Engagement Window Customization: Quick Start Source: https://developers.liveperson.com/conversation-orchestrator-dynamic-routing-route-conversations-by-intents.html A quick start guide for customizing the engagement window. ```markdown Get started quickly with basic customization options for the engagement window. ``` -------------------------------- ### Client Side Configuration: Engagement Window Customization Quick Start Source: https://developers.liveperson.com/automatic-messages-api-methods-update-an-automatic-message.html Offers a quick start guide for customizing the engagement window. ```markdown This guide provides the essential steps to quickly begin customizing the engagement window's look and feel. ``` -------------------------------- ### Engagement Window Customization: Quick Start Source: https://developers.liveperson.com/third-party-bots-microsoft-direct-line-copilot-studio.html A quick start guide for customizing the engagement window with basic options. ```markdown Get started quickly with customizing the engagement window using simple configuration options and examples. ``` -------------------------------- ### Monitoring API Source: https://developers.liveperson.com/mobile-app-messaging-sdk-for-android-release-notes-5-24-1.html APIs for monitoring purposes, including getting started and installation guides. ```APIDOC ## Monitoring API ### Description APIs designed for monitoring the performance and status of various components. ### Getting Started Information on how to begin using the Monitoring API. ### Installation Guides on installing a Monitoring API Application. ``` -------------------------------- ### Import and Initialize SDK Source: https://developers.liveperson.com/apple-messages-for-business-sdk-installation.html Example of importing the SDK and initializing it after installation via SPM. ```swift import LPABCMessagingSDK //import the sdk LPABCSDK.initialize(minimumLogLevel: .trace) //example of calling to initialize the SDK installed from SPM ``` -------------------------------- ### Complete Activity Implementation Example Source: https://developers.liveperson.com/mobile-app-messaging-sdk-for-android-quick-start.html Shows the full context of setting the APP_ID and initializing the SDK within an Activity. ```java private static final String APP_ID = "com.mybrand.app"; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); } public void startCodeFlow(View v) { String brandID = "62219232"; final String authCode = "k16336"; LivePerson.initialize(this, new InitLivePersonProperties(brandID, APP_ID, new InitLivePersonCallBack() { @Override public void onInitSucceed() { LPAuthenticationParams lpAuthenticationParams = new LPAuthenticationParams(LPAuthenticationType.AUTH); lpAuthenticationParams.setAuthKey(authCode); LivePerson.showConversation(MainActivity.this, lpAuthenticationParams, new ConversationViewParams()); } @Override public void onInitFailed(Exception e) { } })); } ``` -------------------------------- ### Initialize Functions Project Source: https://developers.liveperson.com/liveperson-functions-foundations-liveperson-functions-cli.html Set up the project structure and required files for local development. ```bash lpf init ``` -------------------------------- ### Engagement Window Customization: Quick Start Source: https://developers.liveperson.com/users-api-methods-reset-user-s-password.html A rapid guide to getting started with customizing the engagement window, focusing on essential steps. ```text Provides a streamlined path to implementing basic customizations. ``` -------------------------------- ### Complete Build.gradle File Example Source: https://developers.liveperson.com/mobile-app-messaging-sdk-for-android-quick-start.html A comprehensive example of a build.gradle file demonstrating the integration of LivePerson SDK dependencies and other configurations. ```gradle apply plugin: "com.android.application" android { compileSdk 35 defaultConfig { applicationId "com.mybrand.app" minSdkVersion 21 targetSdkVersion 35 versionCode 1 versionName "1.0" testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" multiDexEnabled true } buildTypes { release { minifyEnabled false proguardFiles getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro" } } } dependencies { implementation fileTree(dir: "libs", include: ["*.jar"]) ... ... ... // LivePerson SDK implementation project(path: ":lp_messaging_sdk") implementation project(path: ":messaging_ui") implementation project(path: ":infra") implementation project(path: ":messaging") implementation project(path: ":ui") implementation project(path: ":monitoring") } apply plugin: "com.google.gms.google-services" ``` -------------------------------- ### Monitoring API Source: https://developers.liveperson.com/conversation-assist-key-terms-concepts-answer-recommendations.html APIs for website monitoring, including overview, getting started, and installation. ```APIDOC ## Monitoring API ### Description APIs for website monitoring, including an overview, getting started guide, and instructions for installing a Monitoring API application. ### Endpoints - Overview - Getting Started - Installing a Monitoring API Application ``` -------------------------------- ### Monitoring API Source: https://developers.liveperson.com/guides-gettingstarted.html APIs for website monitoring, including getting started and application setup. ```APIDOC ## Monitoring API ### Overview APIs for monitoring website performance and user activity. ### Getting Started Initial steps and requirements for using the Monitoring API. ### Installing a Monitoring API Application Instructions for setting up a Monitoring API application. ### Methods (Specific methods for the Monitoring API are not detailed in the provided text, but this section would typically list them.) ``` -------------------------------- ### Initialize Authentication Parameters Source: https://developers.liveperson.com/mobile-app-messaging-sdk-for-android-methods-getconversationfragment-%28full-authentication-support-%2B-view-modes%29.html Examples for setting up authentication using either an authentication key or a JWT token. ```java new LPAuthenticationParams().setAuthKey(yourAuthCode) ``` ```java new LPAuthenticationParams().setHostAppJWT(yourJwt) ``` -------------------------------- ### Monitoring API Source: https://developers.liveperson.com/mobile-app-messaging-sdk-for-ios-advanced-features-campaigns.html APIs for monitoring services, including getting started and installing monitoring applications. ```APIDOC ## Monitoring API ### Description APIs related to website and application monitoring. ### Getting Started Information on how to begin using the Monitoring API. ### Installation Instructions for installing a Monitoring API Application. ``` -------------------------------- ### Configure Welcome Message and Quick Replies Source: https://developers.liveperson.com/mobile-app-messaging-sdk-for-ios-release-notes-all-releases.html Setup for welcome messages and quick reply options, followed by conversation view parameter initialization. ```swift //Welcome message let welcomeMessageParam = LPWelcomeMessage(message: "Hello Mr.Bond") //adding options let options: [LPWelcomeMessage.MessageOption] = [ LPWelcomeMessage.MessageOption(value: "music", displayName: "awesome tunes"), LPWelcomeMessage.MessageOption(value: "food", displayName: "Delicious food "), ] do { try welcomeMessageParam.set(options: options) } catch { print(error.localizedDescription) } //ConversationViewParams let conversationViewParams = LPConversationViewParams(conversationQuery: conversationQuery, containerViewController: nil, isViewOnly: false, conversationHistoryControlParam: conversationHistoryControlParam, welcomeMessage: welcomeMessageParam) //show conversation LPMessagingSDK.instance.showConversation(conversationViewParams, authenticationParams: authenticationParams) ``` -------------------------------- ### Monitoring API Source: https://developers.liveperson.com/actual-handle-time-api-methods-get-agent-segments.html APIs for website monitoring, including getting started and installing monitoring applications. ```APIDOC ## Monitoring API ### Description APIs for website monitoring. ### Getting Started Provides guidance on how to start using the Monitoring API. ### Installing a Monitoring API Application Instructions for installing a Monitoring API application. ``` -------------------------------- ### Messaging Agent SDK: Overview Example Source: https://developers.liveperson.com/engagement-window-widget-sdk-instructions-configuration.html A basic example demonstrating the initialization and usage of the Messaging Agent SDK. This snippet shows how to connect to the messaging service. ```javascript const messaging = new MessagingAgentSDK({ "accountId": "YOUR_ACCOUNT_ID", "agentId": "YOUR_AGENT_ID" }); messaging.on("newMessage", (message) => { console.log("Received message:", message); }); messaging.connect(); ``` -------------------------------- ### Messaging Window API - Overview Source: https://developers.liveperson.com/agent-groups-api-methods-create-agent-groups.html Provides an overview of the Messaging Window API, its protocol, and getting started guides. ```APIDOC ## Messaging Window API ### Description Provides an overview of the Messaging Window API, including protocol details, getting started guides, service limitations, and tutorials for common tasks like message retrieval, conversation metadata, and authentication. ### Tutorials - Get Messages - Conversation Metadata - Read and Accept Events - Authentication - Legacy - Post Conversation Survey (PCS) - Legacy - Post Conversation Survey (CSAT) - Client Properties - Avoid Websocket Headers - CoBrowse - Voice and Video Calls - File Sharing ### Samples - JavaScript Sample ``` -------------------------------- ### Messaging Window API - Overview Source: https://developers.liveperson.com/agent-activity-api-methods-get-status-changes.html Provides an overview of the Messaging Window API, its protocol, getting started guides, limitations, and tutorials. ```APIDOC ## Messaging Window API ### Description This API allows for integration with the LivePerson messaging window, enabling features like sending and receiving messages, managing conversations, and handling events. ### Endpoints - **Overview**: General information about the API. - **Protocol Overview**: Details on the communication protocol used. - **Getting Started**: Initial steps to integrate the API. - **Service Limitations**: Known limitations and constraints. - **Tutorials**: Step-by-step guides for common tasks. - **Samples**: Example implementations. - **API Reference**: Detailed documentation for all API methods. ``` -------------------------------- ### Initialize Podfile Source: https://developers.liveperson.com/apple-messages-for-business-sdk-installation.html Command to create a new Podfile in the project directory. ```bash pod init ``` -------------------------------- ### Setup SDE with JSON or Dictionary Source: https://developers.liveperson.com/apple-messages-for-business-sdk-implementation.html Demonstrates setting up an SDE using either a JSON string or a Dictionary object, providing flexibility in data input. ```swift sdeBase.setupWithJson("{\"type\":\"ctmrinfo\"}") sdeBase.setupWithJson(["type":"cart"]) ``` -------------------------------- ### Messaging Window API - Overview Source: https://developers.liveperson.com/conversation-builder-bots-voice-bots.html Provides an overview of the Messaging Window API, its protocol, getting started guide, service limitations, and tutorials. ```APIDOC ## Messaging Window API ### Description Overview of the Messaging Window API, including protocol details, setup, limitations, and tutorials for common tasks like message retrieval, conversation metadata, and authentication. ### Tutorials - Get Messages - Conversation Metadata - Read and Accept Events - Authentication - Legacy - Post Conversation Survey (PCS) - Legacy - Post Conversation Survey (CSAT) - Client Properties - Avoid Websocket Headers - CoBrowse - Voice and Video Calls - File Sharing ### Samples - JavaScript Sample ``` -------------------------------- ### Messaging Window API - Overview Source: https://developers.liveperson.com/chat-agent-api-methods-retrieve-agent-survey-structure.html Provides an overview of the Messaging Window API, including protocol details, getting started guides, and limitations. ```APIDOC ## Messaging Window API ### Description Overview of the Messaging Window API, including protocol details, getting started guides, and limitations. ### Endpoints - Protocol Overview - Getting Started - Service Limitations - Tutorials (e.g., Get Messages, Conversation Metadata, Authentication) - Samples (e.g., JavaScript Sample) - API Reference (e.g., New Conversation, Close Conversation, Send CSAT) ``` -------------------------------- ### Enable Welcome Message with Quick Replies Source: https://developers.liveperson.com/mobile-app-messaging-sdk-for-android-advanced-features-welcome-message-with-quick-replies.html Use this code to set up a welcome message with predefined quick reply options. Ensure `Activity`, `LPAuthenticationParams` are correctly initialized. The `MessageOption` constructor takes display text and the value sent to the agent. ```java LPWelcomeMessage lpWelcomeMessage = new LPWelcomeMessage("Welcome Message"); ConversationViewParams conversationViewParams = new ConversationViewParams(); List optionItems = new ArrayList<>(); optionItems.add(new MessageOption("bill", "bill")); optionItems.add(new MessageOption("sales", "sales")); optionItems.add(new MessageOption("support", "support")); try { lpWelcomeMessage.setMessageOptions(optionItems); } catch (Exception e) { e.printStackTrace(); } lpWelcomeMessage.setNumberOfItemsPerRow(8); lpWelcomeMessage.setMessageFrequency(LPWelcomeMessage.MessageFrequency.EVERY_CONVERSATION); conversationViewParams.setLpWelcomeMessage(lpWelcomeMessage); LivePerson.showConversation(Activity, LPAuthenticationParams, conversationViewParams); ``` -------------------------------- ### Directory structure for running examples Source: https://developers.liveperson.com/messaging-platform-sdk-examples.html The expected file structure for running a Messaging Platform SDK example. ```text . ├── basic.js └── config.json ``` -------------------------------- ### Messaging Window API - Overview Source: https://developers.liveperson.com/apple-messages-for-business-sdk-installation.html Provides an overview of the Messaging Window API, including protocol details, getting started guides, and tutorials. ```APIDOC ## Messaging Window API ### Description This API allows for integration with the LivePerson messaging window, enabling features like sending and receiving messages, managing conversations, and handling events. ### Key Features - Real-time messaging - Conversation management - Event handling (e.g., typing indicators, read receipts) - Authentication and authorization - Survey integration ``` -------------------------------- ### Messaging Window API - Overview Source: https://developers.liveperson.com/automatic-messages-api-methods-get-automatic-messages.html Provides an overview of the Messaging Window API, including protocol details, getting started guides, service limitations, and tutorials. ```APIDOC ## Messaging Window API ### Description Overview of the Messaging Window API, covering protocol, setup, limitations, and tutorials for various functionalities like message retrieval, conversation metadata, and authentication. ### Tutorials - Get Messages - Conversation Metadata - Read and Accept Events - Authentication - Legacy - Post Conversation Survey (PCS) - Legacy - Post Conversation Survey (CSAT) - Client Properties - Avoid Websocket Headers - CoBrowse - Voice and Video Calls - File Sharing ### Samples - JavaScript Sample ``` -------------------------------- ### Engagement Window Widget SDK: How to Use the SDK Source: https://developers.liveperson.com/liveperson-functions-getting-started-monitoring.html Step-by-step guide on how to implement and use the Engagement Window Widget SDK. ```markdown ### How to Use the SDK Implement custom widgets using the Engagement Window Widget SDK with this practical guide. ```