Skip to content

Latest commit

 

History

History
90 lines (76 loc) · 8.35 KB

README.md

File metadata and controls

90 lines (76 loc) · 8.35 KB

Omnichannel

Manage Livechat related data:

Url HTTP Method Short Description Details Page
/api/v1/livechat/users/:type GET Get a list of agents or managers. info
/api/v1/livechat/users/:type POST Create a new omnichannel agent or manager. info
/api/v1/livechat/users/:type/:_id GET Retrieve agent or manager data. info
/api/v1/livechat/users/:type/:_id DELETE Removes an Omnichannel agent or manager. info
/api/v1/livechat/department GET Get a list of Omnichannel departments. info
/api/v1/livechat/department POST Creates a new Omnichannel department. info
/api/v1/livechat/department/:_id GET Retrieve an Omnichannel department data. info
/api/v1/livechat/department/:_id PUT Updates an Omnichannel department data. info
/api/v1/livechat/department/:_id DELETE Delete an Omnichannel department. info
/api/v1/livechat/inquiries.list GET Retrieves a list of open inquiries. info
/api/v1/livechat/inquiries.take POST Take an open inquiry. info
/api/v1/livechat/inquiries.getOne GET Get one inquiry by room id. info
/api/v1/livechat/integrations.settings GET Retrieves a list of integration settings. info
/api/v1/livechat/sms-incoming/:service POST Send SMS messages to Rocket.Chat. info
/api/v1/livechat/agent.info/:rid/:token GET Retrieve the current Omnichannel agent data. info
/api/v1/livechat/agent.next/:token GET Request the next Omnichannel agent available. info
/api/v1/livechat/agents/:agentId/departments GET Get the agent departments. info
/api/v1/livechat/config/:token GET Get basic Livechat widget configuration info and additional visitor data. info
/api/v1/livechat/custom.field POST Send an Omnichannel custom field. info
/api/v1/livechat/custom.fields POST Send an array of Omnichannel custom fields. info
/api/v1/livechat/custom-fields GET Get a list of Omnichannel custom fields. info
/api/v1/livechat/custom-fields/:_id GET Get an Omnichannel custom field. info
/api/v1/livechat/message POST Send a new Omnichannel message. info
/api/v1/livechat/message/:_id PUT Updates an Omnichannel message data. info
/api/v1/livechat/message/:_id DELETE Delete an Omnichannel message. info
/api/v1/livechat/messages.history/:rid GET Load Omnichannel messages history. info
/api/v1/livechat/office-hours GET Get a list of office hours. info
/api/v1/livechat/offline.message POST Send a new Omnichannel offline message. info
/api/v1/livechat/rooms GET Retrieves a list of Omnichannel rooms. info
/api/v1/livechat/queue GET Retrieves a list of queued chats. info
/api/v1/livechat/room GET Get the Omnichannel room data or open a new room. info
/api/v1/livechat/room.close POST Close an Omnichannel room. info
/api/v1/livechat/room.transfer POST Transfer an Omnichannel room to another agent or department. info
/api/v1/livechat/room.forward POST Allow Omnichannel Agents to forward an Omnichannel room to another agent, department, or return it back to the Queue. info
/api/v1/livechat/room.survey POST Send an Omnichannel survey to Rocket.Chat. info
/api/v1/livechat/transcript POST Request an Omnichannel transcript. info
/api/v1/livechat/triggers GET Get the Omnichannel triggers. info
/api/v1/livechat/triggers/:_id GET Get an Omnichannel trigger. info
/api/v1/livechat/video.call/:token GET Request a new video call room. info
/api/v1/livechat/visitor POST Register a new Omnichannel visitor. info
/api/v1/livechat/visitor/:token GET Retrieve a visitor's data. info
/api/v1/livechat/visitors.info GET Retrieve a visitor's info. info
/api/v1/livechat/visitors.search GET Search for Visitors. info
/api/v1/livechat/page.visited POST Send visitor navigation history to Rocket.Chat. info
/api/v1/livechat/appearance GET Get the settings about Livechat Widget Appearance. info
/api/v1/livechat/visitors.pagesVisited GET Gets the visitor navigation history. info
/api/v1/livechat/visitors.chatHistory/room/room-id/visitor/visitor-id GET Gets the visitor chat history. info

Dashboard

Agents

Url Short Description Details Page
/livechat/analytics/agents/average-service-time agent average service time Info
/livechat/analytics/agents/total-service-time agent total service time Info
/livechat/analytics/agents/available-for-service-history ## Info

Departments

Url Short Description Details Page
/livechat/analytics/departments/ammount-of-chats amount of chats Info
/livechat/analytics/departments/average-service-time average service time [Link] (#)
/livechat/analytics/departments/average-chat-duration-time average chats duration Info
/livechat/analytics/departments/total-service-time total service time Info
/livechat/analytics/departments/average-waiting-time avg waiting time Info
/livechat/analytics/departments/total-transferred-chats total transferred chats Info
/livechat/analytics/departments/total-abandoned-chats total abandoned chats Info
/livechat/analytics/departments/percentage-abandoned-chats percentage of abandoned chats Info

Livechat

Url Short Description Details Page
/api/v1/livechat/inquiries.list Retrieves a list of open inquiries. Link
/api/v1/livechat/inquiries.take Take an open inquiry. Link
/api/v1/livechat/rooms Retrieves a list of livechat rooms. Link