Download
Pricing
Community
Docs
Blog
Contact
Install
Pricing
Community
Docs
Blog
Contact
Try now
Welcome
Contributing
Developing
Documentation
Contribution Guidelines
Markdown Styleguide
Documentation Map
Drafts
New Feature Draft
Feature Change Draft
Missing and Outdated List
Community Maintainers
Promoting
Reporting Issues
Security
Responsible Disclosure Policy
Translating
Website
Webinars
Getting Support
User guides
Connecting to a Server
Registration
Login
Channels
Messaging
Channel Actions
Managing your Account
End to End Encryption
pimentaLIVE [Voice and Video Conferencing]
Administrator guides
Account Settings
Authentication
CAS
Ldap
Oauth
SAML
Oracle Cloud
WordPress
Database-Migration
Email
Setup
Editing Emails Content
Mailer
Direct Reply
File Upload
Amazon S3
Google Cloud Storage
Minio
WebDAV
Import
CSV
HipChat
Cloud
Enterprise
Slack
SlackBridge
Integrations
Zapier
Using Zaps
AppVeyor
Azure Alerts
BitBucket
DeadSimpleScreenSharing
Gif.pimenta
GitHub
GitLab
Google-Calendar
Guggy
Jenkins
Jira
MicroBadger
NextCloud and WebDAV
NewRelic
nixstats
PagerDuty
Prometheus
RunDeck
Sentry
Telegram
Travis CI
Trello
Uptime Robot
Google Cloud
Auto Translate
Setting Up Video Conferencing
Livechat
Livechat Queues
Omnichannel Integration
Notifications
Push Notifications
Permissions
Custom Fields
Plug-ins
Drupal
Pidgin
Create the First Admin
Restoring an Admin
Retention Policies
Settings Via Env Vars
Youtube Broadcasting
Developer guides
Quick Start
Installation
pimentaCLOUD
TelekomCLOUD
PaaS Deployments
TelekomCLOUD
Aliyun
AWS
Cloudron.io
Digital Ocean
DPlatform
Galaxy
Google Computer Engine
Heroku
Hyper.sh
IBM Bluemix
Koozali
Layershift
OpenShift
ReadySpace
Scalingo
Sloppy.io
WeDeploy
D2C.io
Syncloud.org
Docker containers
Generic Linux
systemd
High Availability Install
Available Images
Docker Compose
Manual Installation
CentOS
Debian
Multiple Instances to Improve Performance
Migrating Meteor Mongo
RedHat
Ubuntu
Snaps
AutoSSL
Mongo Options
Mongo Versions
Mongo Replicas
Configuring SSL Reverse Proxy
PM2, Systemd, Upstart
Running in a sub folder
Automation tools
Ansible
Openshift
Vagrant
Mobile and Desktop Apps
Updating
From 0.x.x to 0.40.0
Minimum Requirements
Community Supported Installation
FreeBSD
Universal
Windows 10 Pro
Windows Server
OpenSUSE
Branches and Releases
Code Styleguide
less
Deeplink
Deprecation
Iframe Integration
Authentication
Commands
Events
Embedded Layout
Internationalization
Livechat API
Mobile Apps
Analytics & Data Usage
Supporting SSL
Supported Servers Versions
Developing Apps
Getting Started
Realtime-API
Method Calls
Login
Logout
Register User
Get User Roles
List Custom Emoji
Load History
Get Room Roles
Get Subscriptions
Get Rooms
Get Public Settings
Get Permissions
User Presence
Notify Room Stream
Create Direct Message
Send Message
Delete Message
Update Message
Pin Message
Unpin Message
Set Reaction
Create Channels
Create Private Groups
Delete Rooms
Archive Rooms
Unarchive Rooms
Joining Channels
Leaving Rooms
Hiding Rooms
Opening Rooms
Favoriting Rooms
Save Room Settings
Subscriptions
Stream Notify All
Stream Notify Logged
Stream Notify User
Stream Notify Room
Stream Notify Room Users
Stream Room Messages
The Message Object
The Room Object
Livechat API
getInitialData
registerGuest
sendMessageLivechat
sendOfflineMessage
streamlivechatroom
Rest API
Assets
setAsset
unsetAsset
Authentication
facebook
google
login
logout
me
twitter
Channels
addAll
addModerator
addOwner
archive
close
counters
create
delete
files
getAllUserMentionsByChannel
getIntegrations
history
info
invite
join
kick
leave
list.joined
list
members
messages
moderators
open
removeModerator
removeOwner
rename
roles
setAnnouncement
setCustomFields
setDefault
setDescription
setJoinCode
setPurpose
setReadOnly
SetTopic
setType
unarchive
Chat
delete
getMessage
getMessageReadReceipts
pinMessage
postMessage
react
reportMessage
search
starMessage
sendMessage
unPinMessage
unStarMessage
update
Commands
get
list
run
Groups
addAll
addModerator
addOwner
archive
close
counters
create
delete
files
getIntegrations
history
info
invite
kick
leave
list
listAll
members
messages
moderators
open
removeModerator
removeOwner
rename
roles
setAnnouncement
setCustomFields
setDescription
setPurpose
setReadOnly
SetTopic
setType
unarchive
Im
close
counters
create
files
history
list.everyone
list
members
messages
messages.others
open
setTopic
Integration
create
history
list
remove
Livechat
agent
config
custom-fields
department
message
room
sms-incoming
users
video-call
visitor
Miscellaneous
directory
info
shield.svg
spotlight
statistics
statistics.list
Permissions
list
update
Roles
create
list
addUserToRole
Push
push.token
deletePushToken
Rooms
cleanHistory
favorite
get
info
leave
saveNotification
upload
Settings
get
get-by-id
oauth
public
service-configuration
update
Subscriptions
get
getOne
read
unread
Users
create
createToken
delete
deleteOwnAccount
forgotPassword
generatePersonalAccessToken
getAvatar
getPersonalAccessTokens
getPresence
get-preferences
getUsernameSuggestion
info
list
regeneratePersonalAccessToken
register
removePersonalAccessToken
resetAvatar
setAvatar
set-preferences
update
updateOwnBasicInfo
pimentaLIVE [Video Conference]
pimentalive-update-timeout
Voice Calls
voice.call
voice.call.feedback
voice.call.ping
voice.call.history
Offset and Count and Sort Info
Query and Fields Info
Personal Access Tokens
Schema Definition
Testing
Troubleshooting
UI and Theming
Colors
Components
Themes
Pimenta Call
Class
Messages
Bots
Bots FAQ
Bots Architecture
Creating Bot Users
Configure Bot Environment
Running a pBOT Bot
Running a Hubot Bot
Running a Botkit Bot
Running a Rasa Bot
Running a Botpress Bot
Community Cookbook
Remote Video Monitoring
Roles Methods
Url
Short Description
Details Page
/api/v1/roles.list
List all roles on the server.
Link
/api/v1/roles.create
Create a new role.
Link
/api/v1/roles.addUserToRole
Edits permissions on the server.
Link
Contribute to our growth with your feedback