Reference15r1:Concept Chat

Features without license

Important:
As soon, as the user has a chat license applied, chat is integrated into the Connect App. Otherwise, the old Chat App is used.

Features without license include the following:

Volatile chat

Chat to other users, if these other users are online and respond to the incoming chat call

Emojis

Some emojis can be selected to be included in the message. The emojis are sent as standard Unicode characters

Technical Details

Client APIs

The client uses published PBX APIs to provide the service.

PbxSignal

This is the API for signaling using Websocket/Json protocol. The Chat App uses the flag 'NO_MEDIA_CALL' when doing the register, so that no media call is sent to the Chat App. To mark a call as instant messaging call the facility 'im_setup' is used. Messages are transfered with the facility 'im_message'

PbxMessages

This API provides access to an external Messages App Service. If a chat licenses is assigned to the user, the Chat App established a Session on the PbxMessages API.

API of Messages App Service

The PBX Objekt Messages establishes a AppWebsocket connection to the external Messages App Service. Documeneted messages on this connection are used for the additional services.

File Attachments

To attach a files to a chat message, the client uses a method 'CreateFileBuffer' of 'PbxMessages' to create a temporariy buffer for a file in the Messages App Service. The file is sent via HTTP POST to this buffer and a URL to the file is included in the im_message facility. The recepient of the message can read the file from this buffer, if online while the message was sent. After the message was sent, the file attachments are copied into permanent buffers on the sender and on the received side. To access these buffers other URLs then the URLs for the temporariy buffers are used.

Text Format

The texts are sent as plain HTML coded as UTF-8. Plain HTML means that no attributes for HTML elements may be used. This is enforced by the PBX to make sure no malicious content can be sent. The styling of the HTML is up to the receiver of the message.

Tracing and logging

The following trace flags can be activated at Maintenance/Diagnostics/Tracing.

PBX

communication between the PBX and the myApps client

HTTP->Servlets

WebSocket communication between PBX and myAPPS client and also App Service. To enable this trace flag it's necessary to go to the debug.xml page.

Additionally, you can enable the following trace flags at the myApps client.

App

general information from the APP

Browser Console

information from the client/browser side.

In case we use the additional features with license, there is an APP called "Messages" at APP Platform and we can enable the following trace flags for the instance "messages".

App

general information from the APP Messages

Database

information from APP database.

App Websocket

information from APP to PBX regarding websocket.

Signalling

information of signalling between App Messages to PBX