WebsiteCommunityUser Documentation Free Trial
Search…
⌃K
Links

Omnichannel Endpoints

Agent

Url
Short Description
Details Page
api/v1/livechat/agents/:agentId/departments
Returns all the departments associated with an agent
​Link​
api/v1/livechat/analytics/agents/average-service-time
Retrieves average service time per agent
​Link​
api/v1/livechat/analytics/agents/total-service-time
Retrieves total service time sorted by agent
​Link​
api/v1/livechat/analytics/agents/available-for-service-history
Retrieves a list of agents and their available time for the provided time frame
​Link​

Livechat Appearance

Url
Short Description
Details Page
api/v1/livechat/appearance
Retrieves LiveChat widget settings about appearance
​Link​

Business Hours

Url
Short Description
Details Page
api/v1/livechat/business-hour
Retrieves all the information of a particular business hour
​Link​
api/v1/livechat/business-hours.list
Retrieves a list of existing business hours
​Link​

Dashboards

Url
Short Description
Details Page
api/v1/livechat/analytics/dashboards/conversation-totalizers
Retrieves conversation totalizers for a department
​Link​
api/v1/livechat/analytics/dashboards/agents-productivity-totalizers
Retrieves agent productivity totalizer for a department
​Link​
api/v1/livechat/analytics/dashboards/chats-totalizers
Retrieves chat totalizers for a department
​Link​
api/v1/livechat/analytics/dashboards/productivity-totalizers
Retrieves productivity totalizers for a department
​Link​
api/v1/livechat/analytics/dashboards/charts/chats
Retrieves chats chat for a department
​Link​
api/v1/livechat/analytics/dashboards/charts/chats-per-agent
Retrieves chats per agent for a department chart
​Link​
api/v1/livechat/analytics/dashboards/charts/agents-status
Retrieves agent's statuses chart
​Link​
api/v1/livechat/analytics/dashboards/charts/chats-per-department
Retrieves chats per department chart
​Link​
api/v1/livechat/analytics/dashboards/charts/timings
Retrieves timing charts
​Link​

Departments

Url
Short Description
Details Page
api/v1/livechat/department
Retrieves a list of departments
​Link​
api/v1/livechat/department
Registers a new department
​Link​
api/v1/livechat/department/:_id
Retrieves a department's info
​Link​
api/v1/livechat/department/:_id
Updates a department
​Link​
api/v1/livechat/department/:_id
Removes a department
​Link​
api/v1/livechat/department.autocomplete
Autocompletes department name
​Link​
api/v1/livechat/department/:departmentId/agents
Retrieves agents of a specific department
​Link​
api/v1/livechat/department/:departmentId/agents
Updates agents of a department
​Link​
api/v1/livechat/department.listByIds
Retrieves a list of departments by an array of department ids
​Link​
api/v1/livechat/departments.available-by-unit/:unitId
Retrieves departments available by unit Id
​Info​
api/v1/livechat/analytics/departments/amount-of-chats
Retrieves the number of incoming chats
​Info​
api/v1/livechat/analytics/departments/average-service-time
Retrieves average service time
​Info​
api/v1/livechat/analytics/departments/average-chat-duration-time
Retrieves average chats duration
​Info​
api/v1/livechat/analytics/departments/total-service-time
Retrieves total service time
​Info​
api/v1/livechat/analytics/departments/average-waiting-time
Retrieves avg waiting time
​Info​
api/v1/livechat/analytics/departments/total-transferred-chats
Retrieves total transferred chats
​Info​
api/v1/livechat/analytics/departments/total-abandoned-chats
Retrieves abandoned chats
​Info​
api/v1/livechat/analytics/departments/percentage-abandoned-chats
Retrieves percentage of abandoned chats
​Info​

Inquiries

Url
Short Description
Details Page
api/v1/livechat/inquiries.list
Lists all of the open livechat inquiries
​Link​
api/v1/livechat/inquiries.take
Takes an open inquiry
​Link​
api/v1/livechat/inquiries.queued
Lists queued inquiries
​Link​
api/v1/livechat/inquiries.getOne
Gets one inquiry by room id
​Link​
api/v1/livechat/inquiry.prioritize
Sets the priority of an inquiry
​Link​

Integrations

Url
Short Description
Details Page
api/v1/livechat/integrations.settings
Retrieves a list of integration settings
​Link​

Queue

Url
Short Description
Details Page
api/v1/livechat/queue
Retrieves the queued chats
​Link​

Rooms

Url
Short Description
Details Page
api/v1/livechat/rooms
Retrieves a list of livechat rooms
​Link​
api/v1/livechat/room.onHold
Puts an active livechat conversation on hold
​Link​

SMS

Url
Short Description
Details Page
api/v1/livechat/sms-incoming/:service
Receives SMS
​Link​

Triggers

Url
Short Description
Details Page
api/v1/livechat/triggers
Lists all Livechat triggers
​Link​
api/v1/livechat/triggers/:_id
Retrieves a Livechat Trigger by id
​Link​

Upload

Url
Short Description
Details Page
api/v1/livechat/upload/:rid
post
​

Users

Url
Short Description
Details Page
api/v1/livechat/users/:type
Gets a list of agents or managers
​Link​
api/v1/livechat/users/:type
Registers a new agent or manager
​Link​
api/v1/livechat/users/:type/:_id
Gets info about an agent or manager
​Link​
api/v1/livechat/users/:type/:_id
Removes an agent or manager
​Link​

Visitors

Url
Short Description
Details Page
api/v1/livechat/visitors.info
Retrieves visitor info by ID
​Link​
api/v1/livechat/visitors.pagesVisited/:roomId
Retrieves pages visited by livechat visitor
​Link​
api/v1/livechat/visitors.chatHistory/room/:roomId/visitor/:visitorId
Retrieves livechat visitor's chat history
​Link​
api/v1/livechat/visitors.searchChats/room/:roomId/visitor/:visitorId
Searches a visitor's chat
​Link​
api/v1/livechat/visitors.autocomplete
Autocompletes visitor's name
​Link​
api/v1/livechat/visitors.search
Searches the visitor by the term
​Link​

Monitors

Url
Short Description
Details Page
api/v1/livechat/monitors.list
Retrieves a list of monitors
​Link​
api/v1/livechat/monitors.getOne
Gives the details of a monitor
​Link​

Priorities

Url
Short Description
Details Page
api/v1/livechat/priorities
Gives a list of priorities
​Link​
api/v1/livechat/priorities/:priorityId
Gives the details of a priority
​Link​

Livechat Tags

Url
Short Description
Details Page
api/v1/livechat/tags
Retrieves a list of tags
​Link​
api/v1/livechat/tags.getOne
Retrieves details of a tag
​Link​

Units

Url
Short Description
Details Page
api/v1/livechat/units
Create unit
​Link​
api/v1/livechat/units.list
Gives a list of units
​Link​
api/v1/livechat/units.getOne
Retrieves details of a unit
​Link​
api/v1/livechat/unitMonitors.list
Gives a list of unit monitors
​Link​
api/v1/livechat/unitMonitors.list/:id
Update Unit by Id
​Link​
api/v1/livechat/unitMonitors.list/:id
Delete unit using ID
​Link​
Previous
Set visitor status
Next
Agents
Last modified 20d ago