Unverified Commit 1f66f2c7 authored by Faria Masood's avatar Faria Masood Committed by gitbook-bot

GitBook: [master] 2 pages modified

parent af26d26f
......@@ -497,7 +497,7 @@
* [Messages](api/rest-api/methods/im/messages.md)
* [Open](api/rest-api/methods/im/open.md)
* [Set Topic](api/rest-api/methods/im/settopic.md)
* [Omnichannel \(Livechat\)](api/rest-api/methods/livechat/README.md)
* [Omnichannel](api/rest-api/methods/livechat/README.md)
* [Average chat duration by department](api/rest-api/methods/livechat/average-chat-duration-by-department.md)
* [Total service time by department](api/rest-api/methods/livechat/total-service-time-by-department.md)
* [Average waiting time by department](api/rest-api/methods/livechat/average-waiting-time-by-department.md)
......
# Omnichannel \(Livechat\)
# 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](users.md#list-agents-or-managers) |
| `/api/v1/livechat/users/:type` | `POST` | Create a new Livechat agent or manager. | [info](users.md#register-new-agent-or-manager) |
| `/api/v1/livechat/users/:type` | `POST` | Create a new omnichannel agent or manager. | [info](users.md#register-new-agent-or-manager) |
| `/api/v1/livechat/users/:type/:_id` | `GET` | Retrieve agent or manager data. | [info](users.md#get-info-about-an-agent-or-manager) |
| `/api/v1/livechat/users/:type/:_id` | `DELETE` | Removes a Livechat agent or manager. | [info](users.md#removes-an-agent-or-manager) |
| `/api/v1/livechat/department` | `GET` | Get a list of Livechat departments. | [info](department.md#list-departments) |
| `/api/v1/livechat/department` | `POST` | Creates a new Livechat department. | [info](department.md#register-a-new-department) |
| `/api/v1/livechat/department/:_id` | `GET` | Retrieve a Livechat department data. | [info](department.md#get-info-about-a-department) |
| `/api/v1/livechat/department/:_id` | `PUT` | Updates a Livechat department data. | [info](department.md#update-a-department) |
| `/api/v1/livechat/department/:_id` | `DELETE` | Delete a Livechat department. | [info](department.md#removes-a-department) |
| `/api/v1/livechat/users/:type/:_id` | `DELETE` | Removes an Omnichannel agent or manager. | [info](users.md#removes-an-agent-or-manager) |
| `/api/v1/livechat/department` | `GET` | Get a list of Omnichannel departments. | [info](department.md#list-departments) |
| `/api/v1/livechat/department` | `POST` | Creates a new Omnichannel department. | [info](department.md#register-a-new-department) |
| `/api/v1/livechat/department/:_id` | `GET` | Retrieve an Omnichannel department data. | [info](department.md#get-info-about-a-department) |
| `/api/v1/livechat/department/:_id` | `PUT` | Updates an Omnichannel department data. | [info](department.md#update-a-department) |
| `/api/v1/livechat/department/:_id` | `DELETE` | Delete an Omnichannel department. | [info](department.md#removes-a-department) |
| `/api/v1/livechat/inquiries.list` | `GET` | Retrieves a list of open inquiries. | [info](inquiries.md) |
| `/api/v1/livechat/inquiries.take` | `POST` | Take an open inquiry. | [info](inquiries.md#livechat-take-inquiry) |
| `/api/v1/livechat/inquiries.getOne` | `GET` | Get one inquiry by room id. | [info](inquiries.md#livechat-get-one-inquiry-by-room-id) |
| `/api/v1/livechat/integrations.settings` | `GET` | Retrieves a list of integration settings. | [info](integrations-settings.md) |
| `/api/v1/livechat/sms-incoming/:service` | `POST` | Send SMS messages to Rocket.Chat. | [info](sms-incoming.md) |
| `/api/v1/livechat/agent.info/:rid/:token` | `GET` | Retrieve the current Livechat agent data. | [info](agent.md) |
| `/api/v1/livechat/agent.next/:token` | `GET` | Request the next Livechat agent available. | [info](agent.md#request-the-next-livechat-agent-available) |
| `/api/v1/livechat/agent.info/:rid/:token` | `GET` | Retrieve the current Omnichannel agent data. | [info](agent.md) |
| `/api/v1/livechat/agent.next/:token` | `GET` | Request the next Omnichannel agent available. | [info](agent.md#request-the-next-livechat-agent-available) |
| `/api/v1/livechat/agents/:agentId/departments` | `GET` | Get the agent departments. | [info](agent.md#get-agent-departments) |
| `/api/v1/livechat/config/:token` | `GET` | Get basic Livechat widget configuration info and additional visitor data. | [info](config.md) |
| `/api/v1/livechat/custom.field` | `POST` | Send a Livechat custom field. | [info](custom-fields.md#send-a-livechat-custom-field) |
| `/api/v1/livechat/custom.fields` | `POST` | Send an array of Livechat custom fields. | [info](custom-fields.md#send-an-array-of-livechat-custom-fields) |
| `/api/v1/livechat/custom-fields` | `GET` | Get a list of Livechat custom fields. | [info](custom-fields.md#list-livechat-custom-fields) |
| `/api/v1/livechat/custom-fields/:_id` | `GET` | Get a Livechat custom field. | [info](custom-fields.md#get-info-about-a-custom-field) |
| `/api/v1/livechat/message` | `POST` | Send a new Livechat message. | [info](message.md) |
| `/api/v1/livechat/message/:_id` | `PUT` | Updates a Livechat message data. | [info](message.md#updates-a-livechat-message) |
| `/api/v1/livechat/message/:_id` | `DELETE` | Delete a Livechat message. | [info](message.md#removes-a-livechat-message) |
| `/api/v1/livechat/messages.history/:rid` | `GET` | Load Livechat messages history. | [info](message.md#load-livechat-messages-history) |
| `/api/v1/livechat/custom.field` | `POST` | Send an Omnichannel custom field. | [info](custom-fields.md#send-a-livechat-custom-field) |
| `/api/v1/livechat/custom.fields` | `POST` | Send an array of Omnichannel custom fields. | [info](custom-fields.md#send-an-array-of-livechat-custom-fields) |
| `/api/v1/livechat/custom-fields` | `GET` | Get a list of Omnichannel custom fields. | [info](custom-fields.md#list-livechat-custom-fields) |
| `/api/v1/livechat/custom-fields/:_id` | `GET` | Get an Omnichannel custom field. | [info](custom-fields.md#get-info-about-a-custom-field) |
| `/api/v1/livechat/message` | `POST` | Send a new Omnichannel message. | [info](message.md) |
| `/api/v1/livechat/message/:_id` | `PUT` | Updates an Omnichannel message data. | [info](message.md#updates-a-livechat-message) |
| `/api/v1/livechat/message/:_id` | `DELETE` | Delete an Omnichannel message. | [info](message.md#removes-a-livechat-message) |
| `/api/v1/livechat/messages.history/:rid` | `GET` | Load Omnichannel messages history. | [info](message.md#load-livechat-messages-history) |
| `/api/v1/livechat/office-hours` | `GET` | Get a list of office hours. | [info](office-hours.md) |
| `/api/v1/livechat/offline.message` | `POST` | Send a new Livechat offline message. | [info](message.md#send-a-new-livechat-offline-message) |
| `/api/v1/livechat/rooms` | `GET` | Retrieves a list of livechat rooms. | [info](rooms.md) |
| `/api/v1/livechat/offline.message` | `POST` | Send a new Omnichannel offline message. | [info](message.md#send-a-new-livechat-offline-message) |
| `/api/v1/livechat/rooms` | `GET` | Retrieves a list of Omnichannel rooms. | [info](rooms.md) |
| `/api/v1/livechat/queue` | `GET` | Retrieves a list of queued chats. | [info](queue.md) |
| `/api/v1/livechat/room` | `GET` | Get the Livechat room data or open a new room. | [info](room.md) |
| `/api/v1/livechat/room.close` | `POST` | Close a Livechat room. | [info](room.md#close-livechat-room) |
| `/api/v1/livechat/room.transfer` | `POST` | Transfer a Livechat room to another agent or department. | [info](room.md#transfer-livechat-room) |
| `/api/v1/livechat/room.forward` | `POST` | Allow Livechat Agents to forward a Livechat room to another agent, department or return it back to the Queue. | [info](room.md#forward-livechat-room) |
| `/api/v1/livechat/room.survey` | `POST` | Send a Livechat survey to Rocket.Chat. | [info](room.md#send-the-livechat-survey) |
| `/api/v1/livechat/transcript` | `POST` | Request a Livechat transcript. | [info](transcript.md) |
| `/api/v1/livechat/triggers` | `GET` | Get the Livechat triggers. | [info](triggers.md) |
| `/api/v1/livechat/triggers/:_id` | `GET` | Get a Livechat trigger. | [info](triggers.md) |
| `/api/v1/livechat/room` | `GET` | Get the Omnichannel room data or open a new room. | [info](room.md) |
| `/api/v1/livechat/room.close` | `POST` | Close an Omnichannel room. | [info](room.md#close-livechat-room) |
| `/api/v1/livechat/room.transfer` | `POST` | Transfer an Omnichannel room to another agent or department. | [info](room.md#transfer-livechat-room) |
| `/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](room.md#forward-livechat-room) |
| `/api/v1/livechat/room.survey` | `POST` | Send an Omnichannel survey to Rocket.Chat. | [info](room.md#send-the-livechat-survey) |
| `/api/v1/livechat/transcript` | `POST` | Request an Omnichannel transcript. | [info](transcript.md) |
| `/api/v1/livechat/triggers` | `GET` | Get the Omnichannel triggers. | [info](triggers.md) |
| `/api/v1/livechat/triggers/:_id` | `GET` | Get an Omnichannel trigger. | [info](triggers.md) |
| `/api/v1/livechat/video.call/:token` | `GET` | Request a new video call room. | [info](video-call.md) |
| `/api/v1/livechat/visitor` | `POST` | Register a new Livechat visitor. | [info](visitor.md) |
| `/api/v1/livechat/visitor/:token` | `GET` | Retrieve a visitor data. | [info](visitor.md) |
| `/api/v1/livechat/visitors.info` | `GET` | Retrieve a visitor info. | [info](visitor.md) |
| `/api/v1/livechat/visitor` | `POST` | Register a new Omnichannel visitor. | [info](visitor.md) |
| `/api/v1/livechat/visitor/:token` | `GET` | Retrieve a visitor's data. | [info](visitor.md) |
| `/api/v1/livechat/visitors.info` | `GET` | Retrieve a visitor's info. | [info](visitor.md) |
| `/api/v1/livechat/visitors.search` | `GET` | Search for Visitors. | [info](visitor.md#search-for-visitors) |
| `/api/v1/livechat/page.visited` | `POST` | Send visitor navigation history to Rocket.Chat. | [info](visitor.md#send-visitor-navigation-history) |
| `/api/v1/livechat/appearance` | `GET` | Get the settings about Livechat Widget Appearance. | [info](appearance.md) |
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment