Request
JSON Output
JSON Schema
You can find the json schema definition of this message here: assets/schema/ws/consumerRequests.json
- Getting Started
- API Guidelines
-
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
-
Conversational AI
- Platform Overview
- Tutorials & Guides
- Conversation Builder
- Conversation Orchestrator
- Intent Manager
- Knowledge Base
- Bots Status
- Bot Analytics
- Bot Accounts
- Third-Party Bots
- Messaging Agent SDK
-
Client Side Configuration
- 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
- Tutorials
- Samples
-
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
-
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
-
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
-
Messaging Channels
- Connector API
- Mobile App Messaging SDK for Android
- Mobile App Messaging SDK for iOS
- Apple Business Chat SDK
- Push Notification Service
- Proactive Messaging
- Connect To Messaging
- Rich Messaging
-
Security & Authentication
- Cookies and Conversational Cloud
- Consumer Authentication
- Consumer Delegation
- Conversational Cloud Applications
- Authorizing Conversational Cloud Applications
- Login Service API
- Apple Business Chat Authentication
-
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
- Solutions
New Conversation
Messaging