# Chat Module

The User Control Panel (UCP) includes a built-in XMPP chat client that works in conjunction with the XMPP module. This allows users to send and receive instant messages (IMs) using a simple web browser interface.

## Prerequisites

- A user must be allowed to log into [UCP](http://wiki.freepbx.org/pages/viewpage.action?pageId=28180526) (set in the [User Management](http://wiki.freepbx.org/display/FPG/User+Management+Module) module)
- Chat must be enabled for the user (set in the [User Management](http://wiki.freepbx.org/display/FPG/User+Management+Module) module)

## Enable Chat

To enable chat for a user go to the User Management module and select the Chat tab. Then select "Yes" for Enabled and save. The option to add the Chat service will now appear in UCP

<span class="confluence-embedded-file-wrapper">![](https://wiki.freepbx.org/download/attachments/74318922/image2017-3-14%2014%3A5%3A18.png?version=1&modificationDate=1489511118000&api=v2&effects=border-simple,shadow-kn)</span>

## Chat With a User

Chat can only be added as a Side Bar Widget. You can do this through the Add Widget interface

<span class="confluence-embedded-file-wrapper confluence-embedded-manual-size">![](https://wiki.freepbx.org/download/attachments/74318922/image2017-3-14%2014%3A12%3A30.png?version=1&modificationDate=1489511550000&api=v2&effects=border-simple,shadow-kn)</span>

A list of users will appear from the left.

<span class="confluence-embedded-file-wrapper">![](https://wiki.freepbx.org/download/attachments/74318922/image2017-3-14%2014%3A13%3A38.png?version=1&modificationDate=1489511618000&api=v2&effects=border-simple,shadow-kn)</span>

Click a user to bring up a chat window

<span class="confluence-embedded-file-wrapper confluence-embedded-manual-size">![](https://wiki.freepbx.org/download/attachments/74318922/image2017-3-14%2014%3A14%3A55.png?version=1&modificationDate=1489511695000&api=v2&effects=border-simple,shadow-kn)</span>

From there you can type your message. Hit enter to send. You can also add emjois by pasting emojis or by clicking the emoji face in the chat window

<span class="confluence-embedded-file-wrapper confluence-embedded-manual-size">![](https://wiki.freepbx.org/download/thumbnails/74318922/image2017-3-13%201%3A10%3A38.png?version=1&modificationDate=1489512068000&api=v2&effects=border-simple,shadow-kn)</span>

Type your message to the recipient:

<span class="confluence-embedded-file-wrapper confluence-embedded-manual-size">![](https://wiki.freepbx.org/download/thumbnails/74318922/image2017-3-14%2014%3A16%3A22.png?version=1&modificationDate=1489511782000&api=v2&effects=border-simple,shadow-kn)</span>

Use the return/enter key to send.

<span class="confluence-embedded-file-wrapper confluence-embedded-manual-size">![](https://wiki.freepbx.org/download/attachments/74318922/image2017-3-14%2014%3A17%3A50.png?version=1&modificationDate=1489511871000&api=v2)</span>

The message will be sent instantly to the receiving end  
*This screenshot is of Adium*

<span class="confluence-embedded-file-wrapper confluence-embedded-manual-size">![](https://wiki.freepbx.org/download/attachments/74318922/image2017-3-14%2014%3A17%3A32.png?version=1&modificationDate=1489511852000&api=v2)</span>

When you receive a reply you will receive a browser notification if your browser is configured to accept notifications.

<span class="confluence-embedded-file-wrapper confluence-embedded-manual-size">![](https://wiki.freepbx.org/download/attachments/74318922/image2017-3-14%2014%3A19%3A25.png?version=1&modificationDate=1489511965000&api=v2&effects=border-simple,shadow-kn)</span>

## Collapse or Hide the Chat Window

<span class="confluence-embedded-file-wrapper">![](https://wiki.freepbx.org/download/attachments/74318922/down-arrow.png?version=1&modificationDate=1489509458000&api=v2)</span> / <span class="confluence-embedded-file-wrapper">![](https://wiki.freepbx.org/download/attachments/74318922/up-arrow.png?version=1&modificationDate=1489509458000&api=v2)</span>= Collapse / expand the chat window

<span class="confluence-embedded-file-wrapper">![](https://wiki.freepbx.org/download/attachments/74318922/x-for-close.png?version=1&modificationDate=1489509458000&api=v2)</span> = Close the chat window. To re-open, click the chat icon in the side bar and select the user in the drop-down list.