Please note that this API relates to LivePersons legacy chat product which receives limited support and will be deprecated in the future.
It is recommended to build future integrations on top of LivePersons Messaging Window API instead.
Faster Better answers through AI
Whether you are a startup or a large enterprise, we look forward to building amazing solutions with you!
- Getting Started
- Top 10
- APIs and SDKs
-
Conversational AI
- Get Started with Automation
- Activating Features
- Videos
- Tutorials
- Trustworthy Generative AI
- Common Solutions
-
Conversation Builder
- Overview
- Generative AI
- Best Practices
- Bot Workspace
- Bots
- Bot Templates
- Bot Examples & More
- Bot Status
- Bot Accounts
- Dialogs
- Dialog Templates
- Interactions
- Assist
- Variables & Slots
- System Patterns
- Integrations
- Environment Variables
- Versions & Releases
- Global Functions
- Scripting Functions
- Testing & Deployment
- Conversational Payments
- Advanced Use Cases
- Networking & Security
- Conversation Assist
- Conversation Orchestrator
- Intent Manager
- KnowledgeAI
- Bot Analytics
-
Third-Party Bots
- Getting Started
- Bot Types
- Google Dialogflow
- Google Dialogflow ES
- Google Dialogflow CX
- IBM Watson Assistant
- Amazon Lex V2
- Amazon Lex
- Microsoft Direct Line
- LivePerson Functions
- Medallia
- Custom Endpoint
- e-bot7
- Public API
- Hook Configuration
- Conversation Tester
- Bot Status Dashboard
- Bot Conversation Errors
- Conversational AI APIs
- Messaging Agent SDK
-
Agent Experience
- Add Agent Widgets
- Agent Workspace Widget SDK
-
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
-
Client Side Configuration
- Engagement Window Customization
- Customized Chat Windows
- Engagement Window Widget SDK
-
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
- Release Notes
-
Messaging Window API
- Overview
- Protocol Overview
- Getting Started
- Service Limitations
- Tutorials
- Samples
-
API Reference
- Overview
- Get Agent Public Profile
- Request Builder
- Response Builder
- Notification Builder
- New Conversation
- Close Conversation
- Unauthenticated Messaging
- 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
-
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
-
Contact Center Management
- Agent Groups API
- Agent Survey For Messaging Configuration API
- Agent Survey For Messaging Runtime API
- Agent Status Reason API
- Automatic Messages API
- Audit Trail API
- LOBs API
- Predefined Content API
- Predefined Categories API
- Profiles API
- Shift Status API
- Skills API
- Users API
- Unified Automatic Messages API
- Special Occasions API
- Workdays API
- Developer Tools
-
Reporting
- Consumer Messaging History API
- Data Access API
- Engagement History API
- Messaging Interactions API
- Personal Data Deletion API
- Data Usage Audit API
- Agent Metrics API
- Messaging Operations API
- Operational Realtime API
- Outbound Configuration API
- Outbound Reporting API
- Key Messaging Metrics API
- Agent Activity API
- Actual Handle Time API
- Net Handle Time API
- Engagement Controller API
-
Messaging Channels
- Connector API
-
Mobile App Messaging SDK for Android
- Overview
- Quick Start
- Configure the Android SDK
- Push Notifications
-
Advanced Features
- Audio Messages
- Campaigns
- Certificate Pinning
- CSAT Behavior
- Dynamic Welcome Message
- Photo and File Sharing
- Welcome Message with Quick Replies
- Scroll Behavior Configuration
- Logging
- Voice and Video
- Offline Messaging
- Proactive and IVR Deflection to App Messaging
- Speech Recognition
- Step Up Authentication
- Multiple Consumer IDPs
- SDK APIs
- SDK Attributes
- String Localization
- Release Notes
- Resources
- Mobile App Messaging SDK for iOS
- Apple Messages for Business SDK
- Push Notification Service
- Proactive Messaging
- Connect To Messaging
- Message Routing API
- Messaging REST API
- Messaging Platform SDK
- Rich Messaging
-
Security & Authentication
- Cookies and Conversational Cloud
- Consumer Authentication
- Consumer Delegation
- Conversational Cloud Applications
- Authorizing Conversational Cloud Applications
- Login Service API
-
MTLS
- Overview
- Onboarding
- MTLS Self Service
-
Methods
- Get all certificates by account
- Upload certificate from file
- Auto generate certificate
- Collect certificate
- Activate mapping
- Get certificate by ID
- Delete certificate by ID
- P12 key tester
- Check url mapping configuration
- Forward get request
- Forward post request
- Update certificate from file
- Creating a P12 file
- Content Security Policy
- Website Monitoring
- Solutions
- Knowledge Center
- Service Status Dashboard
- Sign in
Appendix
Chat
© 2024 LivePerson Inc. All Rights Reserved Copyright Terms of Use