X2(latest version)
X(legacy version)
X2(latest version)
Contents
x
Getting Started
Guides
Apps
Server API (Restful) Reference
Visitor Side API (JavaScript) Reference
Partner API Reference
Powered by
LiveChat
29 Articles
in this category
Share this
Print
Share
Dark
Light
Contents
LiveChat
29 Articles
in this category
Share
Dark
Light
Agent Private Message
Agent Private Message Agent Private Messages - Agent Private Messages Manage POST livechat/agentPrivateMessages:Search - Search Agent Private Messages Agent Private Message JSON Format Agent Private Message is represented as s...
Updated on : 28 Jul 2022
Audio & Video Chat
Audio & Video Chat You need the Manage Settings permission to manage Audio & Video Chat. Audio & Video Chat - Audio & Video Chat Manage GET livechat/audioVideoChatConfig - Get a single Audio & Video Chat POST li...
Updated on : 16 Jun 2022
Auto Distribution
Auto Distribution You need the Manage Settings permission to manage Auto Distrubution Auto Distribution - Auto Distribution Manage GET livechat/autoDistributionConfig - Get the Auto Distribution Configurations POST livechat/autoDis...
Updated on : 09 Oct 2024
Auto Invitation
Auto Invitation You need the Manage Campaigns Form permission to manage Auto Invitation. Auto Invitations - Auto Invitations Manage GET livechat/autoInvitations - Get the list of Auto Invitations GET livechat/autoInvitations/{id} ...
Updated on : 28 Jul 2022
Banned Visitor
Banned Visitor You need the Manage Ban List to manage Banned Visitors. Banned Visitors - Banned Visitors Manage GET livechat/bannedVisitors - Get the list of Banned Visitors GET livechat/bannedVisitors/{id} - Get a single Banned ...
Updated on : 21 Jun 2022
Banned IP
Banned IP You need the Manage Ban List permission to manage Banned Ip. Banned IPs - Banned IPs Manage GET livechat/bannedIps - Get the list of Banned IPs GET livechat/bannedIps/{id} - Get a single Banned IP POST livechat/bann...
Updated on : 16 Jun 2022
Campaign
Campaign You need the Manage Campaigns permission to manage Campaign. Campaigns - Campaigns Manage GET livechat/campaigns - Get the list of Campaigns GET livechat/campaigns/{id} - Get a single Campaign POST livechat/campaigns...
Updated on : 05 Dec 2023
Chat
Chats - Chats Manage GET livechat/chats/{id} - Get a single Chat POST livechat/chats/{id}:AttachToTicket - Attach to Ticket POST livechat/chats:Search - Search Chats POST livechat/missedAndRefusedChats:Search - Search Mis...
Updated on : 12 Jan 2024
Custom Variable
Custom Variable You need the Manage Custom Variables to manage Custom Variables. Custom Variables - Custom Variables Manage GET livechat/customVariables - Get the list of Custom Variables GET livechat/customVariables/{id} - Get a...
Updated on : 16 Jun 2022
Custom Variable Config
Custom Variable Config You need the Manage Custom Variables permission to manage Custom Variable Config. Custom Variable Configs - Custom Variable Configs Manage GET livechat/customVariableConfig - Get a single Custom Variable Config ...
Updated on : 16 Jun 2022
Chat Server
Chat Server Chat Server - Chat Server Manage GET livechat/agents - Get status for the list of agents GET livechat/agents/{id} - Get status for an agent PUT livechat/agents/{id} - Update status for an agent GET livechat/vi...
Updated on : 16 Jun 2022
Conversion Action
Conversion Action You need the Manage Settings permission to Manage Conversion. Conversion Actions - Conversion Actions Manage GET livechat/conversionActions - Get the list of Conversion Actions GET livechat/conversionActions/{id} ...
Updated on : 05 Dec 2023
Dynamic Campaign
Dynamic Campaign Dynamic Campaigns - Dynamic Campaigns Manage GET livechat/dynamicCampaignConfig - Get a single Dynamic Campaign PUT livechat/dynamicCampaignConfig - Update the Dynamic Campaign Dynamic Campaign Rules - Dyn...
Updated on : 25 Jul 2022
Field
Field You need the Manage Fields permission to manage Fields. Fields - Fields Manage GET livechat/fields - Get the list of Fields GET livechat/fields/{id} - Get a single Field POST livechat/fields - Create a new Field P...
Updated on : 25 Jul 2022
Installation
Installation You need the Manage campaigns permission to get live chat code. Installations - Installations Manage GET livechat/campaigns/{id}/installation - Installation Code Installation JSON Format Installation is represen...
Updated on : 28 Jul 2022
Integration Calendly
Integration Calendly Integration Calendlys - Integration Calendlys Manage GET livechat/integrationCalendlys - Get the list of Integration Calendlys GET livechat/integrationCalendlys/{id} - Get a single Integration Calendly POST...
Updated on : 16 Jun 2022
Offline Message
Offline Message You need the Delete Transcripts permission to delete Offline Messages. Offline Messages - Offline Messages Manage GET livechat/offlineMessages/{id} - Get a single Offline Message POST livechat/offlineMessages/{id}:A...
Updated on : 28 Jul 2022
Real Time
Real Time Real Time - Real Time Manage GET livechat/realTime/Agents - Get agents status GET livechat/realTime/Queue - Get chat queue status GET livechat/realTime/Today - Get today's status GET livechat/realTime/RightNow ...
Updated on : 17 Feb 2023
Segment
Segment You need the Manage Settings permission to manage Segment. Segments - Segments Manage GET livechat/segments - Get the list of Segments GET livechat/segments/{id} - Get a single Segment POST livechat/segments - Creat...
Updated on : 28 Jul 2022
Segment Config
Segment Config You need the Manage Settings permission to manage segment config. Segment Config - Segment Config Manage GET livechat/segmentConfig - Get a single Segment Config POST livechat/segmentConfig:disable - Disable the Se...
Updated on : 16 Jun 2022
Secure Forms
Secure Forms Obsolete, will be removed in the future, please refer to new API .
Updated on : 21 Aug 2024
Screen Sharing Config
Screen Sharing Config You need the Manage Settings permission to manage screen sharing config. Screen Sharing Config - Screen Sharing Config Manage GET livechat/screenSharingConfig - Get a single Screen Sharing Config POST livechat...
Updated on : 05 Dec 2023
Shift
Shift You need the Manage Settings permission to manage Shifts. Shifts - Shifts Manage GET livechat/shifts - Get the list of Shifts GET livechat/shifts/{id} - Get a single Shift POST livechat/shifts - Create a new Shift ...
Updated on : 16 Jun 2022
Shift Config
Shift Config You need the Manage Settings permission to manage shift config. Shift Config - Shift Config Manage GET livechat/shiftConfig - Get a single Shift Config POST livechat/shiftConfig:disable - Disable the Shift Config ...
Updated on : 16 Jun 2022
Visitor History
Visitor History Visitor Histories - Visitor Histories Manage GET livechat/visitorHistory:Search - Search Visitor Histories DELETE livechat/visitorHistory - Delete Visitor History Visitor History JSON Format Visitor Histo...
Updated on : 28 Jul 2022
Visitor Single Sign-On (SSO)
Visitor Single Sign-On (SSO) You need the Manage Settings permission to manage visitor sso config. Visitor Single Sign-On (SSO) - Visitor Single Sign-On (SSO) Manage GET livechat/visitorSsoConfig - Get a single Visitor Single Sign On ...
Updated on : 29 Nov 2022
Webhook
Webhook You need the Manage Integration permission to manage Webhook. Webhooks - Webhooks Manage GET livechat/webhooks - Get the list of Webhooks GET livechat/webhooks/{id} - Get a single Webhook POST livechat/webhooks - Cr...
Updated on : 16 Jun 2022
Wrapup Category Config
Wrapup Category Config You need the Manage Campaigns permission to manage Wrapup Category Config. Wrapup Category Configs - Wrapup Category Configs Manage GET livechat/wrapupCategoryConfig - Get a single Wrapup Category Config PUT ...
Updated on : 28 Jul 2022
Wrap-Up Field
Wrap-Up Field You need the Manage Campaigns permission to manage Wrap-Up Form Field. Wrap-Up Fields - Wrap-Up Fields Manage GET livechat/wrapupFormFields - Get the list of Wrap-Up Fields GET livechat/wrapupFormFields/{id} - Get a...
Updated on : 16 Jun 2022