Unverified Commit 7d2643a4 authored by Andres Mauricio Arrieta Afanador's avatar Andres Mauricio Arrieta Afanador Committed by gitbook-bot
Browse files

GitBook: [master] 622 pages modified

parent 7e31723c
......@@ -482,6 +482,7 @@
* [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)
* [Agents available for service time](api/rest-api/methods/livechat/agents-available-for-service-time.md)
* [Agent Info](api/rest-api/methods/livechat/agent.md)
* [Appearance](api/rest-api/methods/livechat/appearance.md)
* [Config](api/rest-api/methods/livechat/config.md)
......
......@@ -51,4 +51,49 @@ Manage Livechat related data:
| `/api/v1/livechat/appearance` | `GET` | Get the settings about Livechat Widget Appearance. | [info](appearance.md) |
| `/api/v1/livechat/visitors.pagesVisited` | `GET` | Gets the visitor navigation history. | [info](visitor.md#get-the-visitor-navigation-history) |
| `/api/v1/livechat/visitors.chatHistory/room/room-id/visitor/visitor-id` | `GET` | Gets the visitor chat history. | [info](visitor.md#get-the-visitor-chat-history) |
| | | | |
#### dashboard
| Url | Short Description | Details Page |
| :--- | :--- | :--- |
| `/livechat/analytics/dashboard/conversation-totalizers` | conversation totalizer | \[Link\] \(\#\) |
| `/livechat/analytics/dashboard/agent-productivity-totalizers` | agent productivity totalizers | Link |
| `/livechat/analytics/dashboard/chats-totalizers` | chats totalizers | Link |
| `/livechat/analytics/dashboard/charts/chats` | chats chart | Link |
| `/livechat/analytics/dashboard/charts/chats-per-agent` | chats per agent chart | Link |
| \`/livechat/analytics/dashboard/charts/agents-status | agent status chart | Link |
| `/livechat/analytics/dashboard/charts/chats-per-department` | chats per department chart | Link |
| `/livechat/analytics/dashboard/charts/timings` | timings | Link |
#### Agents
| Url | Short Description | Details Page |
| :--- | :--- | :--- |
| `/livechat/analytics/agents/average-service-time` | agent average service time | \[Link\] \(\#\) |
| `/livechat/analytics/agents/total-service-time` | agent total service time | Link |
| `/livechat/analytics/agents/available-for-service-history` | \#\# | Link |
#### Departments
| Url | Short Description | Details Page |
| :--- | :--- | :--- |
| `/livechat/analytics/departments/ammount-of-chats` | ammount of chats | \[Link\] \(\#\) |
| `/livechat/analytics/departments/average-service-time` | average service time | \[Link\] \(\#\) |
| `/livechat/analytics/departments/average-chat-duration-time` | average chats duration | \[Link\] \(\#\) |
| `/livechat/analytics/departments/total-service-time` | total service time | \[Link\] \(\#\) |
| `/livechat/analytics/departments/average-waiting-time` | avg waiting time | \[Link\] \(\#\) |
| `/livechat/analytics/departments/total-transferred-chats` | total transferred chats | \[Link\] \(\#\) |
| `/livechat/analytics/departments/total-abandoned-chats` | total abandoned chats | \[Link\] \(\#\) |
| `/livechat/analytics/departments/percentage-abandoned-chats` | percentage of abandoned chats | \[Link\] \(\#\) |
#### Livechat
| Url | Short Description | Details Page |
| :--- | :--- | :--- |
| `/api/v1/livechat/inquiries.list` | Retrieves a list of open inquiries. | [Link](methods/livechat/inquiries.md#inquiries-list) |
| `/api/v1/livechat/inquiries.take` | Take an open inquiry. | [Link](methods/livechat/inquiries.md#livechat-take-inquiry) |
| `/api/v1/livechat/rooms` | Retrieves a list of livechat rooms. | [Link](methods/livechat/rooms.md) |
---
description: Return the list of agents and their available time for the provided time frame
---
# Agents available for service time
| URL | Requires Auth | HTTP Method |
| :--- | :--- | :--- |
| `api/v1/livechat/analytics/agents/available-for-service-history` | `YES` | `GET` |
### Headers
| Argument | Example | Required | Description |
| :--- | :--- | :--- | :--- |
| `X-User-Id` | `myuser-name` | Required | Your username hash \(returned after you log in through the API\) |
| `X-Auth-Token` | `myauth-token` | Required | Your token \(returned after you log in through the API\) |
### Parameters
| Argument | Example | Required | Description |
| :--- | :--- | :--- | :--- |
| `start` | `2020-09-09T00:11:22.345Z` | Required | start date |
| `end` | `2020-09-10T23:59:22.345Z` | Required | end date |
#### Notes
* \*\* The API will return a blank page if the correct headers are not sent
### Example Call
```bash
curl --location --request GET 'http://localhost:3000/api/v1/livechat/analytics/agents/available-for-service-history?start=2020-09-09T00:11:22.345Z&end=2020-09-10T23:59:22.345Z' \
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'
```
### Result
```javascript
{
"agents": [
{
"availableTimeInSeconds": 102117,
"username": "andres.mauricio"
},
{
"availableTimeInSeconds": 280,
"username": "bruna.martins"
},
{
"availableTimeInSeconds": 40242,
"username": "marina"
},
{
"availableTimeInSeconds": 1,
"username": "rogerio"
}
],
"count": 4,
"offset": 0,
"total": 4,
"success": true
}
```
### Change Log
......@@ -35,7 +35,7 @@ Building Rocket.Chat code requires a minimum of 8 GB of RAM memory on the Linux
1. Open a **WSL 2 shell** \(not Powershell\). Update Linux `sudo apt-get update sudo apt-get dist-upgrade`
2. Install tools required
`sudo apt-get install build-essential git curl`
`sudo apt-get build-essential git curl python-minimal`
3. Install meteor
......@@ -67,7 +67,7 @@ Building Rocket.Chat code requires a minimum of 8 GB of RAM memory on the Linux
When the server is ready, you will see a box with "Server Running" title:
![](../../.gitbook/assets/image%20%2823%29.png)
![](../../.gitbook/assets/apprun.png)
This means that a Rocket.Chat server is running from your computer. To access the server, use Chrome, Brave, or Firefox browser, and navigate to
......
......@@ -54,7 +54,7 @@ From here scroll to the bottom and toggle encrypted on
### How can I tell if the room is encrypted?
If the room is using End to End Encryption you should see a key icon in the top right next to the other icons. If you hold your mouse over the icon, you will see the text "E2E Enabled".
If the room is using End to End Encryption you should see a key icon by the channel name.
![ ](../../.gitbook/assets/e2e-keybychannel.png)
......@@ -63,3 +63,4 @@ If the room is using End to End Encryption you should see a key icon in the top
You will see a key icon by the username.
![ ](../../.gitbook/assets/e2e-keybymessage.png)
......@@ -8,15 +8,13 @@ Our position:
Rocket.Chat is built to be an open and free communication platform. We want everyone to be able to run it and use our platform freely and to improve people's lives. Today, our platform is used for myriads of different purposes, according to how our users deem it fit for their purposes.
We also do not want to be the judges on what constitutes the “right” way to use Rocket.Chat. Moral values differ from person to person and laws often collide over highly debated issues such as free speech. We believe the users of Rocket.Chat know best how to use our platform to their and everyone else's benefit.
We also do not want to be the judges on what constitutes the “right” way to use Rocket.Chat. Moral values differ from person to person and laws often collide over highly debated issues such as free speech. We believe the users of Rocket.Chat know best how to use our platform to their benefit.
### How does Rocket.Chat deal with reports of illegal content?
Sometimes, our organization receives a request from a law enforcement body with the aim to produce a certain set of user data to aid in a criminal investigation. Or there might be a request to take down content that has been deemed illegal. We treat these requests very carefully and - where we are able and obliged to help - bring this to the attention of the administrator of the instance. Oftentimes, we cannot do anything though.
That is because we have no way to access or control self-managed Rocket.Chat servers. Self-managed means that Rocket.Chat is installed on a server we do not own. Our platform is open source and has no backdoors or whatsoever to allow us to remotely access your installations.
In case of Rocket.Chat instances hosted by us for others, we forward reports to the respective administrator and if determined an obvious breach of terms of service we can terminate the hosting. Where the request is about content on a server directly under our control, such as our Open Server, you can contact us directly under [legal@rocket.chat](mailto:legal@rocket.chat) and we will take action.
That is because we have no way to access or control Rocket.Chat servers. Our platform is open source and has no backdoors or whatsoever to allow us to remotely access your installations. In case of instances hoste by us for others, we forward them to the respective administrator. Where the request is about content on a server directly under our control, such as our Open Server, you can contact us directly under legal@rocket.chat.\).
### Resources for Administrators Be Notified About Harmful Content
......@@ -31,7 +29,7 @@ With this being the current situation, we wanted to share our stance on how we a
* We do not endorse illegal or unethical usage of Rocket.Chat in any way. We understand these terms to be relative and to be interpreted in their local context.
* We want Rocket.Chat to be a platform that allows for free and unrestricted communication. We do not plan or want to build any kind of backdoor, censorship tool or hidden remote control mechanism into Rocket.Chat.
* Administrators are the ones in control over their installation. Administrators are responsible for their decisions on configuration and content moderation within their instance.
* We comply with valid local or international law enforcement requests to remove content or produce user data and inform our users affected by these requests.
* We comply with valid local or international law enforcement requests to produce user data and inform our users affected by these requests.
* On our Open Server run by us, we want to provide users a positive and fun environment to test our platform and get in touch with us.
**While none of these principles are absolute, they are guiding our actions.**
......@@ -46,21 +44,21 @@ If you do not know who is your administrator, you can check the DNS records for
As an ultimate resort, you may want to reach out to the law enforcement body in charge of investigating the potential offense in question. They will tell you the legal remedies available and the potential next steps to take.
**For administrators:** If you are an administrator, you might have an interest in moderating the content that users create or put in your instance. Notable features that can help you with that are:
**For administrators:** If you are an administrator, you might have an interest in moderating the content in your instance. Notable features that can help you with that are:
* Making use of the “moderator”-permission in channels to appoint individuals to purge or modify inappropriate messages
* Notification feature for the use of specified words of phrases
* Blacklisting certain words or phrases
* Notifying your users of applicable policies via e.g. pinning messages or adding an announcement to the room
* Requiring confirmation of user registration by an administrator, to prevent unvetted users from posting messages
* Enabling or disabling end-to-end encryption: with end-to-end encryption enabled, only an encrypted string of the message is stored on the server. This however prevents content auditing via administrators and moves responsibility for content moderation to users.
* Enabling end-to-end encryption: with end-to-end encryption enabled, only an encrypted string of the message is stored on the server. This however prevents content auditing via administrators and moves responsibility for content moderation to users.
* Turning on GoogleVision integration for image uploads, which has options to block images containing graphic or adult content
All of these features are optional to choose, so you have the total flexibility in what to apply in your specific case. Let us know which kind of features you are currently missing - but would find useful - by opening feature requests in [our Github repository](https://github.com/RocketChat/feature-requests).
All of these features are optional to choose, so you have the total flexibility in what to apply in your specific case. Let us know which kind of features you are currently missing - but would find useful - by opening feature requests in our Github repository \(link\).
**For law enforcement:** We sometimes receive requests from law enforcement to remove content from certain Rocket.Chat instances. We have published [guidelines for law enforcement](https://docs.rocket.chat/legal/guidelines-for-law-enforcement), how we deal with requests and what to consider before submitting a request to us as the legal entity behind Rocket.Chat.
**For law enforcement:** We sometimes receive requests from law enforcement to remove content from certain Rocket.Chat instances. We have published guidelines for law enforcement \(link\), how we deal with requests and what to consider before submitting a request to us as the legal entity behind Rocket.Chat.
**In summary:** In most cases, we cannot remove the majority of content, because it is outside of our control on servers we do not have \(and do not want\) access to. If the content in question is on our Open Server, we remove it if it is a breach of our code of conduct or if we are compelled by a law enforcement request. For servers hosted by us and under control of our customers, we remove content after notifying and in collaboration with the customer or directly as a violation of our terms of service. For questions or contact, please use [legal@rocket.chat](mailto:legal@rocket.chat)
**In summary:** In most cases, we cannot remove the majority of content, because it is outside of our control on servers we do not have \(and do not want\) access to. If the content in question is on our Open Server, we remove it if it is a breach of our code of conduct or if we are compelled by a law enforcement request. For servers hosted by us and under control of our customers, we remove content after notifying and in collaboration with the instance owner. For questions or contact, please use [legal@rocket.chat](mailto:legal@rocket.chat)
**For reporters and media requests:** Are you researching for an article about Rocket.Chat or where Rocket.Chat plays a role?
......
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