Sign in
Free trial
Getting Started
Getting Started with your Free Trial Account
Do More with the Conversational Cloud
Customizing the Conversational Cloud
Starting with your Concierge Bot
API Guidelines
Accessing LivePerson APIs
Create OAuth 1.0 API keys
OAuth 2.0 Client Credentials
Domain API
Data APIs
API Data Metrics
Engagement Attributes
Analytics Builder Data Metrics
Important Updates
Retry Policy Recommendations
Agent Experience
Add Agent Widgets
Add Your Own Widgets to the Agent Workspace
Agent Workspace Widget SDK
Overview
Limitations
Methods
Public Model Structure
Public Properties
Best Practices and Troubleshooting
Release Notes
Chat Agent API
Overview
Methods
Start Agent Session
Retrieve Current Availability
Set Agent Availability
Retrieve Available Agents
Retrieve Available Slots
Retrieve Agent Information
Determine Incoming Chat Request
Accept a Chat
Retrieve Chat Sessions
Retrieve Chat Resources, Events and Information
Retrieve Data for Multiple Chats
Retrieve Chat Events
Send Lines and Structured Content
End Chat
Retrieve Chat Information
Retrieve Participant Info
Retrieve Visitor's Name
Retrieve Agent's Typing Status
Set Agent's Typing Status
Retrieve Visitor's Typing Status
Retrieve Available Skills
Transfer a Chat
Retrieve Agent Survey Structure
Submit Survey Data
System Messages
Sample App
Postman Resources
Conversational AI
Platform Overview
Tutorials & Guides
Getting Started With Bot Building
Overview
Dialogs & Patterns
Intents
Integrations
Deploy the Bot
Escalate to an Agent
Bot Groups & Other Techniques
Overview
Bot Groups & Collaboration
Complex Conditions
Auto Escalation
Meta Intents & Knowledge Bases
Advanced Integrations
Implementing a Web View Integration
Using LivePerson Functions with a Bot
Using Conversation Assist
Overview
Prerequisite Steps
Configure Conversation Assist
Test Conversation Assist
Conversation Builder
Overview
Best Practices
Conversational Design
Train & Tune NLU
Prevent Consumer Interruptions
Resolve Stuck Conversations
Custom Event Logging
Reusable Components
A Pre-Launch Checklist
Bot Workspace
Bots
Custom Bots
Post-Conversation Survey Bots
Bot Basics
Bot Groups
Bot-to-Bot Transfers
Bot Templates
Overview
Global Helper Functions
Apply for a Loan
Full Lead Gen
Insurance Quote
Order Status
Simple FAQ
Simple Lead Gen
Simple Router
Store Locator
Travel Notification
Conversation Orchestrator
Dialogs
Dialog Basics
Standard Dialogs
Fallback Dialogs
Disambiguation Dialogs
Auto Escalation Dialogs
Dialog Templates
Interactions
Interaction Basics
Interaction Support
Dialog Starter
Statements
Questions
Integrations
Code
Configuration - Next Action
Configuration - Custom Code
Configuration - Settings
Troubleshooting
Assist
Variables & Slots
The Basics
Variables
Slots
System Patterns
Integrations
Integration Basics
API Integrations
Email Integrations
KnowledgeAI Integrations
LivePerson Agent Escalation Integrations
File Integrations
LivePerson Functions Integrations
Web View Integration API
Using Consumer Access Tokens
Troubleshooting
Environment Variables
Versions & Releases
Global Functions
Scripting Functions
Introduction
Functions List
Get & Set Session Data
Get User Data
Get Integration Data
Send Messages
Manage Conversation Flow
Log & Debug
Manage the Conversation Context Service
askMaven
Deprecated Functions
Testing & Deployment
Previewing
Debugging
Deploying to Conversational Cloud
Testing & Debugging Post-Deployment
Conversational Payments
Bring Your Own Payments
Apple Pay
Advanced Use Cases
Networking & Security
Conversation Assist
Overview
Recommendation Sources
Setting Up Bots
Setting Up Knowledge Bases
Configuring Settings
Testing
Agent Experience
Best Practices
Troubleshooting
FAQs
Conversation Orchestrator
Overview
Before You Begin
Conversation Context Service
Overview
Getting Started
Attributes
Methods v1
Methods v2
Dynamic Routing
Overview
Getting Started
Creating Routing Policies
Managing Routing Policies
Routing Conversations by SDEs
Routing Conversations by Intents
Routing Conversations by Channel
Advanced Routing
Using Dynamic Routing Outside of Conversational Cloud
Testing with the Web Emulator
Policy Logs for v2
Next Actions API
Overview
Methods v1
Methods v2
API Authorization
Intent Manager
Overview
Key Terms & Concepts
Getting Started
Workflows
Best Practices
FAQs
Dashboard
Natural Language Understanding
Introduction
Language Support
LivePerson NLU Engine
Google Dialogflow and IBM Watson NLU Engines
Brand's Rasa-Based NLU Engine
Discover
Intent Discovery
Topic Clustering
Build
Domains
Intents
Meta Intents
Entities
Versions
Test a Single Utterance
Test with the Model Tester
Optimize
Analyze
Basic Tasks
Intent Trends
Conversation Details
External APIs
Getting Started
Model Tester External APIs
KnowledgeAI
Overview
External Knowledge Bases
Introduction
External KBs with LivePerson AI
External KBs without LivePerson AI
Mapping Content Metadata
Writing a Transformation Specification
Best Practices
Beta - Shortening Long-Form Content
Internal Knowledge Bases
Introduction
Knowledge Bases
Articles
Best Practices
Using Intents with KBs
Sending Content to Consumers and Agents
Optimizing Your Content
Tuning a Knowledge Base
Optimizing via Dashboard Analysis
Evaluating Consumer Queries
Common Settings & Tasks
Limits
Bots Status
Overview
Managing Custom Bots
Managing Post-Conversation Survey Bots
Alerts
Bot Analytics
Overview
Account Performance
Bot Performance
Tuning Opportunities
MACS
Transcripts
Troubleshooting
Bot Accounts
Overview
Account Details
Permissions
Credentials
Third-Party Bots
Getting Started
Bot Types
Google Dialogflow
Google Dialogflow ES
Introduction
Basic Content
Advanced Features
Google Dialogflow CX
Introduction
Basic Content
Advanced Features
IBM Watson Assistant
Introduction
Basic Content
Advanced Features
Amazon Lex
Introduction
Basic Content
Advanced Features
Microsoft Direct Line
Introduction
Basic Content
Advanced Features
PVA
LivePerson Functions
Introduction
Basic Content
Advanced Features
Medallia
Introduction
Custom Endpoint
Introduction
Service Implementation
Basic Content
Advanced Features
Public API
Hook Configuration
Conversation Tester
Bot Status Dashboard
Bot Conversation Errors
Messaging Agent SDK
Overview
Methods
Events
Examples
Conversation Metadata Guide
Client Side Configuration
Customized Chat Windows
Overview
Create an API-based Window
Create an API Engagement
Appendix
Engagement Window Widget SDK
Overview
Limitations
Instructions
Configuration
How to Use the SDK
Event Structure
Code Examples
Release Notes
JavaScript Chat SDK
Overview
Chat States
Surveys
Creating an Instance
Sample App
Methods
getPreChatSurvey
getEngagement
requestChat
authenticate
addLine
setVisitorTyping
setVisitorName
endChat
requestTranscript
getExitSurvey
submitExitSurvey
cancelSurvey
getOfflineSurvey
submitOfflineSurvey
getState
getAgentLoginName
getVisitorName
getAgentId
getRtSessionId
getSessionKey
getAgentTyping
getEstimatedWaitTime
disposeVisitor
Events
onLoad
onInit
onEngagement
onPreChatSurvey
onOfflineSurvey
onVisitorDisposed
onStart
onStop
onRequestChat
onTranscript
onLine
onState
onInfo
onAgentTyping
onExitSurvey
onAccountToAccountTransfer
Release Notes
Messaging Window API
Overview
Protocol Overview
Getting Started
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
API Reference
Overview
Get Agent Public Profile
Request Builder
Response Builder
Notification Builder
New Conversation
Close Conversation
Send Consumer Satisfaction (CSAT)
Subscribe to Conversation Metadata
Unsubscribe from Conversation Metadata
Publishing Text Content
Subscribe to Messaging Events
Consumer Token Creation
Init Connection
Generate Upload URL
Generate Download URL
Messaging Window SDK
Overview
Server Chat API
Overview
Methods
Retrieve Availability
Retrieve Available Slots
Retrieve Estimated Wait Time
Retrieve Pre-Chat Survey
Retrieve Offline Survey
Post Offline Survey
Start Chat
Retrieve Chat Resources, Events and Information
Retrieve Chat Events
Add Lines / End Chat
Retrieve Chat Information
Retrieve Visitor's Name
Retrieve the Visitor's Typing Status
Retrieve the Agent's Typing Status
Set the Visitor's Typing Status
Retrieve Exit Survey Structure
Submit Survey Data
Send a Transcript
Sample Postman Collection
Window Customization API
Overview
Quick Start
Samples
CSS Sample
Taglet
Contact Center Management
Agent Groups API
Overview
Methods
Get All Agent Groups
Get Agent Groups by ID
Create Agent Groups
Update Agent Groups
Update Agent Group
Delete Agent Groups
Delete Agent Group
Appendix
Agent Survey For Messaging Configuration API
Overview
Appendix
Methods
Create Agent Survey Object
Get All Agent Survey Objects
Update Agent Survey Object
Delete Agent Survey Object
Get Agent Survey Object by ID
Agent Survey For Messaging Runtime API
Overview
Appendix
Methods
Get Agent Survey
Get Agent Survey State
Save Agent Survey State
Submit Agent Survey
Dismiss Agent Survey
Agent Status Reason API
Overview
Methods
Agent Status List
Agent Status Reason by ID
Create Status Reason
Update Status Reason
Delete Status Reason
Automatic Messages API
Overview
Methods
Get Automatic Messages
Get Automatic Message by ID
Update an Automatic Message
Audit Trail API
Introduction
Methods
Retrieve Audit Trail Records
Export Audit Trail to CSV File
LOBs API
Overview
Methods
Get all LOBs
Get LOB by ID
Create LOB
Update LOBs
Update LOB
Delete LOBs
Delete LOB
Appendix
Predefined Content API
Overview
Methods
Get Default Predefined Content by ID
Predefined Content Query Delta
Create Predefined Content
Update Predefined Content
Get Predefined Content Items
Delete Predefined Content
Get Predefined Content by ID
Delete Predefined Content Items
Get Default Predefined Content Items
Appendix
Predefined Categories API
Introduction
Methods
Categories List
Categories List by Revision
Category by ID
Categories Query Delta
Get All Changes Query
Create Category
Update Category
Delete a Category
Delete Multiple Categories
Import Account Categories
Import Categories Pre Validation
Appendix
Profiles API
Overview
Methods
Get All Profiles
Get Profile by ID
Create Profile
Update Profiles
Update Profile
Delete Profiles
Delete Profile
Appendix
Shift Status API
Overview
Methods
Get Shift Status by Account
Get Shift Status by Skill
Skills API
Overview
Methods
Get All Skills
Get Skill by ID
Create Skills
Update Skills
Update Skill
Delete Skills
Delete Skill
Appendix
Users API
Overview
Methods
Get All Users
Get User by ID
Create Users
Update Users
Update User
Delete Users
Delete User
Reset User's Password
Appendix
Unified Automatic Messages API
Overview
Methods
Get Unified Automatic Messages
Get Unified Automatic Message by ID
Update an Unified Automatic Message
Delete an Unified Automatic Message
Special Occasions API
Overview
Methods
Create Special Occasion
Update Special Occasion
Delete Special Occasion
Retrieve Special Occasion by ID
Retrieve Special Occasions by List
Appendix
Workdays API
Overview
Methods
Create Workdays Object
Update Workdays Object
Delete Workdays Object
Retrieve Workdays Object by ID
Retrieve Workdays Objects by List
Appendix
Developer Tools
LivePerson Functions
Overview
Provisioning
Getting Started
Your First Function
Development Deep Dive (UI)
Development Deep Dive (CLI)
Configuration
Monitoring
Foundations
Concepts
Features
Networking
External Invocation
Error Codes
Limitations
Best Practices
LivePerson Functions CLI
Toolbelt Documentation
Toolbelt
FaaS Context Service Client
LP Client
MTLS Client
Secret Client
Orchestrator Client
Conversation Util
GDPR Util
SDE Util
Event Sources
Overview
Automatic Messages
Post Conversation Survey (Legacy)
Conversational Commands
Third-Party Bots
Chat Post Survey
Conversation Builder
Permission System
Examples
Reporting
Consumer Messaging History API
Overview
Methods
Conversations - Content
Conversations - Metadata
Data Access API
Overview
Architecture
Methods
Base Resource
Agent Activity
Web Session
Engagement
Survey
Schema
PGP Encryption
Appendix
Engagement History API
Overview
Methods
Sample Code
Engagement Attributes
Messaging Interactions API
Overview
Methods
Conversations
Get Conversation by Conversation ID
Get Conversations by Consumer ID
Engagement Attributes
Personal Data Deletion API
Overview
Methods
Create Deletion Request
Cancel Deletion Request
Get Deletion Request
Data Usage Audit API
Overview
Methods
Retrieve Data Usage Logs
Agent Metrics API
Overview
Methods
Agent Status
Agent List
Summary
Messaging Operations API
Overview
Methods
Messaging Conversation
Messaging Queue Health
Messaging Current Queue Health
Messaging Estimated Wait Time
Messaging CSAT Distribution
Messaging Skill Segment
Messaging Agent Segment
Messaging Queue Health By Group
Appendix
Operational Realtime API
Overview
Methods
Queue Health
Engagement Activity
Agent Activity
Current Queue State
SLA Histogram
Outbound Reporting API
Overview
Key Messaging Metrics API
Overview
Methods
Metrics
Historical
Agent View
Agent Activity API
Overview
Methods
Get Status Changes
Error Codes
Actual Handle Time API
Overview
Methods
Get Agent Segments
Error Codes
Messaging Channels
Connector API
Overview
Getting Started
Connector Sample App
Send API
Overview
Authorization and Authentication
CONVERSATION
SEND
Examples
Webhooks
Overview
Events
Configuration
Notification Protocol
Retry Policy
Disclaimers
Troubleshooting
Webhooks Examples
Mobile App Messaging SDK for Android
Overview
Quick Start
Configure the Android SDK
Push Notifications
Advanced Features
Audio Messages
Campaigns
CSAT Behavior
Photo and File Sharing
Welcome Message with Quick Replies
Scroll Behavior Configuration
Logging
Voice and Video
Proactive and IVR Deflection to App Messaging
SDK APIs
Messaging API
Monitoring API
Control History APIs
Callbacks Index
Interface and Class Definitions
SDK Attributes
5.0 and above
5.0 and below
Attributes Design Sheet
String Localization
Date and Time Formats
String Values
Override SDK Strings
Plural String Resource Example
Release Notes
Latest Release Notes
All Release Notes
Resources
Authentication
Sample App
Open Source List and Dependencies
Upgrade Guide - Android
Uses-permission and Uses-feature
Mobile App Messaging SDK for iOS
Overview
Configure the iOS SDK
Push Notifications
Quick Starts
Quick Start - 6.0 and up (XCFramework support)
Advanced Features
Audio Messages
Campaigns
Certificate Pinning
CSAT Behavior
Logging
Proactive and IVR Deflection to App Messaging
Photo and File Sharing
Scroll Behavior Configuration
Unauthenticated In-App Messaging
Voice and Video
Welcome Message with Quick Replies
SDK APIs
Messaging API
Monitoring API
Control History APIs
Interface and Class Definitions
Callbacks Index
SDK Attributes
Attributes Design Sheet
Branding and Configurations
Deprecated Attributes
String Localization
Localization Keys
String Localization
Date and Time Styles
Release Notes
All Releases
Resources
About XCFrameworks
Authentication
Customizing Toast Notifications
FAQ
Open Source List
Apple Business Chat SDK
Overview
Installation
Implementation
Push Notification Service
Overview
TLS Authentication
HTTP Response Codes
Configuration
Apple Token Authentication
Push Proxy
IP Whitelisting
Proactive Messaging
API
CHANGELOG
Connect To Messaging
API
Rich Messaging
Getting Started with Rich Messaging
Introduction
Rich Messaging Channel Capabilities
Mobile SDK and Web Templates
Introduction
Card Template
Carousel Template
Quick Replies Template
Date Picker Template
Schedule Slot List Template
Multiple Checklist Template
Best Practices
Complex Layout
Limitations
Structured Content Rendering Tool
Apple Messages For Business Templates
Introduction
List Picker Template
Quick Replies Template
Time Picker Template
Apple Pay Template
Apple Auth Template
Custom Interactive Message Template
Rich Links Template
Guidelines and Limitations
Facebook Messenger Templates
Introduction
Generic Template
Button Template
Carousel Template
Quick Replies Template
Best Practices
Limitations
Google Business Messages Templates
Introduction
Card Template
Carousel Template
Quick Replies Template
Google RCS Business Messaging Templates
Introduction
Card Template
Carousel Template
Quick Replies Template
Limitations
LINE Templates
Introduction
Card Template
Carousel Template
Quick Replies Template
Limitations
WhatsApp Business Messages Templates
Introduction
Reply Button Template
List Message Template
Viber Templates
Introduction
Card Template
Carousel Template
Quick Replies Template
Limitations
Security & Authentication
Cookies and Conversational Cloud
Overview
Consumer Authentication
Introduction
Implementation Considerations
Configuration
How It Works
Detailed API
Consumer Delegation
Introduction
Configuration
How It Works
Conversational Cloud Applications
What Is a Conversational Cloud Application?
Installing Conversational Cloud Applications
Authorizing Conversational Cloud Applications
Overview
Methods
Authorization Request
Refresh Request
Token Request
Token Revocation Request
Samples
Application Login Sample App
Login Service API
Overview
Methods
User Login
Application Login
Refresh
Logout
Apple Business Chat Authentication
Overview
MTLS
Overview
Onboarding
Methods
Create certificate for account
Create certificate from file
Delete certificate by ID
Get all certificates by account
Get certificate by ID
Create certificate for account
Update certificate from file
Forward delete request
Forward get request
Forward post request
Forward put request
Check mapping configuration
P12 Key Tester
Website Monitoring
App Engagement API
Overview
Methods
Create Session
Update Session
Impression Events Body Example
Engagement Attributes
Overview
Types of Engagement Attributes
Setting up Engagement Attributes
Best Practices
Best Practices for Messaging
Engagement Attributes API
Overview
Engagement Attributes
Engagement Trigger API
Overview
Methods
Click
getEngagementInfo
getEngagementState
Web Tag
Overview
SDEs
Events
Event Binding
Events
Hooks
Hooks
New Page Refresh
Monitoring API
Overview
Getting Started
Installing a Monitoring API Application
Methods
Engagement
Report
Visit Information API
Overview
Visit Information
Solutions
CRM Integrations
Salesforce
Microsoft Dynamics
NetSuite
SugarCRM
Zendesk
Mobile App Messaging
Add Messaging to Your App
MCS Toolkit
Overview
Getting Started
Using API to Build the Toolkit
Transporter
Overview
Getting Started
Creating Report Tasks
SMS with Conversational Cloud
Overview
Clickable Mobile Content to SMS
Desktop Content Campaign
Google AdWords - Click-to-Message
SMS via Mobile App Messaging
Appendix
Video Chat
Add Video to Chat Conversations
Plan Your Service
Develop the Service
Build Your Widgets
LiveEngage MMS Viewer
Overview
Technical Description
Deployment Steps
Additional Options
Knowledge Center
Service Status Dashboard
Developer Center
Developer Tools
LivePerson Functions
Getting Started
Getting Started
Chat
Messaging
Suggest changes
Develop your first function in under 10 minutes
Dive into our webinterface
Dive into our commandline interface
