Manage conversations

Conversations have a total of four different statuses: mark as read, archive, delete and restore. You can manage the status of a conversation by opening it in the conversations area and then clicking any of the corresponding icon buttons in the top right of the conversation window.

Search for conversations

You can for conversations by department ID, assigned agent ID, conversation title, conversation ID, message text, message attachments name, user first name, user last name, user email. If you search for a specific message text, the conversation containing that message will be shown at the correct position and the message will be highlighted.

Information

• When you empty the trash, all the conversations in the trash are permanently deleted.
• When a user sends a new message to an archived or trashed conversation, the conversation is automatically restored and will now be visible in the Inbox area.
• Trashed conversations are deleted automatically after 30 days.
• When a user is deleted, all the conversations and messages are permanently deleted too.
• An agent can delete their messages by opening the message menu and clicking Delete. The message menu becomes visible when you hover the mouse cursor over the message.
• The left conversations list use auto-pagination, which is limited to 100 results per scroll.

Reply to a message

You can reply to a message by opening the message's menu and, and clicking Reply to. The reply to feature is supported only on the following messaging services: WhatsApp, Telegram, Facebook Messenger.

Text editor and automated messages features

The text editor of the admin area and automated messages(example: welcome and subscribe messages) can be used to create stylized messages:

• Links formatting — All text links are automatically converted to clickable hyperlinks. To set the link name, append the following string to the URL: #sb-example. Replace example with your desired link name and white spaces with --.
• Text formatting — The editor also supports text formatting syntax:
  • To make text bold, surround it with *: *your text*.
  • To make text italic, surround it with __: __your text__.
  • To make text strikethrough, surround it with ~: ~your text~.
  • To insert a single-line code comment, surround it with`: `your text`.
  • To insert a code block, surround it with ```: ```your text```.
• HTML and other code languages — For security reasons, no HTML, JavaScript (JS), or other code languages are permitted. However, you can use HTML snippets by utilizing custom rich messages (discussed below).
• To insert a line break into a message, use the keyboard combination SHIFT + ENTER or CTRL + ENTER.

Merge fields

Merge fields are strings replaced by external values when used. Merge fields can be used in any message or automated message, including chatbot messages.

{user_name}

{user_email}

{agent_name}

{agent_email}

Rich messages

Rich messages are special messages with interactive features like buttons, dropdowns, or inputs. They allow an agent to request information from the user via a user input form or to diplay interactive contents. Rich messages can be inserted into a chat message using shortcodes. Shortcodes accept various parameters like title and description. The available rich messages are listed below.

How it works:

1

Create and send

Create a rich message by inserting the shortcode into the text editor of the admin area. Customize all of the parameters with your information and send your message.

2

Message is displayed

When a shortcode is used, the user sees the rich message (not the shortcode) and can select or enter the required information to complete the form submission.

3

User's response is submitted

Once the rich message form has been filled out and sent by the user, a success message is shown and the form data is saved.

Rich Messages

[card image="URL" header="TITLE" description="Lorem ipsum dolor sit amete" link="URL" link-text="Purchase" extra="$599" target="_blank"]

[slider image-1="URL" header-1="TITLE" description-1="Lorem ipsum dolor sit amete" link-1="URL" link-text-1="Purchase" extra-1="$599" image-2="URL" header-2="TITLE" description-2="Lorem ipsum dolor sit amete" link-2="URL" link-text-2="Purchase" extra-2="$599" target="_blank"]

[slider-images images="URL,URL,URL"]

[chips options="A,B,C"]

[buttons options="A,B,C"]

[select options="A,B,C"]

[inputs values="A,B,C" button="Send now"]

[email name="true" last-name="true" phone="true" phone-required="false" placeholder=""]

[timetable]

[articles link="https://Byrachat.com/articles-demo"]

[list values="A,B,- C,- D,E" numeric="true"]

[list values="A:X,B:Y,C:Z"]

[list-image values="URL:A,URL:B,URL:C"]

[table header="A,B,C" values="A:B:C,A:B:C,A:B:C"]

[button link="https://Byrachat.com" name="Click here" target="_blank" style="link"]

[video type="" id="0TImic4N1ko" height="350"]

[image url="https://Byrachat.com/media/admin.png"]

[share fb="https://Byrachat.com/" tw="https://Byrachat.com/" li="https://Byrachat.com/" pi="https://Byrachat.com/" wa="https://Byrachat.com/"]

Special chars

If your text includes the characters ,, :, or ", you must prepend the \ character to them. For example: \,, \:, \".

Global parameters

All of the rich messages support the following parameters:

id="123"

title="ABC"

message="ABC"

success="ABC"

settings="ABC"

Use rich messages in the chatbot

You have to create a Dialogflow chatbot, then simply enter the rich message shortcode into the text response of the Intent.

Rich message response

When a user completes a rich message, the response data is saved in JSON format in the database under table sb_messages and column payload. Example:

{"rich-messages":{"4Voyu":{"type":"email","result":{"email":["[email protected]","Your email..."]}}}}

Rich message translations

To translate a rich message string, the original rich message text must be in english, add the exact english text and its translations in Setting > Translations > Front End.

Show a rich message on chat initialization

To display a rich message, such as a list of buttons, when a user initiates a chat for the first time, insert the rich message shortcode into the welcome message.

Custom rich messages

You can create custom rich messages with your own custom content by going to Settings > Miscellaneous. Currently, custom rich messages are static and there are no interactive options available as there are with shortcodes. However, you can insert custom HTML codes.

HTML codes

When creating a custom rich message, you can use the following codes:

<a href="https://www.google.com" target="_blank" class="sb-rich-btn sb-btn">Click here</a>

<a href="https://www.google.com" target="_blank" class="sb-rich-btn sb-btn-text">Click here</a>

<div class="sb-image"><img src="https://via.placeholder.com/1500x600" class="sb-image" /></div>

Built-in messages

The built-in messages are pre-programmed messages sent automatically by Byra. You can find them by going to Settings > Messages.

Welcome message

Send a message to new users when they visit the website for the first time.

• Text formatting is supported.
• Merge fields are supported.
• Rich messages are supported.
• The welcome message is not sent to slack.
• Conversations containing only the welcome message (and no response) are automatically archived.

Follow up message

If no agents respond within the specified time interval, a message will be sent to request the user's details, such as their email.

• Text formatting is supported.
• Merge fields are supported.
• You can send a confirmation email to the user by filling in the Follow-up Email fields.
• If the delay is not set, a dynamic time interval is utilized and it is determined as follows: If Settings > Miscellaneous > Office hours is configured, and the current time falls within the defined office hours, or if at least one agent is online, then the delay will be set to 15 seconds. In all other cases, the delay will be set to 5 seconds.
• Follow-up messages are sent a maximum of once every 24 hours.
• If the user provides an email address and the newsletter feature is enabled, the email address will be subscribed.
• The follow-up message is sent only to users without email address.
• If the chatbot's human takeover feature is activated, the follow-up message is only sent during human takeover.

Rating

Display the feedback form to rate the conversation when it is archived.

• The rating message is not compatible with the messaging channels.
• The rating is visible in the right panel of the conversations area, in the agent ratings report of the reports area, and in the agent profile.

Offline message

Notify the user when their message is sent outside of the scheduled office hours or all agents are offline.

• Text formatting is supported.
• Merge fields are supported.
• To learn more about the office hours option, please click here.
• The offline message is sent to the same user maximum 1 time per hour.
• By default, the offline message is also sent if all agents are offline, even during office hours. To prevent this, enable the Disable agents check option.
• If the chatbot's human takeover feature is activated, the offline message is only sent during human takeover.
• If you or any other agent is online using Slack, they will be considered as online agents also by Byra.

Privacy message

Present a privacy message accompanied by Accept and Decline buttons. The user's approval by clicking on the Accept button is required to start using the chat. This feature ensures privacy policy enforcement and GDPR compliance.

• The privacy message is not shown if the Settings > Users > Require registration option is enabled.
• The privacy message is also sent to messaging channels like WhatsApp, but the user does not have the option to approve or decline the privacy policy. The messaging functionalities are not blocked either. The message is sent after the user initiates the conversation by sending their first message.

Pop-up message

Show a pop-up notification to all users.

• The popup message is always shown until the user manually closes it; then it stays closed.

Attachments

Here, you can access information regarding the uploading of files and the message's attachments.

• The following image formats are displayed automatically:.jpg, .jpeg, .png.
• The allowed file attachments extensions are set in the Byra/include/upload.php file.
• Add new allowed file extensions by adding the code define("SB_FILE_EXTENSIONS", ["exe", "abc",...]) to the config.php file of your Byra installation folder. Replace ["exe", "abc",...] with an array containing the extensions you want to allow.
• For instructions on sending attachments with a chatbot, click here.
• The uploads folder location is Byra/uploads by default for the PHP version, while for the WordPress version it is wp-content/uploads/sb. You can customize it from the config file. You can also upload files to AWS S3.

Information

Here, you can access information regarding a variety of features associated with conversations.

Tags

Tags enable more efficient organization and grouping of conversations. Please refer to the information below for further details.

• You can manage the tags from Settings > Admin > Tags.
• Tags can be assigned to conversations through different methods: via the admin area by navigating to Settings > Automations > More, through Dialogflow actions, and by inserting the JS variable SB_DEFAULT_TAGS into a page showing the chat or into a web page displaying the chat or the tickets panel.
• To locate conversations with specific tags, simply enter the tag names into the search bar located at the top-left corner of the admin conversations area, or you can select the desired tag from the dedicated filters menu on top-left. The tags filter is visible only if at least one tag is assigned to a conversation.
• Check the Starred tag option to display the starred tag icon in the conversations area. This allows you to select conversations assigned to the first tag with one click. The first tag on top is always the starred tag.
• You can disable the tags from Settings > Admin > Disable features > Tags.

Notes

Notes allow agents and admins to add comments to conversations.

• Notes are only visible to agents and admins.
• If you are usign OpenAI, we suggest enabling the note data scraping option.
• Manage the note settings from Settings > Admin > Notes settings.
• You can disable the tags from Settings > Admin > Disable features > Notes.
• Activate advanced AI-powered features by using the Artificial Intelligence app. Learn more here.

Transcript

The full conversation can be sent to the user by the agent or admin as a transcript file.

• Agents and admins can send conversation transcripts to users by clicking the Transcript button in the top-right corner of the admin's conversation window.
• Agents and admins can automatically send the transcript to the user when the conversation is archived by using the close message available at Settings > Messages & Forms > Close message.
• The transcript can be sent to the user only if the user has an email address.
• If the conversation has been translated, the transcript will also include the translated messages.

Miscellaneous

• The date and time format is automatically detected based on the browser's language settings.

Manage users

Manage users from the Users area in the left menu of the admin area.

Import users

You can import users from Settings > Users > Import users. Only CSV files are supported. You can download an example CSV file here. In the example file, the first row is the header and the columns Height and Hair color are custom user fields added from Settings > Users > Custom fields.

Search users

You can search users by name, surname, email, and custom fields.

Delete users

You can delete a user by opening the User edit box and then clicking Delete user. To delete multiple users at once, select the users you want to delete from the Users table and then click the top right Delete icon.

• When a user is deleted, all of their conversations and messages are automatically deleted permanently.
• The conversation attachments will be deleted permanently. If AWS S3 is enabled, also the AWS S3 files will be deleted.
• If a user of a deleted user come back to the website, a new user is automatically created.
• Visitors are automatically deleted every 24 hours.

Merge users

You can merge two users into one directly from the user table. Select any two users, then click the Merge Users button at the top.

• When two users are merged, all their conversations are combined under the new user account.
• The system automatically identifies and merges relevant information from both users into the new account.

Additional user table columns

To display additional columns in the user table go to Settings > Admin > Users table additional columns and add the new columns. The value of each column is the slug of the user detail or extra user detail you want to display. The slug is lowercase and with spaces replaced by the char -. For example, the slug of the extra user detail "Date of birth" is "date-of-birth".

User types

user

lead

visitor

Manage agents and admins

Manage, create, and delete agents and admins from the Users area.

• Configure agents' privileges and permissions from Settings > Admin > Agent privileges.
• It can create a supervisor from Settings > Admin > Supervisor. The Supervisor is a special agent with specific privileges, it must be an administrator. You can add multiple supervisors by adding comma separated admin IDs.
• To create an agent or ad admin, go to the users area and click the button Add user on the top right.
• Only agents and admins can log in the Byra admin area.
• When you activate the Byra plugin on WordPress, an admin account is automatically created using the same username and password as the currently logged-in user.

Collect user details

You can gather user details, such as their name and email, through various methods:

• With a pre-chat form using the registration form.
• With the Follow-up message.
• With the chatbot flows.

Registration

The registration form is a pre-chat form that requires the user to enter specific information before starting the chat.

• You can use the registration form as a pre-chat form by limiting the information requested to the user to only the user's email address or the user name, for example.
• The log-in form is shown only if the email field is enabled.
• The password field is always shown when the user system is set to "WordPress".
• You can automatically log in a user via URL parameters.

Information

Miscellaneous

• New users are automatically displayed in the user table in real time.
• To view online users enable Settings > Users > Register all visitors.
• To receive the online user notification you have to enable Settings > Notifications > Online users notification, Settings > Miscellaneous > Pusher (if you are using the cloud version, this setting is automatically activated) and Settings > Users > Register all visitors (activated by default). The feature covers all user types, including visitors and leads. Notifications are only sent once per user within a 24-hour period.
• Agents and admins can set their status to online or offline from the bottom-left profile panel. If the option Settings > Notifications > Away mode is active, the offline status is activated automatically when the agent or admin has been inactive in the admin area for at least 10 minutes. Inactivity is defined as not performing any mouse clicks, movements, or key presses. The automatic offline status feature is not enabled on mobile devices. For this feature to work correctly, Pusher should be enabled.
• The users table use auto-pagination, which is limited to 100 results per scroll.

Login verification URL

The login verification URL feature can be found under Settings > Users > Login verification URL in Byra. This feature allows Byra to authenticate an external login from an external source and automatically register and log in the user. Byra will send a request to the specified URL, appending the user's email address and the password entered in the chat login form as URL parameters. The parameters are named email and password. Example: https://example.com/[email protected]&password=12345678. The expected response from the URL should be a JSON object like below:

{
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "profile_image": "https://Byrachat.com/user.svg",
    "department": null,
    "password": "",
    "details": {
        "location": [
            "Location",
            "New York, United States"
        ],
        "country_code": [
            "Country code",
            "America/New_York"
        ]
    }
}

The value first_name is required.

Settings

Office hours

You can set the office hours timetable from Settings > Miscellaneous > Office hours. Office hours are used for:

• Sending the offline message.
• Disabling and hiding the chat during out-of-office hours.
• Disabling the chatbot during regular office hours and enabling it during out-of-office hours.

More information

• If a day has only one start and end time, enter them in the first two fields. For example, use 10:00 AM to 5:00 PM and (empty) to (empty), not 10:00 AM to (empty) and (empty) to 5:00 PM.
• Do not leave empty values. Set them to closed instead.
• You have to set values to closed if you want to set a whole day as not office hours.
• The office hours are in UTC format. Set your UTC from Settings > Miscellaneous > Timezone.
• The date and time format of the timetable matchs automatically the one used in the country of the browser language of the user.

Articles

Knowledge base articles provide instant answers to customers to help reduce customer support volume. You can access the articles from the left Byra menu.

How to display the articles area

• The articles can be shown in the chat dashboard by enabling them from Settings > Articles > Display in dashboard.
• Alternatively, articles can be shared in any chat conversation via the rich message shortcode, [articles].
• Follow these steps to display the articles on a page of your domain and website. You can display them in three ways:

  • REST API METHOD

    Insert the code below into your page. Replace [Byra-URL] with the URL of your Byra installation and [YOUR-TOKEN] with any admin token. If you are using the cloud version, the URL is https://cloud.Byrachat.com/script/include/api.php, to get the token click here, also, remove the first two scripts. Include the attibure nojquery => true if you already have jQuery included in your page. Include the attibure nojs => true if you already have the chat embed code included in your page.

    <div id="sb-articles">
         <script src="[Byra-URL]/js/min/jquery.min.js"></script>
         <script id="sbinit" src="[Byra-URL]/js/main.js"></script>
         <?php
         $ch = curl_init('[Byra-URL]/include/api.php?articles=true&' . (empty($_GET['category']) ? (empty($_GET['article_id']) ? (empty($_GET['search']) ? '' : '&search=' . urlencode($_GET['search'])) : '&article_id=' . $_GET['article_id']) : '&category=' . $_GET['category']) . (empty($_GET['lang']) ? '' : '&lang=' . $_GET['lang']));
         $parameters = [
             CURLOPT_RETURNTRANSFER => true,
             CURLOPT_SSL_VERIFYPEER => false,
             CURLOPT_USERAGENT => 'Byra',
             CURLOPT_POST => true,
             CURLOPT_CONNECTTIMEOUT => 5,
             CURLOPT_POSTFIELDS => http_build_query([
                                       'token'=> '[YOUR-TOKEN]', 
                                       'function' => 'init-articles'
                                   ])
         ];
         curl_setopt_array($ch, $parameters);
         $response = curl_exec($ch);
         curl_close($ch);
         echo $response;
         ?>
    </div>
    

  • PHP API METHOD

    Insert the code below into your page. Replace [Byra-URL] with your Installation URL, get it from Settings > Miscellaneous > Installation URL. Replace [Byra-PATH] with the path of your Byra installation. This method is not available in the cloud version. If jQuery is alraedy included in your page, do not include it again.

    <script src="[Byra-URL]/js/min/jquery.min.js"></script>
    <script id="sbinit" src="[Byra-URL]/js/main.js"></script>
    <link href="[Byra-URL]/css/main.css" type="text/css" rel="stylesheet">
    <link href="[Byra-URL]/css/articles.css" type="text/css" rel="stylesheet">
    <div id="sb-articles">
        <?php require('[Byra-PATH]/include/articles.php'); ?>
    </div>
    

  • JS METHOD

    Insert the code below into your page. This method is not recommended for SEO purposes as the as the articles are loaded asynchronously and the page may not be indexed by search engines. Replace [Byra-URL] with your Installation URL, get it from Settings > Miscellaneous > Installation URL. If you are using the cloud version, the URL is https://cloud.Byrachat.com/script.

    <script src="[Byra-URL]/js/min/jquery.min.js"></script>
    <script id="sbinit" src="[Byra-URL]/js/main.js"></script>
    <script>var SB_ARTICLES_PAGE = true;</script>
    <div id="sb-articles" class="sb-loading"></div>
    

  • WORDPRESS METHOD

    If you're using the WordPress version you can use the shortcode [sb-articles]. This method is supported only in the WordPress version.

  The page shows the article categories, you must add parent categories and assign articles to them. The articles will be shown in the same location of the code above. You can hide the chat widget by adding the JS code var SB_DISABLED = true; to the page.

One-page navigation

The article's one-page navigation appears automatically on all articles. It is generated from the article's h2 and h3 heading blocks.

URL rewrite

You can enable the URL rewrite from Settings Articles > URL rewrite. The default URLs of Byra are not user-friendly and they include parameters. You can rewrite the URLs via .htaccess file. The code below rewrites the URLs of the categories and article pages. The categories URL changes from articles.php?categories=ID to articles/category/ID. The article URL changes from articles.php?article_id=ID to articles/ID.

<IfModule mod_rewrite.c>
RewriteEngine On
RewriteRule ^articles?$ articles.php [L]
RewriteRule ^articles/category/(.*)$/?$ articles.php?category=$1 [L,QSA]
RewriteRule ^articles/(.*)$/?$ articles.php?article_id=$1 [L,QSA]
</IfModule>

Change articles with the name of your articles page and set the articles page URL in Settings > Articles > Articles page URL.

Language

• You can add new article translations by opening an article. Click the + icon on top right and select the language you want to translate the article into. To delete a translation, hover the language flag icon and click the trash icon.
• You can add new category translations by opening a category. Click the + icon on top right and select the language you want to translate the category into. To delete a translation, hover the language flag icon and click the trash icon.
• You can enable automatic translation of articles and categories by activating both the multilingual via translation feature and Settings > Articles > Language > Automatic translation. You also have to set the default language of your articles from Settings > Articles > Language > Default language. The language used for the automatic translation is the user's language detected by Byra. You can also force a specific language by adding the URL parameter lang=LANGUAGE-CODE.
• The language menu is shown at the bottom of the article. It shows all the available translations of the article.
• If there is at least one translated article in the user's language, only the translated articles are displayed in the category page or main page. Otherwise, all articles are displayed in the original language.
• Force the articles page to be shown in a specific language by adding the URL parameter lang=LANGUAGE-CODE. Replace LANGUAGE-CODE with the two-letters language code.

More information

• If you use categories, all the articles must be assigned to a category.
• You can create an internal chat link to an article with the button rich message.
• You can create a link to a specific article with the URL attribute article=ID, replace ID with the article ID. Example: https://Byrachat.com/articles-demo?article=Ucsx6.
• You can create a link to an article category with the URL attribute category=ID, replace ID with the category ID. Example: https://Byrachat.com/articles-demo?category=LnNaZ.
• The articles are always included into the training of your OpenAI chatbot. If you update an article, you'll need to train the chatbot again, the process isn't automatic.
• If some block is not saved, e.g. text block, disable all browser extentions and try again.
• To hide the chat widget insert the following code into the articles page: <script>var SB_DISABLED = true;</script>.

Language and translations

Byra is fully multilingual and provides powerful features to detect the user's language on the fly.

Chat language

Byra is already translated into 45+ languages. There are many options available to set the language:

• OPTION 1 Go to Settings > Chat and check the Language option. Set it to multilingual to automatically use the chat language of the user's browser or the language saved in the user profile.
• OPTION 2 Add the URL parameter lang=LANGUAGE-CODE to the script that loads the chat, replacing "LANGUAGE-CODE" with the two-letters language code you would like to display. E.g. https://Byrachat.com/Byra/js/main.js?lang=es or https://cloud.Byrachat.com/account/js/init.js?id=123456&lang=es for the cloud version.
  This feature will force the chat to always use the same language and the Settings > Chat > Language option will be ignored. Go to wikipedia.org/wiki/List_of_ISO_639-1_codes for the complete languages code list (see column 639-1). For Traditional Chinese use zt, for Simplified Chinese use zh, for Brazilian Portuguese use pt.
• OPTION 2 - WORDPRESS ONLY Go to Settings > WordPress and set the option Force language. This feature will force the chat to always use the same language and the Settings > Chat > Language option will be ignored.
• OPTION 3 - WORDPRESS ONLY The WordPress version of Byra uses the default language of the WordPress installation; or the language of the current page or post if the website is multilingual. This feature is compatible with WPML, Polylang, and other multilingual plugins. This feature is automatically disabled if the Settings > Chat > Language option is active.

Admin language

To translate the admin area follow the steps below:

• Translate the texts in your language from the Settings > Translations.

To set the admin area language you have three options:

• Activate the option Settings > Admin > Automatically translate admin area. This feature automatically translate the admin area to match the agent profile language or the agent browser language.
• Edit the file config.php inside your Byra installation directory and Enter the code define('SB_ADMIN_LANG', 'LANGUAGE-CODE'); at the end of the file content. Replace LANGUAGE-CODE with the language code of the language you want to use, use only 2 letters, for example, insert only es, not es_ES. This option is not available in the cloud version.

Chatbot and message translations

To automatically translate chatbot messages and other texts, use the Artificial Intelligence app and follow the steps outlined here.

Edit and add new translations

You can translate almost any custom content like rich messages, built-in messages, departments, chat header, and more. To add a new translation or edit and existing translation, follow the steps below:

• Go to Settings > Translations, if you want to add a new translation, click New translation.
• Enter the English content you wish to translate in the first field. The original text must be in English. If the original text has breaklines, replace them with the \n code.
• Enter the corresponding translation in the second field. To add breaklines, use the \n code.
• If you have the artificial intelligence app you can also translate all contents to any language automatically through the multilingual via translation feature.

Add a new language

To add a new language, follow the steps below:

• Via FTP or a File Manager, go to Byra\resources\languages\front.
• Duplicate (copy and paste it in the same directory) the Byra\resources\languages\front\source.json file.
• Rename the file with the language code you would like to add. Go to wikipedia.org/wiki/List_of_ISO_639-1_codes for the complete languages code list (see column 639-1).
• Go to Settings > Translations and the new language should appear automatically.

To add a new language for the admin area, follow the exact same steps, but use folder admin instead. New languages will not be lost or deleted on plugin updates.

Information

• If a translation string is missing, add it by clicking the button Add new translation.
• If a translation string is not working, make sure to remove all white spaces and break lines at the start and the end of the string.
• The translations edits are not saved in the database but directly in the translation files. When a translation is edited, and saved, a backup is created into the uploads folder. The backup is restored automatically on plugin update and plugin activation.
• Some special chars like & are replaced by the HTML equivalent code (see https://www.w3schools.com/html/html_entities.asp). Ex. & is replaced by &amp;.
• You can add missing translation strings also by code. Edit the language files located in Byra\resources\languages. After editing a file, the new strings will be visible under Settings > Translations. Remember to click Save changes in order to preserve your translations and avoid losing them when Byra is updated.

Departments

Departments give you the power to distribute conversations and assign various agents to specific departments. For example, you can create a department entitled "Sales" and assign specific conversations to that department. To start using departments, follow the steps below:

• Go to Settings > Miscellaneous and add, delete and manage the departments. After saving, reload the page.
• Go to Users > Agents and edit an agent, you will see a new field where you can set the department of the agent.
• Reload the page and you're done! In the Conversations area, you will now see an option to set the department.

Settings

• Display in dashboard Displays the departments' list in the chat dashboard and force users to choose a department before starting a conversation.
• Display images Displays the department image instead of the department color.
• Display in conversation list Displays the department color in the conversation list of the admin area.
• One conversation per department Restrict users from opening multiple conversations within the same department, allowing only one conversation to be active per department.
• Label Replace the label Departments (plural) with another text. The name is displayed in the admin and tickets area.
• Label single Replace the label Department (singular) with another text. The name is displayed in the admin and tickets area.
• Dashboard title Set the title of the chat dashboard list. Default: Departments.

How it works

• Agents and admins with no assigned department always see the conversations of all departments.
• Agents and admins with an assigned department can only access conversations, users, and agents within that department.
• When a conversation is assigned to a new department, an email notification is sent to all of the agents assigned to the new department.
• The chatbot can assign a department to the active conversation through the Q&A set data feature, the flows actions feature, or Dialogflow actions.

How to assign a department to a conversation

You can assign a department to a conversation in several ways:

• Via the Q&A set data feature.
• Via the flows actions feature.
• Via Settings > Miscellaneous > Departments settings > Display in dashboard. In this case, the user will be required to select a department before starting a new conversation.
• Via Settings > Automations > More.
• Via JavaScript, with the variable var SB_DEFAULT_DEPARTMENT = ID;. Enter the code into the pages where the chat is displayed and replace ID with the department ID. For more details check the API here.
• Via API.

Queue and routing

When the queue is activated via Settings > Miscellaneous > Queue, or routing is activated via Settings > Miscellaneous > Routing, Byra automatically assigns the users conversations to all available agents proportionately.

• Only online agents are counted as "available" agents and will receive new conversations. Conversations are assigned proportionally between all online agents. If no agents are online, the conversation will remain unassigned and will be automatically assigned to the first agent who comes online.
• Admins are not included; admins always see all the conversations.
• Agents must archive a conversation to mark it as completed; this will automatically give them access to the next conversation in the queue. A conversation is active if it's not deleted, or archived.
• Agents can switch their status between online and offline by hovering over their profile image and then clicking the label of the profile pop-up at the bottom-left of the admin area.
• Agents can only search and filter their conversations.
• Agents can only view their conversations; however, they can see all of the conversations of a single user.
• To enable agents to view all unassigned conversations, activate Settings > Miscellaneous > Hide conversations of other agents and View unassigned conversations.
• Queue and routing are compatible with the departments.
• If human takeover is active, the queue or routing is activated only on human takeover.
• When routing or queue is active, the agents menu will be automatically enabled.

More information - Queue only

When the queue is activated users enter into a queue automatically when an agent's chat limit is reached. When a user enters the queue, a message with the current position in the queue and the estimated waiting time is displayed. Byra automatically assigns the conversations to all available agents proportionately. When an agent marks a conversation as completed (by archiving it), the queue is updated and a new conversation is received.

• If a user is in the queue and leaves (e.g. by closing the browser) for more than 1 minute, the conversation is saved; however, once the user comes back, the queue is reset and the user will lose their previous position. If the user leaves, the conversation remains unassigned and therefore invisible to agents, but only visible to admins.
• You can use the following merge fields in the queue message: {position}, {minutes}. They will be replaced by the real values in real-time.
• The waiting time is displayed in minutes and is calculated as follows: queue position X response time = waiting time. For example, if a user is 5th in the queue, and the response time has been set to 4 minutes (via Settings > Miscellaneous > Queue), then the total wait time displayed to the user will be 20 minutes.
• When the sound option is active, a sound is played when it's the user's turn.
• For conversations started from messaging apps like WhatsApp, it is not possible to respect the limit of conversations per agent, all conversations will be immediately and proportionally assigned to an online agent. If no agents are online, the conversation will remain unassigned and will be automatically assigned to the first agent who comes online.
• Use the offline message to prevent the chat from showing the queue update message to the user.

To test the queue, follow the steps below:

• To simulate multiple users and agents, open the chat in multiple different browsers (e.g. Opera, Firefox, Brave, Chrome, etc.). Each browser can simulate two users/agents: one in normal mode and one in "private" or "incognito" mode.
• To reset the chat and start a new user session, open the browser console, enter SBF.reset(), and press ENTER.

More information - Routing only

When the routing is activated Byra automatically assigns the users conversations to all available agents proportionately.

• If the Routing > Disable online status check option is active, the conversations are distributed proportionally among all agents, regardless of whether they are online or offline.
• When an agent comes back online after being offline, all unassigned conversations are automatically assigned to them.
• When routing is active agents can manually route conversations to other agents from the right panel of the conversations area.
• If the conversation is archived and the user reopens it in the future by sending a new message, if the assigned agent in the conversation is offline, the conversation is assigned to another agent.

Manual routing

When the routing is activated via Settings > Miscellaneous > Hide conversation of other agents agents see only their own conversations and can select the unassigned ones.

• Agents menu: enable the agents menu.
• Routing if offline: if the conversation is archived and the user reopens it in the future by sending a new message, if the assigned agent in the conversation is offline, the conversation is assigned to another online if there is at least one, otherwise to no agent.
• View unassigned conversations: allow agents to view the unassigned conversations, when an agent replies the conversation is automatically assigned to him and the conversation is removed in real-time from the admin area of the other agents. Check this option to enable the manual routing.

Agents menu

The Agents menu lets you assign conversations to specific agents. It appears on the right side of the conversations area and is automatically enabled when queueing or routing is active. Select multiple conversations (see keyboard shortcuts) to assign the selected conversations to a specific agent.

Assign an agent to a conversation

You can assign an agent to a conversation in several ways:

• Via the Q&A set data feature.
• Via the flows actions feature.
• Via the queue or routing features.
• By enabling the Settings > Chat > Agents menu option. In this case, the user will be required to select an agent before starting a new conversation.
• Via Settings > Automations > More.
• Via JavaScript, with the variable var SB_DEFAULT_AGENT = ID;. Enter the code into the pages where the chat is displayed and replace ID with the agent ID. For more details check the API here.
• Via API.

Email piping

Email piping lets you sync multiple email addresses to receive messages directly in Byra. It also allows you, your agents, and users to reply to chat messages via email.

Activation

• Go to Settings > Notifications > Email piping and enter your POP3/IMAP email server information.
• Go to Settings > Notifications > SMTP and enter your SMTP email server information. The email address must be the one to which the email piping server connects to. Byra will send all emails from this email address and you, your agents, and your users will reply to this email address. For more details check the email notifications section.

Information

• The email address of Settings > Notifications > SMTP > Sender email should match the one used by the email piping server. If the email address does not match, or if multiple email addresses are configured for email piping, and the Username setting is defined as an email address, Byra will automatically include a reply-to field in the email notification. This ensures that when the user replies, their response is directed to the correct email piping address, keeping the conversation linked properly.
• The Notifications > User email notifications and Notifications > Agent email notifications settings are enabled automatically when email piping is active. When agents reply in Byra, emails are always sent to the user.
• If you're using the Artificial Intelligence app, and the settings Settings > Artificial Intelligence > Human takeover is active, no emails are sent if the chatbot knows the answer.
• If the Convert all emails option is active:
  • All emails sent to your inbox will be converted to chat messages, mind that all emails, including spam, promotional emails and more would be wrongly converted too.
  • Email sent by email addresses of agents and admins will be ignored, use another email address for testing.
  • Each email sent directly to the email piping address will generate a new user conversation.
• You can not use the same email address used for the email piping to reply. All your Byra agents and admins must use a different email address.
• Agents must reply via email from the same email address registered in Byra.
• The email is sent to the agents only if they are offline. If they are online no emails are sent.
• For Google Gmail and Google Workspace emails, you need to replace your Google password with a Google app password, details on https://support.google.com/accounts/answer/185833 (Create & use App Passwords section). Enter imap.gmail.com as host and 993 as port. You need also to allow access to Gmail to less secure apps, you can do it from https://myaccount.google.com/lesssecureapps. If you're using Google Workspace with a custom domain, check Admin Console > Security > Access and data control > API Controls > App access control. Make sure SMTP access isn't restricted for third-party apps.
• Email piping requires php5-imap module (IMAP module). If it's not installed on your server you can install it with the command apt-get install php5-imap. If you have issues contact your hosting/server support.
• The Delimiter option add a text at the top of all emails:
  ### Please type your reply above this line ###
  . This text tells Byra to delete all the content below it and it's usefult to cut out all of the reply quotes. Activate it if you see duplicated messages in the chat. If this option is active, you and your users can not use the string ### in the emails.
• Email attachments are supported.
• In order for email piping to work, email replies must contain the Byra recipient's name. Ex. Byra | SB2457-4734 <[email protected]>. All major email clients like Outlook Web, Outlook, Gmail, Yahoo Mail, support the recipient's name by default via chatbot reply or reply all buttons.
• Because of the nature of how emails work, each email client uses their personal codes, delimiters, and automatic strings, and more. For this reason, some chat messages converted from emails can contain invalid texts. We are working to optimize as many email clients as possible, for now, the following email clients are optimized and should not return any invalid text: Outlook Web, Outlook, Gmail, Yahoo Mail.
• Email piping supports departments, if the user's conversation is assigned to a department, the email notifications are sent only to the agents assigned to that department.
• If the email includes the reply-to attribute, it will serve as the primary user email address and notifications will be sent to that email.
• The Filters option allows you to filter the emails that are converted into chat messages. Add keywords separated by commas. If the email body, subject, or sender contains one of the keywords, the email will not be converted into a chat message.

Cron job

• Byra tries to process emails via cron jobs every 60 seconds, details here.
• If you're using the cloud version the cron job is already activated by default and it will run at least once every 60 minutes.
• You can manually trigger execution and speed up cron jobs via API with the PHP function sb_email_piping(), or the WEB API function email-piping.
• You can create a cron job that runs the URL [Byra-URL]/include/api.php?piping=true. Use the command */59 * * * * wget [Byra-URL]/include/api.php?piping=true to run it via a command. Replace [Byra-URL] with your Installation URL. To obtain the URL, follow these steps:
  If you are using the WP or PHP version, go to Settings > Miscellaneous > Installation URL. If you are using the cloud version, use this URL: https://cloud.Byrachat.com/script/include/api.php?piping=true&cloud=API-TOKEN and replace API-TOKEN with your API token.
• You can also use this cron job file: download. The cron job command is php -f YOUR-FILE-PATH/cron.php.
• If you manually run the cron job, activate the Disable cron job option to stop Byra from manually triggering it and to improve performance.

Direct messages

Direct messages allow you to send а single chat message, email, or text message, to a single user or several users. Read the information below to understand how it works.

• To send a message go to the Users area and click the direct message icon. Direct message buttons are also available in the profile box of the user.
• To send a message to all users, enter All in the User IDs field.
• To send a message to a group of users, enter their IDs in the User IDs field. You can check the users and then click the direct message icon to enter the IDs automatically.
• All message types support merge fields.

Direct chat message

• The chat message is sent to the active conversation, if any, otherwise to a new conversation.
• If the Settings > Notifications > User email notifications option is active, all users with an email are notified via email.
• If the Settings > Notifications > Text message notifications > Active for users option is active, all users with a phone number are notified via text message.
• If the Settings > Notifications > Push notifications option is active, a push notification is sent to all users.
• The message is also sent to messaging apps such as WhatsApp and Messenger if the user is connected to them.
• To send a message to all users of a single messaging app enter one of the following strings: whatsapp, messenger, instagram, telegram, twitter, zalo, wechat, viber, line. Enter tickets to send a message only to the users who created a Byra ticket via the Tickets app.

Direct email

• Email header and email signature are automatically included in all emails, set them from Settings > Notifications.
• The HTML language is supported.
• The subject supports merge fields.

Direct text messages

• To enable direct text messages you must enable the SMS in Settings > Notifications > Text message notifications.

Direct WhatsApp template messages

• For more details click here.

Automations

Automations allow running multilingual automatic tasks when conditions set by you are met.

• To delete a condition, set it to empty. To disable an automation, delete all conditions.
• Automations are sent only 1 time to users.
• If you used an automation in the past, and users already received it, you need to delete the automation and create a new one to show it to the users.
• Repeat only works if used in conjunction with date time.
• When date time is used in conjunction with the criteria is exactly, the value must not contain hours and minutes (hh:mm). Ex. 25/10/2021 (25/10/2021 10:30 will not work).
• The Settings > Users > Register all visitors option must be active if there are message automations that are executed on page load.
• City, countries, languages work automatically only if both the settings Settings > Users > Register all visitors and Settings > Users > Full visitor details are enabled.
• Cities work only if the user detail location is set and equal to city, country, or if the user detail city is set.
• Countries work only if the user details country_code, or country is set, or if the user detail location is set and equal to city, country. The country name must be in english.
• languages work only if the user details browser_language, or language is set.
• A visitor is a Returning visitor only if it visits the website again after 24h or more.
• The pop-ups appear only if the chat is closed, and they overwrite the default pop-up. You can check the message fallback option to send a message instead of showing the pop-up if the chat is open.
• You may need to enable Settings > Users > Register all visitors if you want to send an automated message to new users.
• Chat messages and popup fallback messages are sent only if the last user or agent message of the conversation is older than 10 minutes. This feature prevents unwanted automated messages to be sent during an agent-user conversation.
• The Custom variable condition check for the JavaScript variables with the given names and values. For example, the condition example=ABC is met if into the chat's page there is this JavaScript code: var example = "ABC";. Add multiple variables separated by commas.
• Automations are not compatible with the messaging apps like WhatsApp, Messenger, Instagram, Telegram, Twitter, Zalo, WeChat, Viber, Line.

Newsletter

Follow the steps below to complete the synchronization with your newsletter service. The user is subscribed in the following cases: registration form, follow-up message, subscribe message, email shortcode.

Mailchimp

• To get the Key, follow the docs at https://mailchimp.com/help/about-api-keys/.
• To get the List ID, follow the docs at https://mailchimp.com/help/find-audience-id/.

Brevo

• To get the Key, go to https://account.brevo.com/advanced/api.
• To get the List ID, go to https://my.brevo.com/lists.

SendGrid

• To get the Key, go to https://app.sendgrid.com/settings/api_keys.
• To get the List ID, enter in SendGrid and click Marketing > Contacts(https://mc.sendgrid.com/contacts), then click on a list, or create a new one. The last part of the URL is the list ID. Ex. https://mc.sendgrid.com/contacts/lists/8558c1e7-3c99-4428-a68f-78df2e437f8e (the list ID is 8558c1e7-3c99-4428-a68f-78df2e437f8e).

Elastic Email

• To get the Key, enter in Elastic Email, then click Settings from the top right profile menu. Click Create Additional API key (https://elasticemail.com/account#/settings/new/create-api), set a name and choose Plugin or Full access, or Custom and make sure the permission Contacts is set to View & Modify.
• The List ID is the list name. Important! Existing list's or segment names must not have any spaces in them.

Campaign Monitor

• To get the Key, enter in Campaign Monitor, then click Account settings from the top right profile menu. Click API keys > Generate API key.
• To get the List ID, enter in Campaign Monitor, then click List and subscribers from the top menu. Select a list and then click Settings from the left menu and copy the List API ID.

HubSpot

• To get the Key, enter in HubSpot, then get go to Settings > Integrations > Private apps and create a new app.
• Enter app name, then open the Scope tab and add the following scopes: crm.lists.write, crm.lists.read, crm.objects.contacts.read, crm.objects.contacts.write.
• Click Create app and copy the token. Paste the token into the Key field of Byra.
• To get the List ID, enter in HubSpot, then get it from Contacts > List > List details.

Moosend

• To get the Key, enter in Moosend, then click Settings > API key.
• To get the List ID, enter in Moosend, then get it from Audience > Email lists.

GetResponse

• To get the List ID, enter in GetResponse, then get it from Lists > Your list > Settings(https://app.getresponse.com/lists). Copy the List token value.
• To get the Key visit https://app.getresponse.com/api.

ConvertKit

• To get the Key, enter in ConvertKit, then get it from Settings > Advanced > API secret.
• To get the List ID, enter in ConvertKit, then get it from Grow > Landing Pages & Forms. Open you form and copy the numeric part of the URL. For example the ID of the form with URL https://app.convertkit.com/forms/designers/3003412/edit is 3003412.

ActiveCampaign

• To get the Key, enter in ActiveCampaign, then get it from Account settings > Developer.
• To get the List ID, enter in ActiveCampaign, then get it from Left menu > Lists or Left menu > Contacts > Lists. Open your list and copy the list ID in the URL. For example the ID of the list with URL https://schiocco.activehosted.com/app/contacts/?listid=1&status=1 is 1. The list ID must be in this format: domain:list-ID. The domain is the first part of your dashboard URL. For example the domain of https://schiocco.activehosted.com/ is schiocco and the final value to insert in Byra is schiocco:1.

MailerLite

• To get the Key, enter in MailerLite, then get it from Left menu > Integrations > MailerLite API.
• To get the List ID, enter in MailerLite, then get it from Left menu > Subscribers > Groups. View a group and copy the Group ID from the URL (e.g. ....group=18783408688903967...).

Mailjet

• To get the Key, visit https://app.mailjet.com/account/apikeys, or enter in Mailjet, then get it from Account settings > Account settings.
• To get the List ID, enter in MailerLite, then get it from Contacts > Contacts lists > Your list. Get the List ID by clicking the ? icon next to the lists's email, e.g. 1202546.

Sendy

• To get the Key, enter the Sendy settings area and copy the API KEY.
• To get the List ID, enter your brand, then click View all lists and copy the list ID. The list ID setting must also include your Sendy full URL. Enter the URL plus the list ID spearated by the char |, e.g. https://example.com|TDf6o892Mx11VXGC51ui567u.

SendFox

• To get the Key, enter in SendFox, then get it from Settings > API > Personal Access Tokens.
• To get the List ID, enter in SendFox, then get it from Audience > Lists. Open a list and copy the ID from the URL (e.g. the List ID of the URL https://sendfox.com/dashboard/lists/489151/contacts is 489151).

Amazon Web Services

Amazon S3

Upload attachments to your Amazon S3 bucket instead of the server where Byra is installed. Follow the steps below to set it up.

• Log in to AWS as the root user from https://aws.amazon.com/.
• Enter the IAM dashboard and click Left menu > Access management > Users.
• Click Add new user, enter the username and continue.
• Select Add user to group and on the User groups section below click Create group. In Permissions policies search for AmazonS3FullAccess and select it. Click Create user group.
• Assign the new group to the user you are creating and continue, then click Create user.
• Select the newly created user and open the Security credentials tab.
• In the Access keys area, click Create access key and select Application running outside AWS. Continue until you get the keys and save them in Byra > Settings > Miscellaneous > Amazon S3.
• Visit the Amazon S3 dashboard and click Create bucket.
• Set the bucket name and region you want. Save the region and name in Byra > Settings > Miscellaneous > Amazon S3. Check ACLs enabled and Bucket owner preferred. Uncheck Block all public access and all related checkboxes.
• Click Create bucket.
• This feature is technical and optional. Support does not cover any help related to this feature.
• Be aware that it may take up to 24 hours for a newly created bucket to become active. If you have recently created an S3 bucket and it is not working, wait for 24 hours and try again.

More settings

Saved replies

Saved replies, also known as canned messages, refer to a collection of pre-written messages that agents can quickly access and employ in the chat editor. Manage them from Settings > Admin > Saved replies.

• Saved replies can be printed by typing # followed by the saved reply name, plus a space.
• The saved replies pop-up can be opened by typing ##.
• Use \n to do a line break.
• If you are using the Dialogflow chatbot, the saved replies panel search will include results from Dialogflow Intents.
• You have the option to add all Dialogflow Intents to the saved replies list by using the option at Settings > Artificial Intelligence > Google > Add Intents to saved replies.

Notifications

To understand how notifications work and when they are sent read the information below. If you think notifications are not working, most probably you're just testing them in the wrong way, please read the information below before asking for support.

Email notifications

Both agents and users can receive an email notification when a new message is received.

Email notifications for admin and agents

• When a user sends their first message, if the conversation is assigned to a department, an email is sent only to the agents assigned to that department, if the conversation is assigned to a specific agent, an email is sent only to that agent, otherwise an email is sent to all agents who are not online at the moment. Subsequent emails are sent only to the last agent in the conversation.
• Email notifications are sent only if the last agent in the conversation is offline.
• If you're using the Artificial Intelligence app, and Settings > Artificial Intelligence > Human takeover is active, no emails are sent if the chatbot knows the answer.
• To prevent admins from receiving email notifications check Settings > Notifications > Do not send email notifications to admins.

Email notifications for users

• When an agent sends a message to a user, an email is sent to the user only if the user is offline.
• Only 1 email is sent. Subsequent messages will not trigger a new email alert.

Create the email

To manage the emails and create the contents go to Settings > Notifications. You can use text and HTML. New lines are automatically converted to <br />. You can use the following merge fields in the email. Merge fields are automatically replaced with the updated information.

{recipient_name}

{sender_name}

{sender_profile_image}

{message}

{attachments}

{conversation_link}

{conversation_id}

Cron job

You can run the following cron job for sending email notifications to both users and agents, in which case you also need to select Settings > Notifications > Email notifications via cron job. Sending emails via cron job will improve your email notifications: they will include the whole conversation and will be sent only 1 time.

• You can create a cron job that runs the URL [Byra-URL]/include/api.php?email-notifications=true.
• Use the command */59 * * * * wget [Byra-URL]/include/api.php?email-notifications=true to run it via a command.
• Replace [Byra-URL] with your Installation URL, get it from Settings > Miscellaneous > Installation URL.
• If you are using the cloud version, use this URL: https://cloud.Byrachat.com/script/include/api.php?email-notifications=true&cloud=API-TOKEN and replace API-TOKEN with your API token.
• Our support doesn't include assistance with this feature, as it is for advanced users and related to your server. For help with this, feel free to hire us.

Problems?

You can test the email feature by sending an email from Settings > Notifications > Send an agent email notification. Emails may not be delivered several reasons; below are the most common ones:

Push notifications

Push notifications are like Desktop notifications but with some key difference. Desktop notifications, also called Web notifications, are requested directly by the client while Push notifications come from a server. The main difference is that the Push notifications work always, also if your device is offline, or Byra is not open. Also, they are persistent and always visible until closed. Push notifications require an external service to work. We support Pusher and OneSignal, they are free to use for up to 2000 users/devices. Pusher does not support iOS devices. You need to use OneSignal if you have an iOS device.

Cloud version

The cloud version of Byra uses OneSignal by default, you do not have the option to configure it. For the admin area everything is already configured and you only have to check the Settings > Notifications > Push notifications > Active for agents option, save the changes, and reload the admin area.

Activation - Pusher

• Go to Settings > Notifications > Push notifications and select Pusher as provider.
• Go to https://dashboard.pusher.com/accounts/sign_up and create a new account.
• From your dashboard at https://dashboard.pusher.com, choose the Beams product by clicking Get started.
• Enter the Instance name and create the instance. You can enter any value you want.
• From the left menu of the dashboard click Keys, copy the Instance ID and Primary key.
• Enter the Byra admin area, go to Settings > Notifications > Push notifications, and paste instance ID, primary key.
• If you are using the WordPress, you have to access the Byra admin area outside of WordPress, click here for more details.
• You're done. Pusher does not support iOS devices. You need to use OneSignal if you have an iOS device.

Activation - OneSignal

• Go to Settings > Notifications > Push notifications and select OneSingal as provider.
• Go to https://dashboard.onesignal.com and create a new account.
• Go to Settings > Platform create a push notification integration and select the Web Configuration.
• Enter a name and the domain where Byra is installed. Enter only the root domain URL, excluding the full admin Installation URL. For instance, if the Installation URL is https://www.example.com/Byra/admin.php, just enter https://www.example.com.
• If you are using the WordPress, you have to access the Byra admin area outside of WordPress, click here for more details.
• Scroll to Advanced Push Settings - Service Worker and enter the following service worker values.
  • Path to service worker files: get the value from Settings > Notifications > Push notifications > Service Worker path.
  • Main service worker filename: sw.js
  • Updater service worker filename: sw.js
  • Service worker registration scope: get the value from Settings > Notifications > Push notifications > Service Worker path.
• Scroll to CLICK BEHAVIOR and as Matching Strategy select Origin: Take actions on a previous tab open to the same domain.
• Click Save.
• Go to Settings > Keys & IDs and copy AppID and Rest API Key. Paste them into Byra > Settings > Notifications > Push notifications > App ID and API key. Click Save changes.
• For iOS users only, access the Byra admin area via Safari, then click the Share button and select Add to Home Screen.
• Reload Byra and you should see the prompt to activate the Push notifications. If you do not see it click Settings > Notifications > Push notifications > Subscribe.

Activation for users

• Download the service worker file here.
• Upload this file to your site at the following location: https://your-site.com/service-worker.js
• Go to Settings > Notifications > Push notifications > Service Worker URL and enter the URL of the file. E.g. https://your-site.com/service-worker.js.
• You're done.

Information

• Pusher is free to use for up to 1000 concurrent subscribers. While you should be able to use the free plan for the admin area and all the agents, you may need a paid plan for Push notifications sent to the users depending on your site traffic.
• Push notifications only work for full HTTPS websites. The only exception is localhost to ease development.
• When a user click the notification the last page visited by the user is open and the chat is open automatically.
• On desktop the browser needs to be running since that is the process that receives the push messages.
• When Push notifications are active, they replace desktop notifications.
• On Android and mobile devices, desktop notifications may not work, in which case you need to use Push notifications.
• Push notifications can not be received on a desktop PC unless a browser is running.
• Push notifications on iOS devices (iPhone) are available only from iOS 16.4. You need to install Byra as a PWA (details here). You need to use OneSignal. Pusher does not support iOS devices.
• If Push notifications are active and not working, go to https://dashboard.onesignal.com and delete all users from the Audience > Users. After that reset the OneSignal subscription and subscribe again, check the docs at https://documentation.onesignal.com/docs/clearing-cache-and-resetting-push-permissions for more details.

Push notifications for admin and agents

• When an agent click the notification the admin area is open and the right conversation is selected. If the admin area is already open the notification will not open a new tab.
• When a user sends their first message, a Push notification is sent to all validated agents; subsequent notifications are sent only to the last agent in the conversation.
• If you're using the Artificial Intelligence app, and Settings > Artificial Intelligence > Human takeover is active, no notifications are sent if the chatbot knows the answer.
• If you're using the WordPress version, Push notifications are not supported in the WordPress admin area, you need to access the Byra admin area directly, more details here.
• If the Routing setting is active, only the agent assigned to the conversation receive the notification, admins see all conversations but don't receive notifications.
• If queue or routing settings are active, only the agent assigned to the conversation receive the notification. Notifications are not sent for messages sent by the user while waiting in queue. Admins see all conversations but don't receive notifications.
• If a user conversation is assigned to a department, only the agents assigned to that department receive the notification.
• If a user conversation is not assigned to any department, only agents with no assigned department receive the notification.
• Notifications are sent only if the last agent in the conversation is offline.
• If human takeover is active, no notifications are sent if the chatbot knows the answer.
• If Push notifications are not working, make sure you allowed the notifications, in Chrome you can check this from Privacy and Security > Site settings > Notifications. If they don't work on a mobile device, try these steps too: install the PWA or delete it and install it again, restart the mobile device.
• If you are using Chrome, to enable Push notifications also when the tab is closed you must enable the Continue running background apps when Google Chrome is closed option from Chrome > Setting > System (chrome://settings/system).
• If Push notifications are not working, make sure that the conversation is not assigned to a specific agent or a wrong agent ID. Click here for more details.
• If Push notifications are not working, and you are using Windows, ensure that the notification feature is not being blocked by Windows. To do this, click on the Start button and search for Notifications. Then, open the Turn app notifications on or off option and verify that your browser is not being blocked.
• If Push notifications are not working, ensure that the Byra admin area is not visible and open. If the admin area is open, please minimize it or open another window or browser tab.
• If Push notifications are not working, your system might be blocking them. If you are using Windows 10+ check this link. If you are on Mac check this link. For all devices also check this link.

Desktop notifications

Desktop notifications

• Desktop notifications are not sent if the user is viewing a page with include the chat (the user browser is open and visible, and the active page contains the chat).
• Desktop notifications are not supported on iPhone and iOS devices.
• Desktop notifications work only for secure URLs that use HTTPS (not HTTP). Your Byra admin URL must use HTTPS.
• When Push notifications are active, they replace desktop notifications.
• If desktop notifications aren't working, try the solutions in the Push notifications section.

Text message notifications

Both agents and users can be notified via text message when a new message comes in. Text message notifications are provided by Twilio. Twilio is a paid service, but it is cheap, and you can use the trial version to test text message notifications for free. Text messages sent to your Twilio phone number can also be received in Byra. This allows you to chat with users via SMS in a true two-way messaging experience. More details below.

Activation

• Go to https://www.twilio.com and create a new account.
• Verify your phone number.
• Complete the form and choose SMS.
• Once into the dashboard, click Get a Trial Number, then Choose this number.
• Enter the Byra admin area, go to Settings > Notifications > Text message notifications, and paste account SID, auth token, trial number (or a purchased phone number). Find all details in the Twilio dashboard.
• If you're using the trial version, you can send notifications only to verified numbers. Enter the Twilio dashboard and click the left button # (Phone Numbers), then click Verified Caller IDs and add your phone number.
• To start using the service live and to receive text messages in Byra you need to purchase a phone number. After the purchase go to Phone numbers > Manage > Active numbers, click your number, and enter the URL of Byra, get it from Byra > Settings > Notifications > Text message notifications > Get configuration URL.
• You're done.

Information

• Ensure that your agents and admins are assigned a phone number so that agent text messages can be sent to the appropriate numbers.
• All phone numbers must have the country code starting with the symbol + (eg. +15558675310).
• You can get the user's phone number via registration form, follow-up message, or via [email] shortcode. You can manually enter the user phone from the admin area or via API.
• When a user sends their first message, if the conversation is assigned to a department, a test message is sent only to the agents assigned to that department, if the conversation is assigned to a specific agent, a text message is sent only to that agent, otherwise an text message is sent an email is sent to all agents who are not online at the moment. Subsequent text messages are sent only to the last agent in the conversation.
• Text message notifications are sent only if the last agent in the conversation is offline.
• If you're using the Artificial Intelligence app, and human takeover is active, no text messages are sent if the chatbot knows the answer.
• To use the Sender ID feature enter the sender name in the Sender number field.

Sound notifications

• When Settings > Notifications > Sounds are enabled, a sound will play whenever a new message or conversation is received.
• Audio will only play when the user or agent engages with the document by clicking somewhere in the admin area or on the page displaying the chat widget. This is because of a security feature of the browsers.
• If the sound is set to repeat, it will loop as long as the admin area or the chat widget page is not open or minimized. If the the admin area or the chat widget page is open and visible, you will not hear the sound.

ARTIFICIAL INTELLIGENCE

The settings below are related to the Artificial Intelligence app.

Installation

• From Settings > Apps, click Artificial Intelligence and enter your license key to install and activate the app. More details here. If you have the cloud version click Active.

Human takeover

The human takeover happens in these cases:

• When a human agent replies to a user's message.
• When the Settings > Artificial Intelligence > Human takeover option is active. It is triggered automatically when the chatbot fails to understand a user's message or it can be requested manually by the user explicitly asking to contact a human agent.

General information

• When the human takeover is activated the chatbot is automatically disabled for as long as the last human agent that replied to the conversation is online. If no agents have responded to the conversation yet, the chatbot will remain active. After that, the chatbot is activated again but no default fallback messages will be sent within 10 days of human takeover if the chatbot doesn't know the answer to the user's question in the same conversation. You can force a Dialogflow message to be always sent by adding to the Intent the custom Payload value "force-message": true.
• The chatbot is fully activated again if the conversation is archived or deleted.
• If you're using Slack, no messages will be sent if the chatbot knows the answer. Once the human takeover is active all conversation's messages are sent to Slack.
• When a human agent reply to a user the human takeover is activated automatically.
• The human takeover feature is compatible with OpenAI and will continue to function even if the Dialogflow chatbot is deactivated.
• To fully disable the chatbot on human takeover, check the option Human takeover > Disable chatbot.
• If the human takeover is already active, it will not be activated again, and the human takeover message will not be sent. The Fallback message will be sent instead.
• Human takeover works seamlessly across all messaging apps, like WhatsApp, Messenger, Telegram, and others. Users don't need to click a confirmation button, any text reply confirming the request will activate the human takeover automatically.

Human takeover option

When the option Human takeover is active the following happens:

• If enabled, the request is sent only if the message sent by the user is longer than 3 chars and contains at least two words. This optimization prevents mistaken requests.
• The conversations to which the chatbot was able to answer correctly, are marked as read and moved at the bottom of the Inbox list.

When the user confirms the human takeover, or if it is automatic, the following happens:

• The conversation is marked as unread and moved on top of the Inbox.
• Any future user messages in the same conversation sent within 10 days of the human takeover will trigger agent notifications.
• If agents email notifications are active, an email notification is sent to the agent assigned to the conversation, or, if the user's conversation is assigned to a department, to the agents assigned to that department, otherwise it is sent to all offline agents.
• If Push notifications are active, a push notification is sent to the agent assigned to the conversation, or, if the user's conversation is assigned to a department, to the agents assigned to that department, otherwise it is sent to all offline agents.
• If text message notifications are active, a text message is sent to the agent assigned to the conversation, or, if the user's conversation is assigned to a department, to the agents assigned to that department, otherwise it is sent to all offline agents.
• No human takeover requests within 10 days of the human takeover will be sent in the same conversation.
• The follow-up message and offline message are activated.
• If queue settings are active, the queue or routing is activated.

Manual human takeover - Dialogflow Only

• You can manually trigger the human takeover by creating a new Dialogflow Intent with the following Custom Payload response: { "human-takeover": true }.
• The manual takeover automatically notify agents via email and leave the conversation marked as unread.
• To manually send a human take over request use the chips rich message with ID sb-human-takeover. Ex. [chips id="sb-human-takeover" options="Human support,Cancel" message=""].

Manual human takeover - OpenAI Only

• The human takeover can be requested manually by the user explicitly asking to contact a human agent. This setting is active by default. This setting is not compatible with older OpenAI models like gpt-3.5-turbo.

Human takeover via Q&A

You can enable the human takeover for specific user messages via Q&A by adding the human takeover action in set data and actions.

OpenAI Assistant

To enable human takeover on an OpenAI Assistant add the following function in the OpenAI functions area:

                                {
                                    "name": "sb-human-takeover",
                                    "description": "I want to contact a human support agent or team member. I want human support.",
                                    "parameters": {
                                        "type": "object",
                                        "properties": {},
                                        "required": []
                                    }
                                }
                            

Smart reply

Smart Reply suggests quick responses in real-time during a conversation. Once active, you will see the suggested replies in the conversation area, if any.

Information

• The Smart Reply feature initially checks for suggestions from the Dialogflow chatbot, provided it is active. If there is at least one suggestion, it will promptly display the results. However, if Dialogflow is inactive, or there are Dialogflow suggestions, the OpenAI suggestions will be returned instead.
• If the language detection feature is active, the smart replies will use language detection as well.
• If the multilingual via translation feature is enabled, the smart replies will utilize multilingual translation as well.
• To read the complete text of a smart reply, hover the mouse pointer over it for a duration of 3 seconds.
• To restore the previous message, press the keyboard shortcuts CTRL + Z.

Optimal configuration for the chatbot

Byra provides powerful tools to assist you in the process of creating the chatbot.

• Activate Artificial Intelligence > Google > Dialogflow chatbot. If you have general or specific inquiries that require a definitive response, or if you want to use rich messages like buttons, the Dialogflow chatbot is the best option and it can work alongside the OpenAI chatbot. The Dialogflow and OpenAI chatbots can work together simultaneously. More details here.
• Keep improviding the chatbot from the chatbot training panel.
• Activate Artificial Intelligence > Smart Reply. More details here.
• Activate the following OpenAI settings: Chatbot, Spelling Correction, Dialogflow spelling correction, Rewrite Message Button. More details here.
• Train your OpenAI chatbot with your own content, more details here.
• Set the value of Google > Dialogflow Intent detection confidence to 0.81.
• If your website receives traffic from multiple countries, consider activating the following Google options: multilingual via translation, automatic translation, language detection.
• Change the chatbot name from Settings > Users > Bot name.

Problems?

The most frequent reasons for OpenAI or Google not functioning properly are listed below. For more details about the issue, open the browser developer tools and then the console tab, send a message through the Byra chat, and an error should appear in the console. On Chrome you can open the console from Settings > More tools > Developer tools > Console.

OpenAI and Google

• There is a human takeover.
• You can hire us to make the synchronization for you, details at the hire us page.

OpenAI

• Click the Settings > Artificial Intelligence > OpenAI > Troubleshoot problems button and check for any error. If there is an error, it will be related to your OpenAI account, follow the error message instructions to fix the issue.
• Make sure to check the option Settings > Artificial Intelligence > OpenAI > Chatbot.
• You reached the quote limit or you are encountering billing problems with your OpenAI account. Check it at https://platform.openai.com/account/usage.
• If Dialogflow is enabled, OpenAI may not work correctly because your Dialogflow agent does not have the Fallback Intent. Please verify its presence on the Intents page, and if it's missing, you can create it again by following the instructions here. To quickly check if this is the issue, you can disable Dialogflow and send a message consisting of 2-3 words. Then, check if the browser console has errors.
• If the chatbot is not replying at all and you have some Google setting active, try to disable the Google settings and check if the chatbot is working.
• Make sure to read the general information.
• If the training is not working as intended, for instance, if the chatbot is not responding to questions relevant to the training data, and no training errors are being shown, there may be file permission issues. To address this, please ensure that the uploads folder includes the embeddings folder. It must exists and contains files. This issue only affects the PHP or WordPress versions, if your are using the cloud version ignore this point.
• If the training is not working as intended, for instance, if the chatbot is not responding to questions relevant to the training data, try to delete all training data from Chatbot > Training > Informaion > Delete all training data and train the chatbot again.
• If the training is not working as intended, for instance, if the chatbot replies are cut off or partially incorrect, try asking the same question a few more times. The responses should improve over time. OpenAI is needs to learn from the user interactions.
• If your training data is from a website, and the website is multilingual, make sure the lang attribute of the <html> tag contains the correct language.
• Delete all of your OpenAI settings, leave only the OpenAI key and try again.
• Try to use the OpenAI assistant instead.
• If you are using the cloud version, you can use our OpenAI key by setting Settings > Artificial Intelligence > OpenAI > Sync mode to Automatic. If this resolves your problems, it means that the issue originates from your OpenAI account. You need to purchase credits to use this option.

Google

• Click the Settings > Artificial Intelligence > Google > Troubleshoot problems button and check for any error. If there is an error, it will be related to your Google account, follow the error message instructions to fix the issue.
• Make sure to check the option Settings > Artificial Intelligence > Google > Dialogflow chatbot.
• If your synchronization was not successful we suggest reviewing our documentation and repeating the synchronization steps to correct any errors. If needed, we provide integration services. Details at the hire us page.
• You selected the wrong agent location.
• Make sure are not using a mega agent.
• Make sure to read the general information.

OpenAI

The settings below are related to the Artificial Intelligence app.

Synchronization

Automatic sync mode

This feature is available only on the cloud version of Byra.

• The automatic sync mode is ready-to-use and does not require any additional settings. Set it at Settings > Artificial Intelligence > OpenAI > Sync mode.
• If you want to activate the chatbot, check Settings > Artificial Intelligence > OpenAI > Chatbot.
• You need to purchase credits to use this option.

Manual sync mode

The OpenAI (ChatGPT) integration gives your chatbot the ability to answer general questions about almost anything you can imagine. To start using it, follow the steps below.

• Register at https://platform.openai.com/.
• Get an API key from https://platform.openai.com/api-keys and paste it into Settings > Artificial Intelligence > OpenAI > API key. If you are using the cloud version, set Settings > Artificial Intelligence > OpenAI > Sync mode to Manual.
• Enable the chatbot from Settings > Artificial Intelligence > OpenAI > Chatbot.

Chatbot

To set up your first chatbot, follow these steps:

• Complete the synchronization process.
• Enable the Settings > Artificial Intelligence > OpenAI > Chatbot option, and save your changes.
• Your chatbot should now be active. The playground is accessible from the Chatbot area, which you can find by clicking the 🙂 smile icon on the left menu. If the chatbot isn't working, click the Settings > Artificial Intelligence > OpenAI > Troubleshoot problems button and follow the instructions.
• To further improve your chatbot, explore the training and human takeover sections.

Chatbot Integrations

The following integrations are available from Settings > Artificial Intelligence and can be used to enhance the OpenAI chatbot's capabilities. Integrations are conversational, multilingual, and compatible with any messaging app such as WhatsApp, Messenger, Telegram, and more.

Google Calendar

Enable this integration to allow the OpenAI chatbot to access your Google Calendar, so users can book appointments and manage them on your calendar.

Tasks

• Book an avent: The chatbot can book events in your Google Calendar on behalf of the user.
• Update an avent: The chatbot can update an existing event for a user in your Google Calendar.
• Cancel an avent: The chatbot can cancel an existing event for a user in your Google Calendar.
• List events: The chatbot can list the events of a user from your Google Calendar.
• Show available booking times: The chatbot can show the available booking times.

Setup

• Go to Settings > Artificial Intelligence > Google Calendar integration and click Activate.
• Click Settings > Artificial Intelligence > Google > Synchronize and complete the synchronization process.
• Set the available booking times under Settings > Miscellaneous > Scheduled Office Hours.
• You are done. The chatbot can now book and manage events in your Google Calendar.

Information

• The Slot duration setting is the duration of the booked event.
• The Buffer time setting is used to add a buffer (in minutes) between bookings so you are not booked back-to-back.
• The Minimum booking time setting is the minimum time (in minutes) required to book an event from the current time. It is used to prevent bookings too close to the current time.

TidyCal

Enable this integration to allow the OpenAI chatbot to access your TidyCal account, so users can book appointments and manage them on your TidyCal account.

Tasks

• Book an avent: The chatbot can book events in your TidyCal on behalf of the user.
• Update an avent: The chatbot can update an existing event for a user in your TidyCal.
• Cancel an avent: The chatbot can cancel an existing event for a user in your TidyCal.
• List events: The chatbot can list the events of a user from your TidyCal.
• Show available booking times: The chatbot can show the available booking times.

Setup

• Go to Settings > Artificial Intelligence > TidyCal integration and click Activate.
• In your TidyCal account, go to Integrations > Advanced > API Keys or click here. Create a Personal Access Token, copy it, and paste it into Settings > Artificial Intelligence > TidyCal integration > Access token. Then, save the changes.
• Enter the title of the booking type you want to use in Settings > Artificial Intelligence > TidyCal integration > Booking type title, and save the changes.
• Configure the available booking times, buffer times before and after bookings, and the slot duration directly in your TidyCal account.
• You are done. The chatbot can now book and manage events in your TidyCal account.

Information

• Only events without a price are supported.
• The selected booking type is cached for 24 hours. If you update it, you may need to wait up to 24 hours for the changes to take effect. To apply changes immediately, create a new booking type or change its title and update it in the Byra settings.

Settings

See information about most OpenAI settings here.

Chatbot mode

This feature is related to the Settings > Artificial Intelligence > OpenAI > Chatbot mode option. It allows you to configure the information OpenAI will use to respond to user messages.

• Only general questions OpenAI will respond only to general questions and questions related to previous user messages in the same conversation, without using any information you provide. This is the default setting.
• Only questions related to your sources OpenAI will only respond to questions related to the information you provide. The user messages will be ignored. You have to first train the chatbot with your sources.
• All questions OpenAI will only to questions related to the information you provide, to general questions, and to questions related to previous user messages in the same conversation. You have to first train the chatbot with your sources. This is the recommended mode.
• Assistant Use this mode if you are using an OpenAI Assistant.

Assistant

This features allow you to use your own Assistants created at https://platform.openai.com/assistants.

• If you are using the cloud version you have to set Settings > Artificial Intelligence > OpenAI > Sync mode to Manual and use your own API key.
• You can use multiple assistants by adding their IDs in Settings > Artificial Intelligence > OpenAI Assistants - Department linking and selecting Assistant in Settings > Artificial Intelligence > OpenAI > Chatbot mode. To activate an assistant, both the assistant and the conversations must be assigned to a department.
• The assistant is used only for the chatbot, and smart replies, not for the message rewriting and other features.

Chatbot

The OpenAI chatbot feature functions similarly to Dialogflow, providing automated responses to user messages. Select the Chatbot mode setting to specify the questions that the chatbot is capable of responding to. Utilize the human takeover feature to enable the chatbot to redirect the chat to a human agent as necessary.

Fallback message

The fallback message is sent when OpenAI is unable to understand the user question. If the Dialogflow chatbot is enabled, the fallback message will be turned off and the Dialogflow chatbot's fallback message will be utilized instead.

Prompt

The prompt instructs OpenAI on how to respond by providing relevant information that can be utilized to answer user inquiries. To comprehend the process, refer to the example prompts listed below.

If you choose to activate the human takeover feature, you need to tell OpenAI to respond with I don't know if it is unable to provide an answer to the user's question. You should always include the following text in the prompt: Respond "I don't know", if not sure about the answer.

Prompt - Message rewriting

This prompt instructs OpenAI on how to rewrite a message when the Message rewrite button is active. This prompt should be in English. Byra automatically add the following text when required: and use the user langauge, add greetings.

Replies from the training sources can be utilized with the prompt feature as they are compatible.

Spelling correction

This feature automatically fix any spelling mistakes in the agent's message.

Training data language

If you are using training data and your chatbot is multilingual, set here the default training data language. Leave it as default if the training data default language is in English.

Smart reply

This feature allow to enable the Smart Reply feature also if the chatbot is not active. If the chatbot is active the Smart Reply feature will use OpenAI automatically.

Dialogflow spelling correction

In the case where Dialogflow is unable to find the appropriate response to the user's message, this function verifies if there are any spelling errors. If any such errors exist, Dialogflow is prompted again with the correctly spelled version of the message for an accurate response. Although it has a higher priority, this feature can still work together with the Google search spelling correction feature.

Message rewrite button

This feature adds a button to the text field of the conversation area, click on it to rewrite your message and make it more friendly and professional. Greetings will be added automatically if there is no previous agent messages. If your language is not English, you have to edit your agent/admin profile and set the correct language.

Speech recognition

OpenAI supports the use of voice messages through speech recognition. When this option is active, audio messages will be converted to written text.

• You do not need to activate this feature for the chatbot to understand audio messages. The speech recognition feature of the chatbot is always enabled.
• For this feature to work better, the user language should be know. To automatically detect the user's language, you can enable the language detection feature.
• The text will be displayed alongside the audio player.
• The generated text is compatible with the translation features.

Image recognition

When this option is enabled, the chatbot analyzes and interprets images sent by the users.

• Only GPT-4 models and newer support this feature.
• This feature does not work on localhost, it requires an online server or AWS S3.

Source links

When this option is active, the response will automatically include the links to the sources and training data used for generating the answer. To include articles as sources you have first to set the articles page in Settings > Articles > Articles page URL.

Note data scraping

When this option is active, you will see a menu in the notes panel. The menu enables the automatic extraction of specific information from the user's messages like login details, URLs, or even the summary of the conversation.

OpenAI parameters

Byra allows you to adjust various OpenAI parameters such as temperature and logit_bias, for more details visit https://platform.openai.com/docs/api-reference/completions/create. Don't set any values if you don't know what these parameters do or OpenAI may stop working.

Logit bias

The Logit bias parameter must be JSON string and the keys must be strings, for example: {"2435":-100, "640":-100}.

Generate user questions

When this option is active, OpenAI will generate new user questions in real time when you open the chatbot training panel.

Use conversations for training

Automatically use conversations to train the chatbot at regular intervals. You will find the training data in Chatbot > Training > Conversations. The training is done via cron job every 24 hours. Only user and agent messages are used, chatbot messages are ignored. More details here.

Context awareness

When this option is enabled, OpenAI will recognize the context of the web page from which the user is writing the message. The context includes only the page's meta title and meta description texts. T his option is supported solely for the chat widget and is not compatible with messaging channels.

Training

With this feature, your chatbot can undergo training using your website, texts, PDF documents and more. Once the training is successfully completed, the chatbot will be able to answer questions related to your contents.

Training using files

This training process enables you to train the chatbot using PDF and TEXT files.

• To access this feature, navigate to Chatbot > Training > Files.
• Select your files, click the Train chatbot button and await completion of the training process.
• It is only possible to upload files in PDF and TXT formats.
• As soon as the training is completed, the uploaded files are removed.

Training using a website

This training process enables you to train the chatbot using websites.

• To access this feature, navigate to Chatbot > Training > Website.
• Enter the website URLs, click the Train chatbot button and await completion of the training process.
• If you retrain the same website, you must first delete the previous website's training data; otherwise, only new URLs will be trained.
• You can provide the website URL and all child URLs will be included and crawled, but with large websites, it is more efficient and less prone to errors and infinite link loops to utilize an XML sitemap instead of relying on the website URL. You can create it with a service like https://www.xml-sitemaps.com.
• If you want to train your chatbot using specific pages from your website instead of all of them, you can make use of an XML sitemap. Create one using a tool like https://www.xml-sitemaps.com, and then remove the pages you do not wish to include by editing the file in a text editor. To use the XML sitemap, you need to upload it either onto your server or an external online location. Afterward, add the URL of the sitemap in Chatbot > Training > Website. If your sitemap contains more than 1000 URLs, it's advisable to split it into multiple files and train the chatbot with one file at a time to prevent server crashes.
• You can upload large files and your XML sitemap with a service like https://tmpfiles.org.

Training via questions and answers

This training process enables you to train the chatbot by adding questions and answers individually.

• To access this feature, navigate to Chatbot > Training > Q&A.
• For more details click here.

Training using articles

This training process enables you to train the chatbot using the articles.

• To train the chatbot add you articles and than click the Train chatbot button. The articles are used as training sources automatically.
• For more details click here.

Training using flows

This training process enables you to train the chatbot using the flows.

• To access this feature, navigate to Chatbot > Flows.
• For more details click here.

Training using conversations

This training process enables you to train the chatbot using the conversations from the users and agents.

• To enable this feature, check the Settings > Artificial Intelligence > OpenAI > Use conversations for training option.
• The training data will begin to be generated in the coming days and will be available in the Chatbot > Training > Conversations area.
• While this method is powerful and automated, it can produce low-quality training data if the responses from your human agents or the user messages are unhelpful or incorrect. We strongly recommend reviewing the training data regularly. This method is not recommended for most chatbots. Use the chatbot training panel instead.

Training using the chatbot training panel

Once you have finished training your chatbot, you may want to continue enhancing it. This feature allows you to select conversation messages and use them to add new questions and answers or improve existing ones. You can open the chatbot training panel from the conversation area by hovering the mouse over a message, opening the message's menu, and selecting Train chatbot.

• If Dialogflow is active, a new Intent will be added to the main Dialogflow agent.
• If OpenAI is active, the OpenAI chatbot will be trained automatically with the new information. You can control the questions and answers generated from this window from Chatbot > Training > Questions and answers.
• The Services to update option let you choose what chatbots to update. When updating a Dialogflow Intent, a new OpenAI question and answer will be generated.
• The training window is not compatible with OpenAI assistants.

Training using real-time information

This feature allow the chatbot to answers to questions that require real-time information, such as, "What is the temperature in London today?".

• For more details click here.

Information

• To add new training data, simply train the chatbot again. The previous training data will not be lost, and only the new sources will be added.
• If you are using the cloud version, there are character limits for training the chatbot. However, if you are using the PHP or WP version, there are no limits imposed. You can view the character limits here.
• The embedding model is essential for training your chatbot and handling all user messages. We currently use the text-embedding-3-small model. It is necessary for these scenarios and cannot be disabled or changed. You can find pricing information at https://openai.com/pricing. Check out the pricing for the text-embedding-3-small model in the Embedding models section.
• Go to Chatbot > Training > Information, and click the Delete all training data button to remove all previous training data for the chatbot.
• The embeddings are stored as JSON files in the Byra uploads folder and are secured using the password-by-filename approach.

Run the training via cron job

If you're using the cloud version, just enable the Settings > Artificial Intelligence > OpenAI > Training via cron job option and the cron job will be activated. You can disregard the instructions below.

To automatically train the chatbot with your website content at regular intervals, create a cron job that runs the URL [Byra-URL]/include/api.php?open-ai-training=true, or use the command */59 * * * * wget [Byra-URL]/include/api.php?open-ai-training=true to run it via a command. Replace [Byra-URL] with your Installation URL, get it from Settings > Miscellaneous > Installation URL. If you are using the cloud version, use this URL: https://cloud.Byrachat.com/script/include/api.php?open-ai-training=true&cloud=API-TOKEN and replace API-TOKEN with your API token.

• For the cloud version, the cron job can be executed at most once every 7 days.
• We strongly recommand providing an XML sitemap instead of the website URL for performance reasons.
• Automatic training is limited to websites; files, Q&A, and articles are excluded. Re-training will delete the previous website training data.

Multilingual training

If your user base is multilingual, you can train the chatbot with content in multiple languages and limit the chatbot to retrieve answers only from the sources in the user's language. To activate this feature, check the Settings > Artificial Intelligence > OpenAI > Multilingual Training Sources option.

• Files Files currently support only one language.
• Websites The language of the website is detected automatically. For Byra to comprehend the language of your web pages, the <html> must contain the attribute lang.
• Q&A Q&A currently support only one language.
• Articles All article languages are used automatically.
• Conversations If automatic translation is active, only messages in the agent's language will be used.

Q&A

The information below is related to the Question and Answers section of the chatbot training area. Add questions and answers to the chatbot to improve its performance. The chatbot will use this information to respond to user inquiries.

Question

Enter the user messages that will trigger the answer. Add as many question variations as necessary. For example the questions to the answer I'm a chatbot! could be Who are you?, What are you?, Are you a bot?.

Answer

Enter the text that will be used to answer the user question.

Tools calling

For more details go here.

Set data and actions

Set the specified user values when the question is asked. You will see such values in the user details panel. You can use the following merge fields to assign values extracted from the user messages. Include these fields in the answer and they will be replaced with the actual values: {language}. You can also use this feature to perform actions like assigning departments, agents, and tags to the conversation.

Flows

The information below is related to the chatbot flows area. Flows allows you to esely create conversation flows powered by the chatbot. Use them to guide the user toward a specific goal with a series of pre-defined messages.

Flow blocks

• Start: Use the start block to set when the flows should start. It can be everytime the user start a new conversation, when it sends a specific message, or on page load. If you set conditions, the flow will only start when all conditions are met. If you set a depertment, the flow will only start for conversations assigned to that department. If you set a source, the flow will only start for conversations from that source.
• Send message: Send a message to the user.
• Send choices: Send a list of buttons to the user or allow it to choose one. When conversational mode is enabled, buttons are hidden, the chatbot sends only text, and users select options by replying with text. The AI interprets the message and selects the corresponding option, continuing the flow as if the button were pressed. This creates a more natural, chat-like experience and is automatically activated, only when needed, on messaging channels such as WhatsApp and Instagram. If the user's reply doesn't match any option, a fallback message with the available choices will be sent. You can add variations to the button texts by separating them with the | char, for example: Yes|Yeah|Sure. They will help the AI to understand the user reply.
• Send video: Send a video to the user.
• Get user details: Get the user details and store them in Byra. You will see such values in the user details panel. You can leave the description field empty for default details, but it's required if using custom user fields. Note that user details will not be saved if you test this flow in the playground, as the user there is temporary. To see details saved, test the flow with a real user.
• Set data: Set the specified user values when the block is executed. You will see such values in the user details panel.
• Actions: Execute the specified actions when the block is executed.
• Conditions: Use it to create different branches in the flow. If the conditions are met, the flow will follow the branch set as true, otherwise the one set as false.
• Rest API: Use it to send data to your server. The body must be a JSON array. Details like user ID and conversation ID are automatically included in the data sent to your server under the sb key. Use the save response section to save specified user details with values from your server response. Use the JSON dot notation. Our support doesn't include assistance with this feature, as it is for advanced users and requires custom code on your server. For help with this, feel free to hire us.
• Tools calling: For more details go here.
• Flow connector: Connect the flow to another flow and start it.

Information

• Flows can be multilingual. Add translations for messages, button texts, and other content in the translations area. You can also use the multilingual via translation feature for automatic translations. If the default language of your flows is not English you have also to set the default language under Settings > Artificial Intelligence > OpenAI > Training Sources Language.
• Users can move back to earlier steps and update previously entered details in a conversational manner. For example, they might say "Sorry, I entered the wrong email", "I need to update my email and phone number", or even a general message like "Sorry, I entered the wrong details, go back", which will return them to the previous step.

Tools calling

Tools calling allows to connect the chatbot to external tools and systems to retrive information needed to answer the user. The chatbot will query your server and return the information from your server to the user. The data sent to your server is in the body and it includes the user input, user ID, and conversation ID. Tools calling is used by Q&A and Flows. More details here. Our support doesn't include assistance with this feature, as it is for advanced users and requires custom code on your server. For help with this, feel free to hire us.

Parameters

• URL: Enter the URL of the API endpoint that will supply the necessary values for the function.
• Headers: If you are setting up a Q&A, enter key-value header parameters, separated by commas. E.g. apikey:123345, json:true. If you are setting up a flow, enter add key-value header parameters by clicking the Add new item button.
• Properties: Enter values that the user must provide to the chatbot. For example a city, a tracking number, etc. The chatbot will ask the user for these values. If you already know all the possible values, you can enter them in the Allowed values field.

Data sent to your server

Byra will send the following information to your server. If you use the POST method, it will be included in the JSON body, if you use the GET method, it will be included in the header.

{
    "sb": {
        "user_id": "123",
        "conversation_id": "123",
        "user_language": "es"
    },
    "arguments": {}
}

The arguments array contains the values provided by the user. The keys are the name converted to kebab case, for example if the property name is Order Number, the key will be order-number. The user_id is the ID of the user in Byra and conversation_id is the ID of the conversation. You can use these IDs to retrieve more information about the user and the conversation via the REST API.

Response from your server

Your server must returns a JSON array with the values required by the chatbot. Include success: true only when the request is successful and the expected information is returned. Do not include it if the information cannot be retrieved (e.g., when an invalid order number is provided). See the example below for more details.

{
    "order_status": "Delivered 2 hours and 25 minutes ago",
    "success": true
}

Information

• If OpenAI is not working, click here.
• If Dialogflow is active, the OpenAI query is performed only if the chatbot does not know the answer to the user's question and if the length of the user's message is greater than 4 characters.
• The following settings are compatible with OpenAI: smart reply, human takeover, disable for the tickets area, disable during office hours, bot response delay, reply to user emails, reply to user text messages.
• The following Google settings are compatible with OpenAI: multilingual via translation, automatic translation, language detection.
• Set the OpenAI chatbot language from Settings > Chat > Language. Set it to Multilingual if your website supports multiple languages or if your users speak different languages. If you are using messaging channels like WhatsApp, or Instagram, you must detect the user language via language detection. For more details click here.
• If a human takes control, the OpenAI chatbot is deactivated, and is remains deactivated also if the agent goes offline. The Dialogflow chatbot continues to function whenever necessary.
• The default model is gpt-5-mini.
• Consecutive user messages are treated as a single message by the chatbot, resulting in one unified reply

Google

The settings below are related to the Artificial Intelligence app.

Synchronization

To start using the Google AI services and Dialogflow follow the steps below.

Automatic sync mode

This feature is available only on the cloud version of Byra.

• Click Synchronize now and complete the procedure.
• If you want to activate the Dialogflow chatbot, check Settings > Artificial Intelligence > Google > Dialogflow chatbot. Also, you have to enter your chatbot Project ID or Agent Name, to get it follow the steps below.
• You need to purchase credits to use this option.

Manual sync mode

• Enable the Byra > Settings > Artificial Intelligence > Google > Dialogflow Chatbot option and save the changes.
• Go to console.cloud.google.com and sign in.
• Select or create a project by clicking the Select a project button on top-left. Name the project as you want.
• Activate the Dialogflow API by entering Dialogflow API on the top search bar. Click Dialogflow API and then click Enable. Do the same for the Cloud Natural Language API, Cloud Translation API, and Google Calendar API.
• Select the project and the go to Left menu > APIs and services > OAuth consent screen. Select External and click Create. In App name enter what you want, in User support email and Developer contact information enter your email. Click Save and continue.
• In the Data access area, click Add or remove scopes, scroll bottom and into the Manually add scopes area enter https://www.googleapis.com/auth/dialogflow,https://www.googleapis.com/auth/cloud-language,https://www.googleapis.com/auth/cloud-translation,https://www.googleapis.com/auth/calendar. Click Add to table and then Update and Save and continue.
• In the Audience area, click Add users and add your Google email, use the same email as the currently logged in account. Click Save and continue. Click PUBLISH APP. There is no need to complete the review process, leave it in the pending review state.
• Go to Left menu > APIs and services > Credentials and click Create credentials, select OAuth client ID. As Application type select Web application. Enter any name you want. In Authorised redirect URI enter the redirect URL, get it from Byra > Settings > Artificial Intelligence > Google > Authorised redirect URI. Click Create.
• Copy Client ID and Client Secret and paste them into Byra > Settings > Artificial Intelligence > Dialogflow. Save the settings.
• Click Byra > Settings > Artificial Intelligence > Google > Synchronize. Login with the same Google account you have used till now. On the next screen click Continue. On the next screen select all scopes and click Continue.
• Copy the Refresh token and paste it into Byra > Settings > Artificial Intelligence > Google > Refresh token.
• You are done! If you want to activate the Dialogflow chatbot, check Settings > Artificial Intelligence > Google > Dialogflow chatbot. Also, you have to enter your chatbot Project ID or Agent Name, to get it follow the steps below. Note that the app does not need to be approved by Google.
• If you are a Google Workspace user, go to https://admin.google.com/ and click Google Cloud Session control. Set Re-authentication policy to Never require re-authentication.

Dialogflow

The information provided below is relevant to Dialogflow. Warning! We will stop supporting Dialogflow by the end of 2025. All its features will be available in Byra through OpenAI. Please use OpenAI instead of Dialogflow.

Get Project ID

• Log in to the Dialogflow ES console by going to dialogflow.cloud.google.com. You must sign in with the same Google account used during the synchronization.
• Click the gear icon at the top left, near the chatbot name, and open the settings area. . If you haven't created a chatbot yet, follow the instructions below to create your first bot.
• Copy the Project ID .
• Make sure to choose US / GLOBAL on the top left of the Dialogflow dashboard. Please note that our system does not support mega agents. .

Get Dialogflow CX Agent Name

• Log in to the Dialogflow CX console by going to https://dialogflow.cloud.google.com/cx/.
• Select the project of the desidered agent and go to the agents page. You can enter the agents page by selecting the agent and by clicking the top button Agents > View all agents .
• Click the options menu for the desiderate agent in click Copy name .
• More details at https://cloud.google.com/dialogflow/cx/docs/quick/api#detect-intent-drest.

Location

Set the location or region of your Dialogflow agent. This setting is optional if your agent location is set to global.

Welcome Intent

Trigger the Dialogflow Welcome Intent for new visitors. The option Settings > Messages & Forms > Welcome message must be active.

Send the user details

Send the user details of the registration form and email rich messages to Dialogflow.

Add Intents to saved replies

Include the Dialogflow Intents into the saved replies. To access the saved replies option, go to Settings > Admin > Saved replies.

Create a basic chatbot

If you haven't created a chatbot yet, follow the instructions below to create your first one. The creation and management of your Dialogflow chatbot is handled entirely by Dialogflow. There are a lot of tutorials online that can help you create and configure your Dialogflow bot.

• To create your first chatbot enter the Dialogflow console and create an agent. As Google project select the same project used during the synchronization.
• Add a new Intent from the left menu and open it.
• In the Training phrases area adds the user's question you want the chatbot to reply to, add as many variants are you can. For example, if you want to the chatbot to reply to users asking for your business address, add variants like "what is your address", "address", "where are you".
• In the Responses area adds the chatbot answer as a text response. If you want to add buttons, cards, etc., you can use the rich messages.
• You have created your first question and answer! Test if from the right area or from the Byra chat. Add new Intents to populate your chatbot with the questions and answers you want. You can include basic pre-built questions and answers by enabling the Small Talk feature from the left menu.

Here are some great resources to help you build a more complex chatbot:

• chatbotslife.com/dialogflow-restaurant-bot-tutorial-1-45ce1d3c0ab5.
• tutorials.botsfloor.com/building-your-own-chatbot-using-dialogflow-1b6ca92b3d3f.
• marutitech.com/build-a-chatbot-using-dialogflow/.

Actions

The following actions give the chatbot the ability to interact with the website autonomously on behalf of the user. To use an action go to Dialogflow, edit an Intent, and add a new Custom Payload response with the following syntax: { "ACTION-NAME": ACTION-VALUE }.

{ "human-takeover": true }

{ "redirect": "URL" }

{ "open-article": ID }

{ "transcript": true }

{ "tags": ["Tag 1", "Tag 2"] }

{ "department": ID }

{ "agent": ID }

{ "send-email": { "recipient": "active_user", "message": "", "attachments": [] } }

{ "update-user": true }

{ "archive-chat": true }

{ "update-user-details": { "email": "", "last_name": "", "first_name": "", "extra": { "phone": ["+123456789", "Phone"] }}}

{ "update-user-language": "$language" }

Dialogflow fulfillment

The fulfillment data sent to your webhook URL is like below:

 {
 	"responseId": "4a58fc4f...",
 	"queryResult": {
 		"queryText": "fullfilment",
 		"parameters": [],
 		"allRequiredParamsPresent": true,
 		"fulfillmentText": "Example",
 		"fulfillmentMessages": [{
 			"text": {
 				"text": ["Response"]
 			}
 		}],
 		"outputContexts": [{
 			"name": "projects/schiocco...",
 			"parameters": {
 				"no-input": 0,
 				"no-match": 0
 			}
 		}],
 		"intent": {
 			"name": "projects/schiocco...",
 			"displayName": "Fullfilment"
 		},
 		"intentDetectionConfidence": 1,
 		"languageCode": "en"
 	},
 	"originalDetectIntentRequest": {
 		"payload": {
 			"support_board": {
 				"conversation_id": "3002",
 				"user_id": "3777"
 			}
 		}
 	},
 	"session": "projects/example/agent/sessions/3777-3002"
 }

The payload and session fields contain the Byra user ID and conversation ID.

Dialogflow Information

OpenAI

If OpenAI is enabled, Dialogflow takes priority over it. The OpenAI API will only be used if Dialogflow cannot answer the user's question.

Chatbot training and optimization

• It will require some time for your chatbot to consistently provide correct answers to all questions. To improve its performance, you and your human agents should continuously train the chatbot by incorporating new question variations and Intents. This approach will effectively enhance the capabilities of your chatbot.
• Agents can add new Intents and chatbot responses, and add new training phrases to existing intents on the fly from the admin area by moving the mouse cursor over a message and clicking the Dialogflow Intent icon. Enable Settings > Artificial Intelligence > OpenAI > Generate user questions to automatically add variations of the question and to rewrite the answer. New Intents will contain also the responses, while the update of existing intents will add new training phrases only, but not new chatbot responses. If you're using Dialogflow CX, the chatbot responses will be added to the latest flow used in the conversation if any, otherwise to the start flow.
• If the chatbot is replying with the wrong intents, go to Dialogflow Console > chatbot Settings > ML Settings, and set the ML CLASSIFICATION THRESHOLD to a larger number, such as 0.6. Also check the Intent detection confidence.

Dialogflow Intent detection confidence

When searching for a matching intent, Dialogflow scores potential matches with an intent detection confidence, also known as the confidence score. These values range from 0.0 (completely uncertain) to 1.0 (completely certain). Specify a value ranging from 0.1 to 1.0. Any answer provided by Dialogflow that is less than this value will not be considered. If you are utilizing Dialogflow alongside your OpenAI chatbot that is trained using your resources, it is recommended to configure the value as 0.81.

Knowledge Base

Knowledge Base are automatically enabled. Knowledge Base is a feature that gives your chatbot the ability to search within documents (such as a PDF) or web pages to find an answer. To create your first Knowledge Base, go to cloud.google.com/dialogflow/docs/knowledge-connectors

Dialogflow response

The full Dialogflow JSON response is automatically saved in the database, sb_messages, column payload.

Ignore an Intent if it doesn't fit the provided keywords

Sometimes Dialogflow gives incorrect answers due to similar questions with different subjects. To solve this, you can instruct Byra to ignore an Intent if specific keywords are not present in the user's message. Here's how you can do it:

• Enter Dialogflow and edit the Intent.
• For each training phrase, select the keywords you want to be required and link them to a new Entity, or an existing one.
• Under Actions and parameters check Required and add a new Prompt with value skip-intent
• Save the Intent.

User attachments

User attachments are sent to Dialogflow by appending the attachment URLs to the message.

Chatbot attachments

To allow the chatbot to send attachments, add a Custom Payload response and insert this JSON code:

                                    { "attachments": [["name", "YOUR-LINK"], ["name", "YOUR-LINK"], ["name", "YOUR-LINK"]]}
                                

Rich messages

To allow Dialogflow to send rich messages, simply enter the rich message shortcode into the TEXT RESPONSE field or add a new Custom Payload response and insert this JSON code: { "rich-message": "shortcode" }. Replace "shortcode" with the rich message shortcode, to have a valid JSON code you need to replace all " chars with \". To obtain the shortcodes or to learn how to create a rich message, please click here.

Rich message response

When the user interacts with rich messages via the Byra chat (e.g. by clicking a button), the rich message response is sent to Dialogflow in the following format: ID|response, or ID if the rich message type is registration, email, follow up, in this case the rich message values are sent as array in the queryParams['payload'] key. ID is the rich message ID, which can be set by adding the attribute id="YOUR-ID" to the shortcode. If no ID has been set, a random ID will be used instead. response is the input or selection of the user. To block Dialogflow from replying to a rich message add a new intent with ID as the only user expression and no response.

If the user is interacting with the chatbot via a messaging app (e.g. WhatsApp), the response of the rich message does not contain the rich message ID and Dialogflow contexts must be used to allow Dialogflow to understand which Intent to activate for a specific rich message response.

Get rich message response for registration, email, follow up

• Check the option Byra > Settings > Artificial Intelligence > Google > Send user details.
• From Left menu > Fulfillment enable Webhooks, you only need to enter the URL of the file that will receive the Dialogflow webhook data.
• Create an Intent with the ID of the rich message, for the registration form, enter registration, for the follow up form enter sb-follow-up-form, for email forms enter email.
• Enable the Fulfillment for the Intent.
• You're done! The file of the webhook URL will receive the Byra rich message user details.

Sequential survey

To create a sequential survey like the one of the demo you need to enter the Rich message ID in the Training phrases, check the example below.

• Go to Dialogflow and create a new intent. In the Training phrases area enter the user expression survey example. In the Responses area enter the code [buttons id="test-survey-1" options="Software,Physical products,Services" title="What is your type of business?" message="Please choose the type that best suits your company." success="Your company type is "]
• Create a new intent. Enter the user expression test-survey-1 and as response enter [select id="seq-survey-2" options="Priority post, Express courier, International courier" title="Shipping methods" message="Choose the preferred shipping method of your customers" success="Your customers preferred shipping method is"]
• Create a new intent. Enter the user expression test-survey-2 and as response enter Thank you for completing our survey!.
• You're done.

Department linking

• Get the department IDs from Settings > Miscellaneous > Departments.
• Get the project IDs from the Dialogflow settings area of your agents.

More information

• Dialogflow supports the use of voice messages through speech recognition. WhatsApp audio messages and .ogg audio files are not natively supported. To support WhatsApp audio messages and .ogg audio files, activate Settings > Artificial Intelligence > OpenAI > Speech recognition.
• You can activate the chatbot via API but sending a message with no text and payload { "event": "activate-bot" }.
• The following details are sent to Dialogflow in the queryParams parameter when detecting an intent: conversation_id, user_id.
• To trigger the welcome event in Dialogflow CX, create a Event Handler and insert Welcome as Custom Event.
• Byra articles are synchronized automatically with the Dialogflow knowledge base.
• Use the JS variable SB_DIALOGFLOW_AGENT = "AGENT ID" to change the default Dialogflow agent, replace "AGENT ID" with the project ID.
• If the user sends the same message again, triggering the same Intent in Dialogflow, and OpenAI is active, Byra will attempt to send a message from OpenAI and will ignore the response from Dialogflow.
• You can access the user_id and conversation_id of the current user and conversation in Dialogflow CX using the $session.params.user_id and $session.params.conversation_id codes, which are located in the Condition area of the route.

Multilingual chatbot

The feature Artificial Intelligence > Google > Multilingual checks if there is a Dialogflow agent in the user's language and activate it.

• For this feature to work the user language must be know. The user language is based on the language user detail of the user if set, otherwise on the user browser language. The language can also be detected with the language detection feature.

Automatic translation

The automatic translation feature automatically translates user messages into agent language and agent messages into user language. To enable it check the option Settings > Artificial Intelligence > Automatic translation. If you are using the cloud version and Artificial Intelligence > Google > Sync mode is set to Automatic, the multilingual features will work automatically. Otherwise you have to complete the synchronization and the setup below. The multilingual via translation and language detection features also require these steps.

Setup

• Log in to https://console.cloud.google.com with your Google account and select the project of your Dialogflow Agent.
• On the top search bar type cloud translation, select the Cloud Translation API service and enable it. Please note that this is a paid service with a free tier, additional charges may occur.
• Enable the billing by clicking Left menu > Billing and by enabling a billing account with a valid payment method.

Information

• The user messages in the admin area are translated automatically in real-time to match the agent language.
• The agent messages are translated automatically in real-time to match the user language.
• Agents can view the original message by opening the message menu and by clicking View original message.
• The agent language is based on the language user detail of the agent if set, otherwise on the browser language, or admin area language.
• The user language is based on the language user detail, if set, otherwise on chat language, if set, otherwise on the browser language. The language can also be detected with the language detection feature.
• The notifications are also translated.
• To avoid translating a string, enclose it with the characters ` or ```.

Multilingual via translation

The feature at Settings > Artificial Intelligence > Multilingual via translation automatically translates user messages into the default language of Dialogflow or OpenAI, and translates Dialogflow or OpenAI messages into the language spoken by the user. Additionally, this feature translates all text displayed within the chat, such as the chatbot's rich messages, articles, registration forms, and pop-up notifications. To enhance performance and minimize translation costs, the translations are automatically integrated into the translation files. Combine this feature with the language detection feature for optimal results.

• If English is one of the languages, English must be the default language, the original texts must be in English.
• If you are using OpenAI with training data, set the default training data language under Settings > Artificial Intelligence > OpenAI > Training Sources Language. Leave it as default if the training data default language is in English.

Language detection

Detect the language of the user' messages and change the user language and Dialogflow agent language accordingly, if available, otherwise, show a fallback message. You can use the following merge fields in the message: {language_name}.

• The user message must be at least 2 words long.
• Language detection is executed only for the first 2 user messages of a conversation.
• As long as the OpenAI chatbot is operational and programmed to respond to generic inquiries, the fallback message will never be dispatched, since OpenAI will consistently provide answers to any use message.

Google search

The Google search feature at Settings > Artificial Intelligence > Google search gives your chatbot the ability to search for answers on Google. This feature is helpful for providing answers to questions that require real-time information.

• Register at https://programmablesearchengine.google.com/.
• Create a search and setup it is as you want. We recommend to add only your website and Wikipedia if you want your chatbot to reply to general questions, leave disabled the option Search the entire web. Use the Entities option to exclude invalid results.
• Go to Edit search engine > Setup > Basic and copy the Search engine ID value, paste it in Byra.
• To get the API key visit https://developers.google.com/custom-search/v1/overview and click Get a key.

Spelling correction

In the case where Dialogflow is unable to find the appropriate response to the user's message, this function verifies if there are any spelling errors. If any such errors exist, Dialogflow is prompted again with the correctly spelled version of the message for an accurate response. Although it has a lower priority, this feature can still work together with the OpenAI Dialogflow spelling correction feature.

Entities

The Entities setting analyze the user's message and recognize and extract entities like cities, events, dates, and more. Use it to exclude invalid results returned by Google search. To enable this setting follow the steps below.

• Log in to https://console.cloud.google.com with your Google account and select the project of your Dialogflow Agent.
• Enter Cloud Natural Language API in the search bar at the top, select Cloud Natural Language API and enable the API .
• Enable the billing by clicking Left menu > Billing and by enabling a billing account with a valid payment method. Enable billing for the project of your Dialogflow agent.

Information

• The Google search is performed only if the chatbot does not know the answer to the user's question and if the length of the user's message is greater than 4 characters.
• If the Google search returns a result, the Dialogflow context google-search is automatically activated. The context contains the attribute link which is the website's link of the Google search result. Use the context to create a new intent that provides the link, if the user sends a message like tell me more or I want to know more.
• Google search is not required to activate the spelling correction. You can disable Google search and activate only spelling correction.
• Google search is compatible with the OpenAI chatbot.

Tickets

The settings below are related to the Tickets app. The Tickets app allows users to create conversations and send messages via a UI different from the chat.

Installation

• From Settings > Apps, click Tickets and enter your license key to install and activate the app. More details here. If you have the cloud version click Active.

Display the tickets area

PHP VERSION

To display the tickets area include the following script into your page.

                                <script src="Byra/js/min/jquery.min.js"></script> <!-- Not required if jQuery is already loaded -->
                                <script id="sbinit" src="Byra/js/main.js?mode=tickets"></script>
                            

• You can not include both chat and tickets area on the same page. Make sure to remove the script that loads the chat. You can show the tickets area also by inserting the code <script>SB_TICKETS = true;</script> into any page showing the chat.
• To set the position of the tickets area Enter the code <div id="sb-tickets"></div>. The tickets area will be displayed inside this div element. By default, the tickets area is appended to the body.

WORDPRESS VERSION

To display the tickets use the shortcode [sb-tickets]. Insert it in any page, post, or post type item.

CLOUD VERSION

To display the tickets area include the chat embed code into your page and add the attribute &mode=tickets to the script URL, e.g. <script id="chat-init" src="https://cloud.Byrachat.com/account/js/init.js?id=65895623&mode=tickets"></script>. You can show the tickets area also by inserting the code <script>SB_TICKETS = true;</script> into any page showing the chat.

Information

• If the tickets area is not visible, make sure to uncheck the option Tickets > Manual initialization. Additionally, you can explore other potential reasons for this issue here.
• You can also use the tickets area to display an inline or full-width chat panel.
• Tickets are the same of chat conversations on the admin-side, the only difference from chat conversations is the front-end UI.
• Most of the settings of the chat are compatible with the Tickets App but not all of them. The dashboard settings, the pop-up message, and more are not compatible.
• Dedicated APIs for the Tickets App are available in the API section.
• To remove the mandatory 'New ticket' form for new users, activate the welcome message of Settings > Messages & Forms > Welcome message. The welcome message delay is ignored in the tickets area, the message is sent immediately..
• To manually disable the mandatory registration only on a single page use the JavaScript code var SB_REGISTRATION_REQUIRED = true. Set it to true to force the registration instead.
• The tickets area is compatible with Google reCaptcha v3.

WhatsApp

The settings below are related to the WhatsApp app.

Installation

• From Settings > Apps, click WhatsApp and enter your license key to install and activate the app. More details here. If you have the cloud version click Active.

WhatsApp Cloud API Setup - Automatic sync mode

This feature is available only on the cloud version of Byra.

• Click Synchronize now and complete the procedure.
• To add new numbers, visit https://business.facebook.com/wa/manage/phone-numbers/. If you add new numbers after the sync process, you will need to sync them again. All numbers will be automatically synchronized. If you wish to disable specific numbers, you can delete them from Settings > WhatsApp > Cloud API numbers.
• If you sync again with the same phone number and do not receive the verification SMS or call, you can enter the latest PIN you received and it will work.

If you do not receive the messages sent to your WhatsApp number in Byra, please check the following:

• Click Reconnect and complete the procedure.
• Go to the Meta Business Suite and add a payment method.

WhatsApp Cloud API Setup - Manual sync mode

• Create a new account at https://developers.facebook.com or login with your existing account.
• Create a new app and choose Other as the app type. Then select Business. Enter a name for the app and select the Business Account used for WhatsApp.
• In Byra > Settings > WhatsApp > Cloud API settings > Secret key enter a random string then go to https://developers.facebook.com/apps and select your app. Click Add product and add WhatsApp, then go to WhatsApp > Configuration and in Webhook URL enter the URL you get from Byra > Settings > WhatsApp > Cloud API > Configuration URL. In Verify token enter the secret key you previously entered in Byra. Click Verify and save, click Webhook fields > Manage, enable the following Webhook fields: messages.
• To verify the integration, simply go to https://developers.facebook.com and select your app. From there, click on "WhatsApp" in the left menu and then select "API Setup". Copy the Phone number ID and paste it into Byra > Settings > WhatsApp > Cloud API numbers > Phone number ID. Enter the desired phone number in the "To" field, such as your personal WhatsApp number, and send a test message. Check your WhatsApp account and send a reply, which should then appear in Byra. To reply to the test number from Byra, copy the "Temporary access token" and paste it in Byra > Settings > WhatsApp > Cloud API numbers > Token.
• To activate the WhatsApp integration for all phone numbers and add a live phone number, refer to the following guidelines.
  In Byra > Settings > WhatsApp > Cloud API numbers > Token enter the permanent access token, follow the instructions below for getting it.
  • Visit https://business.facebook.com and go to Left menu > Settings > Business settings, then go to Users > System Users to view your admin system user, or create a new one. Open the user and click Add Assets, then select the app used for the WhatsApp API integration and check Develop App, or Full control. The system user needs to be an admin. If you do not see the option, click Business settings.
  • Click Left menu > Account > Apps. Select your app or add it. Make sure the system user is there and has full control. If not, click Add user, select the system user, click Full control, and click Assign.
  • Click Left menu > Apps and under Select Assets choose your app, assign Full control and save.
  • From Left menu > WhatsApp accounts select the WhatsApp account linked to your appp, then click Assign people and select the System user, grant to it Full control.
  • From Users > System Users select the user you just created and click Generate New Token, click Apps and select the app used for the WhatsApp API integration, set the Token expiration to Never, enable the following permissions: whatsapp_business_management, whatsapp_business_messaging, business_management. Click Generate Token and save. Paste the token in Byra > Settings > WhatsApp > Cloud API numbers > Token.
• To add additional phone numbers, go to https://developers.facebook.com, select your app, and click Left menu > WhatsApp > API Setup. To get started, click on Add phone number at the bottom and follow the instructions provided.
  • After activating the number, copy the Phone number ID and paste it into Byra > Settings > WhatsApp > Cloud API numbers > Phone number ID.
  • If the number is in pending status, you need to enter your app dashboard and then from Left menu > WhatsApp > API Setup click Generate access token.
  • Please keep in mind that if you use your current WhatsApp business number in Byra, it will no longer be usable with your WhatsApp Business app, and you will need to migrate it following these instructions.

360dialog Account Setup

• Go to https://www.360dialog.com/ and create a new account.
• Enter your dashboard and from Left menu > WhatsApp Accounts generate the API key and copy and paste it in Byra > Settings > WhatsApp > 360dialog settings.
• Click Byra > Settings > WhatsApp > 360dialog settings > Synchronize now.
• Done! Byra should start receiving the WhatsApp messages sent to your number, and you can reply to those messages from Byra.
• Note that you can also use the free sandbox account for testing, more details at https://docs.360dialog.com/whatsapp-api/whatsapp-api/sandbox. The sandbox account has limitations and some features, such as media attachments, will not work.

Twilio Account Setup

• Go to https://www.twilio.com and create a new account.
• Verify your phone number.
• Complete the form and choose WhatsApp, Alerts & Notifications, With no code at all, 3rd party integrations.
• From the Twilio console copy ACCOUNT SID and AUTH TOKEN and paste them into Byra > Settings > WhatsApp > Twilio settings, save the changes.
• You will now set up a free test account to run some tests and make sure the integration works with Byra. From the left menu click Messaging > Settings > WhatsApp sandbox settings and enter into WHEN A MESSAGE COMES IN and STATUS CALLBACK URL the URL of Byra , get it from Byra > Settings > WhatsApp > Twilio settings > Get configuration URL. Mind that localhost will not work, you need a public URL and a live server.
• From the left menu click Messaging > Try it out > Send a WhatsApp message. Follow the instructions and send the message with the code to the WhatApp number provided. Click the next buttons until the configuration is complete.
• Done! Byra should start receiving the WhatsApp messages sent to the sandbox account, and you can reply to those messages from the Byra.
• To publicly use the WhatsApp integration with your customers you need also to complete the steps below:
  • Update your account and enable billing, you can do that here.
  • Purchase a Twilio number, which will be the phone number of your official WhatsApp Business account. More details here. You cannot use the phone number of your existing WhatsApp Business account, you must use a Twilio number. More details here.
  • From the Twilio console go to Messaging > Services and create a new Messaging Service. Click Add Senders, select WhatsApp Number as the sender type, and add the Twilio number you purchased. Copy the Service SID and paste it into Byra > Settings > WhatsApp > Twilio settings > Sender.

Unofficial WhatsApp API

Support Boar only supports the Official WhatsApp Cloud API, 360dialog, or Twilio. Unfortunately, unofficial WhatsApp APIs are not supported. However, you can still implement them using the Byra API and Webhooks. For more details, visit https://Byrachat.com/docs/api/web. Please be aware that you must possess coding skills as a developer to proceed with this task. Additionally, our default integrations are equipped with advanced features including chatbot support, automated messages, human takeover, WhatsApp rich messages, attachments, and more. Consequently, although setting up a basic integration for sending and receiving text messages is relatively straightforward, ensuring its flawless functionality is a more intricate process.

Templates

As for WhatsApp Business Policy, you cannot send outbound marketing and solicitation messages to end users. End user users must reach out to you first. You have 24 hours from when the end user's message was sent from WhatsApp to reply to the message. To communicate with a user who has not contacted you before or has not been in touch for more than 24 hours, you must opt for the text message fallback or the WhatsApp message template.

• To send message templates you have to add a payment method to your WhatsApp Business Account. You can do it from https://business.facebook.com/billing_hub/.
• To send a specific message template to a group of users, use the direct messages feature.

Text message fallback

To enable the text message fallback you must set up the SMS in Settings > Notifications > Text message notifications.
More details here.

WhatsApp message templates

A WhatsApp message template is a message format that you can use over and over again to message users once they have opted-in and given your app permission to send them messages. You can not Enter the original message into the template, you must use it to notify the user of a new message and instruct him on how to view it, for example by providing a link to your website where the chat is shown.

WhatsApp Cloud API

• To get the Template name and manage the templates visit https://business.facebook.com and go to Left menu > Settings > More system settings, then go to Accounts > WhatsApp accounts > Settings and click WhatsApp Manager.
• In Template languages enter all the language codes supported by your template, separated by commas. Language codes list here (copy only the language code, e.g. it, es, en_US). If you use a template that supports multiple languages, the matching language for the user will be automatically selected. Otherwise, the default template language will be used.
• In Header variables and Body variables enter the values separated by commas, you can use the following merge fields: {recipient_name}, {recipient_email}. The number of parameters entered here must match the number of parameters of the template. Use this feature if your template uses dynamic values. For image headers, pass the image URL as the first parameter. Order is important, the first merge field will be used as the first template parameter.
• In Button variables enter the link of your custom buttons, or the text of the quick replies with prefix quick_reply_, e.g. quick_reply_abcde. Each value must be separated by a comma. The number of parameters entered here must match the number of parameters of the template. If there are buttons or call to actions with static values like a static URL, enter skip_parameter. Order is important, the first merge field will be used as the first template parameter. Example:

Template fallback

Set the WhatsApp template sent as fallback from Settings > WhatsApp > Cloud API template fallback. If you are using multiple numbers with different WhatsApp Business Account, a dedicated template must be created for each WhatsApp Business Account, you can set a different template for each number but template name and language code must be the same. The test template button, sends a test template from the first number.

Send template messages to a user who has not contacted you before

• In Settings > WhatsApp > Cloud API settings > Business Account ID enter you Business Account ID. Get it from https://developers.facebook.com. Choose your app and go to Left menu > WhatsApp > API Setup.
• To send the template to specific users, go to the Byra Users section and choose the intended recipients. Then, click on the WhatsApp icon located at the top right corner.
• If you are using the WhatsApp Cloud API with a template that supports multiple languages, the matching language for the user will be automatically selected. Otherwise, the default template language will be used.
• If you are using Twilio and have parameters in your template, input the parameter values separated by commas in the Body section.
• For more details click here.

Twilio

Enter the Template SID and the template attributes separated by commas into Byra > Settings > Twilio template.

360dialog

• Get the Namespace value from Left menu > WhatsApp accounts > Details.
• Get Template name and Template default language from your 360dialog templates area.
• In Custom parameters Enter the values separated by commas, you can use the following merge fields: {recipient_name}, {recipient_email}. Use this feature if your template uses dynamic values. Order is important, the first merge field will be used as the first template dynamic value.
• Byra will try to use the template with the same language as the user, if it is not available, it will use the template with the default language. The following template languages are not compatible: en_GB(use en_US), pt_PT(use pt_BR), zh_HK and zh_TW(use zh_CN), es_AR and es_MX(use es_ES).

WhatsApp flows

For more details about the WhatsApp Flows click here.

Built-in flows

The Byra automatically generates and sends the following flow. To regenerate a flow, click the Settings > WhatsApp > Clear flows button.

• Registraton - This flow is sent when a new user sends their first message to the WhatsApp number, and the Settings > Users > Require registration option is enabled.
• Follow-up - This flow is sent if the Settings > Messages & Forms > Follow-up message option is active and the user does not have an email address.

Send custom flows

To send custom flows use the merge field {wa_flow id="123" header="" body="" button=""}. Replace 123 with the flow ID and enter a text for the attributes header, body, and button.

WhatsApp shop

To displays the products of your shop use the merge fields below.

• When the user sends the order, the order information is sent to the URL specified in Settings > WhatsApp > Order webhook. The page at that URL should process the order and send a message to the user via the PHP API function sb_whatsapp_send_message().
• To connect the shop to WooCommerce click here.

More information

• You cannot send a WhatsApp message to a user who has sent you a message more than 24 hours ago or has never messaged you before. WhatsApp prohibits this action. Instead, you must use a WhatsApp template or send an text message. If you encounter an "Error message: Re-engagement," it indicates this situation.
• If you does not receive WhatsApp messages make sure you are not assigning the WhatsApp conversations to a department and that the WhatsApp number used for testing is not a phone number of a Byra admin or agent. Also, make sure you setup correctly the WhatsApp webhook URL.
• If you can not send messages, an error should appear in the admin area when you try to send a message to the user.
• We cannot provide support for Twilio or 360dialog configuration, including all related issues.
• We cannot provide support in getting your WhatsApp account or WhatsApp message template approved.
• WhatsApp conversations and messages are compatible with queue and routing.
• If you are testing with the sandbox and after 72 hours you can no longer send messages to your phone number you must link again your phone number to your sandbox.
• You can send rich messages to WhatsApp. If you send chips, buttons or select rich messages, with more than 3 options, you can use the whatsapp="Your menu text" shortcode attribute to set the text of the WhatsApp message menu.
• The follow-up message is supported, but the message is always sent, also if an agent replies.
• The offline message is supported, but the timetable is not sent.
• The chatbot is supported. The human takeover feature is also supported. To enable the Dialogflow chatbot support for audio messages, activate Settings > Artificial Intelligence > OpenAI > Speech recognition
• The supported AI features include language detetction, spelling correction, multilingual via translation, Google search.
• Twilio and 360dialog has many limitations. For example, Twilio does not support messages longer than 1600 characters. We strongly recommend to use the Official WhatsApp API.

Messenger

The settings below are related to the Messenger app.

Installation

• From Settings > Apps, click Messenger and enter your license key to install and activate the app. More details here. If you have the cloud version click Active.

Automatic sync mode

• Complete the synchronization by choosing at least 1 Facebook page and enter the returned information in Settings > Messenger > Facebook pages.
• You're done. All messages sent to the Facebook pages and Instagram accounts you selected will appear in the conversation admin area of Byra. Mind that only new messages will be synchronized, the old ones will not be imported.

Manual sync mode

• Create a new account at https://developers.facebook.com/ or login with your existing account.
• Create a new app and choose Other as the app type. Then select Business. Enter a name for the app and skip selecting any Business portfolios.
• From the menu on the left side, click on Add product. Choose Messenger.
• Under the Configure webhooks section, click on Configure.
  • Retrieve the Callback URL from Settings > Messenger > Messenger and Instagram settings > Get configuration URL.
  • Set the Verification Token in Settings > Messenger > Messenger and Instagram settings > Secret key and save the changes, then use it to verify the webhook.
  • In Webhook Fields select the following: inbox_labels, message_deliveries, message_echoes, message_reactions, message_reads, messages, messaging_account_linking, messaging_handovers, messaging_optins, messaging_policy_enforcement, messaging_postbacks, messaging_referrals.
• In the Generate access tokens section, click on Connect. Select the pages you want to sync and complete the process.
  • Under the Webhook Subscription column, click on Add Subscriptions. Choose the scopes you want: messages, messaging_postbacks, messaging_optins, message_reads, and message_echoes.
  • In the Tokens column, click on Generate. Copy the access token provided and paste it into Settings > Messenger > Facebook pages.
  • Copy the Page ID and Page Name and paste them into Settings > Messenger > Facebook pages.
  • Repeat these steps for all pages.
• Save the changes and you're done. The final step is to put the app in Live mode.
• If you want to sync Instagram as well, follow these steps:
  • From the menu on the left side, click Messenger > Instagram settings.
  • In the Configure webhooks area, click on Configure. Repeat the same step you previously took for Messenger.
  • Under the Webhook Subscription area, click on Add Subscriptions. Select the following scopes: messages, messaging_postbacks, messaging_optins, messaging_seen.
  • Enter your Instagram ID in Settings > Messenger > Facebook pages > Instagram ID. To get it, open your web browser and enter the following URL: https://graph.facebook.com/FACEBOOK-PAGE-ID/?access_token=ACCESS-TOKEN&fields=instagram_business_account. Replace FACEBOOK-PAGE-ID and ACCESS-TOKEN with the corresponding Page ID and access token from the Facebook page linked to Instagram.
  • Save the changes and you're done. The final step is to put the app in Live mode.
• Your app must be in Live mode. To do that, your app must be submitted for review and approved by Meta. You can use the text at this for the review process. Please note that help with this is not included in our support. If you require assistance, you can hire us.

Instagram

To link Instagram to your Facebook page and Byra follow the steps below.

• Enter the Settings area of your Facebook Page and click Left Menu > Instagram (https://www.facebook.com/YOUR-PAGE-SLUG/settings/).
• Click Connect account and complete the setup.
• Sync Messenger with Byra again and you're done. Mind that only new messages will be synchronized, the old ones will not be imported.

Information

• If you don't receive Instagram messages:
  • Make sure to enable Settings > Privacy > Messages & Forms > Connected tools - Allow access from your Instagram mobile app.
  • Make sure your Instagram account is not setup as a professional account, it must be a business account.
  • Go to Meta Business Suite, select your account, and go to Users > People. Under Instagram account click Manage and make sure to enable all the permissions.
• If you don't receive Facebook Messenger messages, make sure that the Facebook page does not send automated replies, such as the welcome message.
• In case you encounter duplicated messages or an ongoing chat cycle between the chatbot and Instagram messages, you are facing a problem due to the presence of two Byra installations or Byra Cloud accounts that are both synchronized with the same Instagram account. To resolve this, access the second Byra admin area, navigate to Settings > Messenger > Facebook pages, remove the Instagram ID value and save the changes. Try also to click the Unsubscribe button.
• The Unsubscribe button remove the webhook subscription from all of your Facebook pages, it is useful if you want to stop receiving messages from a Facebook page.
• Every Byra user has only 1 Facebook conversation and 1 Instagram conversation.
• Byra rich messages are automatically converted to Facebook rich messages when possible, some part of the rich message could be removed or changed. Buttons, chips, and selects support a maximum of three choices and are only supported in the Instagram mobile app.
• Only private Facebook messages will get sent to your team inbox. If someone posts a Facebook message on your wall it won't appear in your team inbox.
• When someone sends a message to your company Facebook page or Instagram account they will get designated as a lead in Byra. You'll only be able to see the user's Facebook or Instagram name and profile picture.
• Messenger conversations and messages are compatible with queue and routing.
• The chatbot is supported. The human takeover feature is supported.
• The supported AI features include language detetction, spelling correction, multilingual via translation, Google search.
• If the chatbot is enabled, it is necessary to deactivate any automatic replies on Facebook Messenger, such as the welcome message.
• The follow-up message is supported, but the message is always sent, also if an agent replies.
• The offline message is supported, but the timetable is not sent.
• Only 1 Facebook account can be synchronized, to link pages from multiple Facebook accounts, the account synchronized in Byra must be an admin of all Facebook pages of the other Facebook accounts.
• Using this integration of Instagram and Facebook Messenger comes at no additional cost.
• If the message exceeds 1000 characters, only the initial 1000 characters will be transmitted due to the character limit.
• Only new messages, sent after the synchronization, will be synchronized, the old ones will not be imported.
• User Data Deletion Request (cloud version only): To delete all of your data from Byra, click Settings > Messenger > Unsubscribe then delete your account from here.
• To enable the typing indicator on Messenger, you need to set up and enable the async PHP process.

Twitter

The settings below are related to the Twitter app.

Installation

• Register at https://developer.twitter.com. Make sure to verify your phone at https://twitter.com/settings/phone or the registration will fail.
• Create your first app by entering the app name and clickGet keys, copy API Key (Consumer key) and API Key Secret (Consumer secret) and paste them in Byra > Settings > Twitter.
• Request the Elevated access from https://developer.twitter.com/en/portal/products/elevated. Click Apply for Elevated and complete the form as follow: In the first area In your words and in Will your app use Tweet, Retweet, Like, Follow, or Direct Message functionality? enter I need access to the Account Activity API to start receiving Twitter Direct Messages to my chat software(Byra ) and to reply to them directly from Byra , details at https://Byrachat.com/twitter. Disable all the other fields by clicking No: Are you planning to analyze Twitter data?, Do you plan to display Tweets or aggregate data about Twitter content outside Twitter?, Will your product, service, or analysis make Twitter content or derived information available to a government entity?
• Wait a few days for Twitter to review and approve the Elevated access, you will receive an email from Twitter.
• Once you have Elevated access, enter the developers dashboard (https://developer.twitter.com/en/portal/dashboard) and from the left menu click Products > Premium > Dev environments and under Account Activity API / Sandbox click Set up dev environment, in Dev environment label enter sb or the same value entered in Settings > Twitter > Synchronization > Dev environment label.
• Enter your app Settings area from Left menu > Projects & Apps > Your project > Your app and under User authentication settings click Set up and activate OAuth 1.0a. In App permissions check Read and write and Direct message, in Callback URI / Redirect URL enter the URL you get from Byra > Settings > Twitter > Get callback URL, in Website URL enter your website URL.
• Enter your app Keys and tokens area from Left menu > Projects & Apps > Your project > Your app > Keys and tokens and under Authentication Tokens generate Access Token and Secret, copy and paste them in Byra > Settings > Twitter.
• Enter your Twitter profile username in Byra > Settings > Twitter > Your username. Get it from your Twitter profile page, copy the name starting with @ or the URL part containing your username. Ex. https://twitter.com/Byra1.
• Save the Byra settings and click the button Byra > Settings > Twitter > Subscribe and you're done. All messages sent to your Twitter account will be received by Byra.

More information

• If you receive duplicate messages, the Twitter account you are using for testing may be the same as the one you synced. Try sending a message from another Twitter account.
• Use a live domain, localhost is not supported.
• When a message is received from a Twitter user you may send up to 5 messages in response within a 24 hour window. No messages can be sent after 24 hours of receiving the Twitter message.
• You can send maximum 3 or 4 attachments depending by the media type.
• The following Byra rich messages are not supported: images slider, slider, card.
• The chatbot is supported. The human takeover feature is supported.
• The supported AI features include language detetction, spelling correction, multilingual via translation, Google search.

Telegram

The settings below are related to the Telegram app.

Installation

• From Settings > Apps, click Telegram and enter your license key to install and activate the app. More details here. If you have the cloud version click Active.
• Once the app is installed visit https://t.me/botfather.
• If you have already created a Telegram bot in the past, type the command /mybots and open your bot, then click API token.
• If you never created a Telegram bot before, type the command /newbot to create a new bot. The BotFather will ask you for a name and username, enter them and generate the authentication token. More details at https://core.telegram.org/bots.
• Copy the token and paste it into Byra > Telegram > Token, then click Synchronize now. Your website must use HTTPS (SSL certificate), HTTP is not supported.
• You're done. All messages sent to your Telegram bot will appear in the conversation admin area of Byra.

More information

• Byra rich messages are automatically converted to Telegram rich messages when possible, otherwise they are removed from the message.
• Telegram conversations and messages are compatible with queue and routing.
• The chatbot is supported. The human takeover feature is supported.
• The supported AI features include language detetction, spelling correction, multilingual via translation, Google search.
• The Settings > OpenAI > Speech recognition feature is not supported for Telegram audio messages.
• The follow-up message is supported, but the message is always sent, also if an agent replies.
• The offline message is supported, but the timetable is not sent.
• You can verify the webhook status from https://api.telegram.org/bot><your_bot_token>/getWebhookInfo. Replace <your_bot_token> with your token.

Viber

The settings below are related to the Viber app.

Installation

• From Settings > Apps, click Viber and enter your license key to install and activate the app. More details here. If you have the cloud version click Active.
• Create the bot at https://partners.viber.com/account/create-bot-account.
• Copy the token and paste it into Byra > Viber > Token, then click Synchronize now. Your website must use HTTPS (SSL certificate), HTTP is not supported.
• You're done. All messages sent to your Viber bot will appear in the conversation admin area of Byra.

More information

• Byra rich messages are automatically converted to Viber rich messages when possible, otherwise they are removed from the message.
• Viber conversations and messages are compatible with queue and routing.
• The chatbot is supported. The human takeover feature is supported.
• The supported AI features include language detetction, spelling correction, multilingual via translation, Google search.
• The follow-up message is supported, but the message is always sent, also if an agent replies.
• The offline message is supported, but the timetable is not sent.

Slack

The settings below are related to the Slack App.

Installation

• From Settings > Apps, click Slack and enter your license key to install and activate the app. More details here. If you have the cloud version click Active.
• Once the app is installed go to Settings > Slack, click the Synchronize now button, and follow the instructions.

Having Problems?

The synchronization of Slack may not be successful for a number of reasons; below are the most common ones:

Manually archive channels

To archive a channel in Slack, follow these steps:

• Open the Slack channel you want to archive.
• On the top right click the gear icon and select Additional options.
• Click the info icon in the top right area of the screen, then click the More icon, and then click Additional options.... Click Archive this channel.

Department linking

If the Settngs > Slack > Department linking option is active, when a conversation in the Byra is assigned to a department, a new message is sent to the linked Slack channel, informing Slack users that a new conversation has started and inviting them to join the dedicated user Slack channel. However, the full conversation can only be accessed on the dedicated Slack channel of the specific user.

• Get the department IDs from Settings > Miscellaneous > departments.
• Get the channel IDs by clicking the button Get channel IDs.

User fields

The Settings > Slack > User fields option allows you to choose which user details to include in the message sent to the main channel when a new user sends the first message. You can include the slug of your custom user details or the following slugs: browser, browser_language, location, email, user_type, token, creation_time, country_code, current_url, os, city, address, postal_code, phone, birthdate, company, timezone, website. Default: email, browser, browser_language, location.

Information

• When a new user sends the first message, a Slack message with the user details and a button to join the user's channel is sent to the main channel selected during the synchronization, or to the channel linked to the conversation's department. Only the Slack account used during the synchronization will automatically join the user's channel, other Slack members will have to join it manually via the button.
• When Settings > Slack > Agent linking is set, if the conversation is assigned to a department, only agents assigned to that department will receive the message, if the conversation is assigned to a single agent only that agent will receive the message.
• Slack is free to use. Only large companies may need a paid subscription plan, more details here.
• Push notifications are compatible with Slack, when agents send messages via Slack, Push notifications are sent to users.
• If you're using Dialogflow, no messages will be received in Slack if the chatbot knows the answer. Once the human takeover is active all conversation's messages are sent to Slack.
• The Slack app is compatible with email piping and the messaging apps.
• Deleting or leaving a channel is not supported, only archiving a channel is supported.
• When a conversation is archived in Byra , the linked Slack channel is also archived.
• When replying via Slack to a user, if the user is notified by email or text message, a Slack message is sent to notify you.
• Use the Slack command /archive to archive a conversation from Slack.

LINE

The settings below are related to the LINE app.

Installation

• From Settings > Apps, click LINE and enter your license key to install and activate the app. More details here. If you have the cloud version click Active.
• Login at https://developers.line.biz/console/ or create a new account.
• Create a new Provider and then a new Messaging API channel, select Messaging API as channel type
• From the channel Basic settings area copy Channel secret and paste it into Byra > Settings > Line > Synchronization > Channel secret.
• From the channel Messaging API area generate a Channel access token (long-lived), copy it and paste it into Byra > Settings > Line > Synchronization > Access token.
• Enter your Webhook URL into Webhook URL and click Verify. Get the Webhook URL from Byra > Settings > Line > Synchronization > Webhook URL.
• Enable Use webhook.
• Scan the QR code with your LINE mobile app to start writing to your channel.
• Disable the Auto-reply messages setting.
• You're done. All messages sent to your LINE bot account will appear in the conversation admin area of Byra.

More information

• You have 7 days from when the end user's message was sent from WhatsApp to reply to the message.
• Stickers are not supported.
• Byra rich messages are automatically converted to LINE rich messages when possible, otherwise they are removed from the message.
• LINE conversations and messages are compatible with queue and routing.
• The chatbot is supported. The human takeover feature is supported.
• The supported AI features include language detetction, spelling correction, multilingual via translation, Google search.
• The follow-up message is supported, but the message is always sent, also if an agent replies.
• The offline message is supported, but the timetable is not sent.

WeChat

The settings below are related to the WeChat app.

Installation

• From Settings > Apps, click WeChat and enter your license key to install and activate the app. More details here. If you have the cloud version click Active.
• Visit https://mp.weixin.qq.com/cgi-bin/readtemplate?t=register/step1_tmpl&lang=en_US and register a Service account.
• After the registration enter Official accounts area and from the left menu click Settings and development > WeChat verification. You must complete the verification, it takes a few weeks and costs USD 99, or CNY 300 for chinese entities.
• From the left menu click Settings and development > Basic configuration and copy Developer ID(App ID), Developer Password(App Secret). Paste the information into Byra > Settings > WeChat.
• From the left menu click Settings and development > Basic configuration and complete the server configuration (服务器配置(已启用). In Server Address(URL) enter the URL you get from Byra > Settings > WeChat > Synchronization > Get configuration URL. In Token insert any value you want, the same value must be entered in Byra > Settings > WeChat > Token.
• You're done. All messages sent to your WeChat account will appear in the conversation admin area of Byra.

More information

• If you receive an error like {"errcode":41001,"errmsg":"access_token missing rid: 631111-470b3b22-48553870"} you need to whitelist your server IP address from Official Account > Settings and Development > Basic Configuration > IP whitelist.
• WeChat files and location attachments are not supported and are not received by Byra.
• Links are not supported in WeChat, they are converted to texts.
• Byra rich messages are automatically converted to WeChat rich messages when possible, otherwise they are removed from the message.
• WeChat conversations and messages are compatible with queue and routing.
• The chatbot is supported. The human takeover feature is supported.
• The supported AI features include language detetction, spelling correction, multilingual via translation, Google search.
• The follow-up message is supported, but the message is always sent, also if an agent replies.
• The offline message is supported, but the timetable is not sent.

Zalo

The settings below are related to the Zalo app.

Installation

• From Settings > Apps, click Zalo and enter your license key to install and activate the app. More details here. If you have the cloud version click Active.
• Register at https://developers.zalo.me/ and create a new App. Enter the required information and save.
• Copy the Application ID and Application secret key from the app you just created and paste them into Byra > Settings > Synchronization > Zalo.
• From the left menu click Webhooks and set the URL, get the URL from Byra > Settings > Zalo > Synchronization > Webhook URL.
• From the left menu click Webhooks copy OA Secret Key and paste it into Byra > Settings > Zalo > Synchronization > OA secret key.
• From the left menu click Webhooks and enable the following webhook events: user_send_location, user_send_image, user_send_link, user_send_text, user_send_sticker, user_send_gif, user_received_message, user_seen_message, oa_send_text, oa_send_image, oa_send_list, oa_send_gif, user_send_audio, user_send_video, user_send_file, user_reacted_message, user_received_message.
• From the left menu click Official Account > OA Management and link your Official Account.
• From the top menu click Tools > API Explorer or go to https://developers.zalo.me/tools/explorer/. As Access token type select OA Access Token, click Get Access Token and select your Official Account. Copy the Refresh token and paste it into Byra > Settings > Zalo > Synchronization > Refresh token. More details here.
• From the left menu click Role and a test user as admin. You will use this user to send message to your Zalo Official Account and test the integration.
• From the left menu click Sign up to use API > Official AccountAPI enable User Management and click Submit for review.
• You're done. All messages sent to your Zalo Official account will appear in the conversation admin area of Byra.

More information

• You need a Zalo Official Account to use this integration. Byra will receive messages sent to your Zalo Official Account.
• The slider rich message only send the first element to Zalo.
• Byra rich messages are automatically converted to Zalo rich messages when possible.
• Zalo conversations and messages are compatible with queue and routing.
• The chatbot is supported. The human takeover feature is supported.
• The supported AI features include language detetction, spelling correction, multilingual via translation, Google search.
• The follow-up message is supported, but the message is always sent, also if an agent replies.
• The offline message is supported, but the timetable is not sent.

Zendesk

The settings below are related to the Zendesk App.

Installation

• From Settings > Apps, click Zendesk and enter your license key to install and activate the app. More details here. If you have the cloud version click Active.
• Get the domain from the URL of your Zendesk admin area, copy the first part of the URL: https://domain.zendesk.com/. For example, the domain of https://Byra.zendesk.com/agent/get-started/ticketing-system/ticketing-intro is Byra.
• Get the API key from Left menu > Admin > Channels > API > Settings. Click Add API token.
• The email is your Zendesk account email.