Genesys Webchat v1.1.8

Supported Form Inputs

Type	Input Name
First Name	firstname
Last Name	lastname
Nickname	nickname
Subject	subject
Email	email

Example of Fully Loaded Entry Form

    <div class='form'>
        <label><span class='i18n' data-message='ChatFormFirstName'>First Name</span><input name='firstname'></label>
        <label><span class='i18n' data-message='ChatFormLastName'>Last Name</span><input name='lastname'></label>
        <label><span class='i18n' data-message='ChatFormNickname'>Nickname</span><input name='nickname'></label>
        <label><span class='i18n' data-message='ChatFormSubject'>Subject</span><input name='subject'></label>
        <label><span class='i18n' data-message='ChatFormEmail'>Email</span><input name='email'></label>
        <button class='submit i18n' data-message='ChatFormSubmit'>Start Chat</button>
    </div>

You may add or remove these inputs as you require for your implementation. Currently these are the only supported fields.

Selecting a Language

You may change the language of the chat widget by changing this value on your page.

    <script>
        
        window.oChatOptions.i18n_lang = "en";

    </script>

Here the selected language is hardcoded as "en". Replace "en" with a reference to the value of the language code you opt to use in your language pack. If you use a cookie to store the language code on your site, set this to the value of that cookie on every page load.

Referencing a Language Pack

Using a separate file

The setting "i18n_URL" is used for identifying your i18n file. The value of this should be a direct URL to the file containing the different languages. An example file named genesys-webchat-i18n.json is included. It contains two example languages, English and Russian. They use the language codes "en" and "ru" respectively but you can choose any language code schema you want to use. These language codes should match the values of your language cookie for easiest integration.

Example JSON File:

    
    {

        "en": {

            "ChatStarted": "Chat Started",
            "ChatEnded": "Chat Ended",
            "ChatFailed": "Failed to Start Chat Session",
            "UserNameDefault": "Anonymous",
            "AgentNameDefault": "Agent",
            "AgentConnected": "<%Agent%> Connected",
            "AgentDisconnected": "<%Agent%> Disconnected",
            "AgentTyping": "<%Agent%> is typing",
            "AgentPending": "An Agent will be with you shortly",
            "AgentUnavailable": "Sorry. There are no agents available. Please try later",
            "ChatTitle": "Chat Support",
            "ChatEnd": "End Chat",
            "ChatClose": "Close",
            "ChatFormName": "Name",
            "ChatFormEmail": "Email",
            "ChatFormSubmit": "Start Chat",
            "ChatInputPlaceholder": "Type your message here and hit return...",
            "ChatInputSend": "SEND"
        }, 

        "ru": {

            "ChatStarted": "чат работы",
            "ChatEnded": "чат состава",
            "ChatFailed": "Не удалось запустить сеанс чата",
            "UserNameDefault": "анонимный",
            "AgentNameDefault": "агент",
            "AgentConnected": "<%Agent%> связанный",
            "AgentDisconnected": "<%Agent%> отключен",
            "AgentTyping": "<%Agent%> печатает",
            "AgentPending": "Агент будет с Вами в ближайшее время",
            "AgentUnavailable": "Извините. Там нет агентов, доступных . Пожалуйста, попробуйте позже",
            "ChatTitle": "Чат поддержки",
            "ChatEnd": "Конец Чат",
            "ChatClose": "близко",
            "ChatFormName": "имя",
            "ChatFormEmail": "Email",
            "ChatFormSubmit": "Начать Чат",
            "ChatInputPlaceholder": "Введите Ваше сообщение здесь и нажмите возврат...",
            "ChatInputSend": "слать"
        }
    }

Defining languages inline

Instead of hosting a separate file, you can include the language pack JSON inline in the file genesys-webchat-i18n.json under the "i18n_messages" property.

Example Inline Definition:

    
    "i18n_messages": {

        "en": {

            "ChatStarted": "Chat Started",
            "ChatEnded": "Chat Ended",
            "ChatFailed": "Failed to Start Chat Session",
            "UserNameDefault": "Anonymous",
            "AgentNameDefault": "Agent",
            "AgentConnected": "<%Agent%> Connected",
            "AgentDisconnected": "<%Agent%> Disconnected",
            "AgentTyping": "<%Agent%> is typing",
            "AgentPending": "An Agent will be with you shortly",
            "AgentUnavailable": "Sorry. There are no agents available. Please try later",
            "ChatTitle": "Chat Support",
            "ChatEnd": "End Chat",
            "ChatClose": "Close",
            "ChatFormName": "Name",
            "ChatFormEmail": "Email",
            "ChatFormSubmit": "Start Chat",
            "ChatInputPlaceholder": "Type your message here and hit return...",
            "ChatInputSend": "SEND"
        }, 

        "ru": {

            "ChatStarted": "чат работы",
            "ChatEnded": "чат состава",
            "ChatFailed": "Не удалось запустить сеанс чата",
            "UserNameDefault": "анонимный",
            "AgentNameDefault": "агент",
            "AgentConnected": "<%Agent%> связанный",
            "AgentDisconnected": "<%Agent%> отключен",
            "AgentTyping": "<%Agent%> печатает",
            "AgentPending": "Агент будет с Вами в ближайшее время",
            "AgentUnavailable": "Извините. Там нет агентов, доступных . Пожалуйста, попробуйте позже",
            "ChatTitle": "Чат поддержки",
            "ChatEnd": "Конец Чат",
            "ChatClose": "близко",
            "ChatFormName": "имя",
            "ChatFormEmail": "Email",
            "ChatFormSubmit": "Начать Чат",
            "ChatInputPlaceholder": "Введите Ваше сообщение здесь и нажмите возврат...",
            "ChatInputSend": "слать"
        }
    }

Special Codes in Language Pack

You may have noticed that the messages in the language pack include the curious code <%Agent%>. This code is replaced by the name of the agent that comes from the chat server. If no name is provided by the server, this value will default to whatever value you have set for "AgentNameDefault" in the language pack. You can see in the example language pack that "AgentNameDefault" is "Agent" for English and "агент" for Russian. 

In the example, <%Agent%> is being used in 3 messages:

    "AgentNameDefault":  "Agent",
    "AgentConnected":    "<%Agent%> Connected",
    "AgentDisconnected": "<%Agent%> Disconnected",
    "AgentTyping":       "<%Agent%> is typing",

If the server returned the name of the agent as "Tom Smith" the messages would be transformed like this:

    "AgentNameDefault":  "Agent",
    "AgentConnected":    "Tom Smith Connected",
    "AgentDisconnected": "Tom Smith Disconnected",
    "AgentTyping":       "Tom Smith is typing",

If the server returned no name for the agent, "AgentNameDefault" will be used instead, resulting in this:

    "AgentNameDefault":  "Agent",
    "AgentConnected":    "Agent Connected",
    "AgentDisconnected": "Agent Disconnected",
    "AgentTyping":       "Agent is typing",

Using <%Agent%> is optional and is included in the example to illustrate it's purpose.

Final Language Notes

If you do not specify a language pack file URL or you don't specify a language pack inline, the Chat client will default to its internal language pack which is English and matches the English example in genesys-webchat-i18n.json.