BlueFletch Chat

Technical Guide

Configurations

settings

Include in the settings object in the Launcher Configuration file:

Field	Value
useSiteInfoService	boolean Set to true.
defaultLocation	string Set a placeholder string. This will display if a site location is not found automatically, allowing the user to manually override and select a site.

emsSupportTool

Include in the emsSupportTool object in the Launcher Configuration file:

Field	Value
orgId	string Set to the company's organization ID, as displayed on the BlueFletch Portal Admin - Organization page here.

bfChat

Include in the bfChat object in the Launcher Configuration file:

Field	Value
apiKey	string Set to the organization's API key. The API key can be found in the BlueFletch Portal; it is actively managed on the Admin - API Keys page or displayed statically in Manage Organization settings on the Organization page.
autoPlayAudio	boolean If true, audio recordings will automatically play when received and will be stored for playback in the Chat conversation. If false, audio recordings will only be available through playback in the Chat conversation.
allowAttachments	boolean If true, sending attachments in Chat is enabled. If false, the attachment button will be disabled in Chat, preventing the user from sending attachments.
callTimeout	integer The number of seconds a voice/video call will be allowed to ring before the call is ended. Default is 20.

login

Include in the login array within intents object in the Launcher Configuration file:

Field	Value
action	string Set to "com.bluefletch.chat.ACTION_LOGIN".
package	string Set to "com.bluefletch.chat".
flags	integer Set to 1.
typeIntent	string Set to "a".

logout

Include in the logout array within intents object in the Launcher Configuration file:

Field	Value
action	string Set to "com.bluefletch.chat.ACTION_LOGOUT".
package	string Set to "com.bluefletch.chat".
flags	integer Set to 1.
typeIntent	string Set to "a".

Example Configuration

{
    ...
    "settings": {
        "useSiteInfoService": true,
        ...
    },
    "emsSupportTool": {
        "orgId": "ORG ID HERE",
        ...
    }
    "bfChat": {
        "apiKey": "ORG API KEY HERE",
        "autoPlayAudio": true
    },
    "intents": {
        "login": [
            {
                "action": "com.bluefletch.chat.ACTION_LOGIN",
                "package": "com.bluefletch.chat",
                "flags": 1,
                "typeIntent": "a"
            }
        ],
        "logout": [
            {
                "action": "com.bluefletch.chat.ACTION_LOGOUT",
                "package": "com.bluefletch.chat",
                "flags": 1,
                "typeIntent": "a"
            }
        ]
    },
    ...
}