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
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.
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:
— All text links are automatically converted to clickable hyperlinks.
— 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.
Code
Description
{user_name}
Full name of the active user.
{user_email}
Email of the active user.
{agent_name}
Full name of the active agent.
{agent_email}
Email of the active agent.
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
Name
Shortcode
Description
Card
[card image="URL" header="TITLE" description="Lorem ipsum dolor sit amete" link="URL" link-text="Purchase" extra="$599" target="_blank"]
Call-to-action card with an image, title, description, link, and more.
Slider
[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 of call-to-action cards with an image, title, description, link, and more. You can add up to 10 slides.
Form to collect the user's email and phone number.
All attributes are optional. Follow up settings used as default values.
Add the attribute required-messaging-apps="true" to force users to provide their email and phone on messaging apps.
Articles with search area. The link attribute is used as fallback message for Facebook Messenger, WhatsApp, Telegram messages.
Rating
[rating label-positive="Helpful" label-negative="Not helpful" label="Rate and review" success-negative=""]
Agent rating form.
To make the rating shortcode work on WhatsApp, Messenger, Telegram you need to use Dialogflow and the chatbot, create a
new Intent with rating as input Context, nothing as output Context, a
list of the user's most common messages for a positive rating as Training phrases(e.g. good, positive)
and { "rating": 1, "force-message": true } as Custom Payload response. For the negative rating create a new intent with same context but replace the training phrases and the custom payload to { "rating": -1, "force-message": true }. The shortcode must include also a title or message.
Display a link or open an article. The attribute
target="_blank" is optional and open the link in a new window.
The attribute
style="link" is optional and change the button design.
To open an article on click the link value must be
#article-ID, replace ID with the article ID.
Display a YouTube or Vimeo video. The value of the attribute
type can be
youtube or
vimeo. The attribute
id is the ID of the video, get it from the URL. The attribute
height is optional and sets the video height in px.
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:
The allowed file attachments extensions are set in the supportboard/include/upload.php file.
The following image formats are displayed automatically: .jpg, .jpeg, .png.
USERS
Manage Users
Manage users from the
Users area in the left menu of the admin area.
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.
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.
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
Type
Description
user
A "user" is any user with an email.
lead
A "lead" is any user with no user details, who is automatically registered, and with at least one conversation.
visitor
A "visitor" is any user who has not started a conversation.
Note: Visitors are automatically deleted every 24 hours.
Manage Agents
Manage agents from the
Users area.
An agent is a special user that can log in to the admin area and reply to all of the conversations.
There are two types of agents: Agents.
Admins are the only ones that can create new Agents;
they also have access to the settings area. Agents can only manage users and conversations.
Information
New users are automatically displayed in the user table in real time.
To view online users and receive the online user notification enable Settings > Users > Register all visitors.
To receive the online user notification you need to enable also Settings > Miscellaneous > Pusher.
The log-in form is shown only if the registration password field is shown.
The password field is always shown when the user system is set to "WordPress".
If Settings> Users > Allow Duplicate Emails is enabled and a user enters an already registered email, a new user is created and the email is removed from the old user. The new user will not have access to the old user's messages and conversations. You can also automatically log in a user via URL parameters.
SETTINGS
Settings
Office Hours
You can set the office hours timetable from
Settings > Miscellaneous. Office hours are used for:
Automatically displaying the timetable and a message when a user sends a message during out-of-office hours or if all agents are offline.
To enable this feature set up the Offline message at Settings > Messages > Offline Message. The offline message is sent to the same user maximum 1 time per hour.
Disabling and hiding the chat during out-of-office hours.
Disabling the Dialogflow chatbot during regular office hours and enabling it during out-of-office hours.
More information
Blank values in the timetable settings are considered out-of-office hours.
The office hours are in UTC format.
Your UTC is generated automatically when you click the field
Settings > Miscellaneous > UTF offset.
To manually get the UTC offset of your area, go to:
https://browserspy.dk/ or
wikipedia.org/wiki/List_of_UTC_time_offsets and copy the offset (e.g. for UTC −12:00, enter -12).
Only integers are accepted. If your offset is not an integer (e.g. UTC -12:30 or UTC -12:45),
try searching for an alternative UTC offset. If you can't find an integer offset, you will need to manually adjust the times
in the office hours table to fix the gap.
The date and time format of the timetable matchs automatically the one used in the country of the browser language of the user.
The offline message is not sent automatically if Settings > Dialogflow > Human takeover is active. When the Dialogflow human takeover option is active, the offline message is sent only on human takeover.
The offline message is not sent is you're using the Slack app and you or any other agent is online via Slack.
Knowledge Base Articles
Knowledge base articles provide instant answers to customers to help reduce customer support volume.
To manage the articles, go to
Settings > Articles. Articles support HTML code, which can be used to add images, videos, and other content.
Here are some HTML code examples that you can use:
The articles can be shown in the chat dashboard by enabling them from the
Settings > Chat area.
The articles can be shown in a dedicated page by inserting the code <script>var SB_ARTICLES_PAGE = true;</script> into any page showing the chat. To set the location of the articles area Enter the code <div id="sb-articles" class="sb-loading"></div>. If you're using the WordPress version you can use the shortcode [sb-articles].
Alternatively, articles can be shared via the rich message shortcode,
[articles].
More information
Translate the categories from
Settings > Translations by adding the translation name and its translation.
If you use categories, only the articles assigned to a category are displayed.
If there is at least one translated article in the user's language, only the translated articles are displayed.
Articles are synchronized automatically with the Dialogflow knowledge base if the Dialogflow app is installed.
You can create an internal chat link to an article with the button rich message.
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 your required 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.
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 can only access conversations, users, and agents that have been assigned to their specific department.
When an agent is assigned to a new department, an email notification is sent to all of the agents assigned to the new department.
The
General department is global and gives agents access to all of the conversations within all departments.
Also, all agents without a department are automatically assigned to the General department.
To automatically assign a department to the user conversations you can Enter the JavaScript variable var SB_DEFAULT_DEPARTMENT = ID; into the pages where the chat is displayed, replace ID with the department ID.
For more details check the APIs
here.
Admins with no assigned department always see the conversations of all departments.
The chatbot can assign a department to the active conversation via dialogflow actions.
How to assign a department
You can assign a department to a conversation in several ways:
Via Settings > Miscellaneous > Departments settings > Display in dashboard. This setting will force the user to choose a department when starting a new conversation.
Via Settings > Automations > More.
Via JavaScript 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.
When the queue is activated via
Settings > Miscellaneous > Queue,
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.
GB Talk 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.
More information
Only online agents are counted as "available" agents; only online agents will receive new conversations.
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.
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 view their conversations; however, they can see all of the conversations of a single user.
Agents can only search and filter their conversations.
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.
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.
The queue is compatible with the departments.
If Dialogflow human takeover is active, the queue is activated only on human takeover.
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 agent.
Use Settings > Messages > Offline message to prevent the chat from showing the queue update message to the user.
When the sound option is active, a sound is played when it's the user's turn.
How to test the queue
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.
Routing
When the routing is activated via
Settings > Miscellaneous > Routing, GB Talk automatically assigns the users conversations to all available agents proportionately.
Information
Conversations are assigned to online agents first. If all agents are offline, conversations are assigned proportionally between all agents.
Conversations are assigned to agents with less active conversations. A conversation is active if it's not deleted, or archived. If routing is active, you should archive the conversations once completed.
Admins are not included; admins always see all the conversations.
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 view only their conversations; however, they can see all of the conversations of a single user.
Agents can search and filter only their conversations.
The routing is compatible with the departments.
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: displays the agents' menu to assign the active conversation to another agent.
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.
Email piping
Email piping lets you, your agents, and your users reply to chat messages via email.
Activation
To activate the email piping go to
Settings > Notifications > Email piping and enter your POP3/IMAP email server information,
then set the email address to use for the email piping in
Settings > Notifications > SMTP
and you're done! The email address must be the one to which the email piping server connects to.
GB Talk will send all emails from this email address and you, your agents, and your users will reply to this email address.
Information
The setting Notifications > User email notifications must be enabled to send replies to the user email.
If you're using the Dialogflow App, and the settings Settings > Dialogflow > Human takeover is active, no emails are sent if the chatbot knows the answer.
If the setting Convert all emails 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.
If the setting convert all emails is active, email sent by email addresses of agents and admins will be ignored, use another email address for testing.
If the setting convert all emails is active, 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 GB Talk agents and admins must use a different email address.
Agents must reply via email from the same email address registered in GB Talk .
When agents reply in GB Talk, emails are always sent to the user, even if user email notifications are disabled.
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.
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 GB Talk 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 GB Talk recipient's name. Ex. GB Talk | SB2457-4734 <example@email.com>.
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.
Cron job
GB Talk tries to process emails via cron jobs every 60 seconds, details here.
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 [SUPPORT-BOARD-INSTALLATION-URL]/include/api.php?piping=true *. Use the command */59 * * * * wget [SUPPORT-BOARD-INSTALLATION-URL]/include/api.php?piping=true to run it via a command. Replace [SUPPORT-BOARD-INSTALLATION-URL] with your GB Talk URL *.
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, check the setting Disable cron job to stop GB Talk from manually triggering it and to improve performance.
* If you are using the cloud version the URL is https://cloud.board.support/script/include/api.php?piping=true&cloud=API-TOKEN, replace API-TOKEN with your API Token (https://cloud.board.support/account/?tab=installation)
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.
General
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.
The chat message is sent to the active conversation, if any, otherwise to a new conversation.
If the option
Settings > User email notifications is active, all users with an email are notified via email.
If the option
Settings > Text message notifications > Active for users is active, all users with a phone number are notified via text message.
If the option
Settings > Push notifications 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, google, wechat. Enter tickets to send a message only to the users who created a GB Talk 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.
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 setting Settings > Users > Register all visitors 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.
Newsletter
Follow the steps below to complete the synchronization with your newsletter service. The user is subscribed in the following cases: registration form, user update, follow-up message, subscribe message, email shortcode.
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 it from Settings > Integrations > API key.
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, 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.
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...).
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.
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 GB Talk > 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 GB Talk > 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.
NOTIFICATIONS
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 don't receive the emails make sure they are working by sending a test email from Settings > Notifications > Test user email or Test agent email.
If you don't receive the test email, your server, or your SMTP server, is not working. Open the browser console for more details about the error.
Because this is not an issue related to GB Talk , the support doesn't cover it, please contact your server/hosting/SMTP support instead.
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.
Code
Description
{recipient_name}
The name of the user or agent who is receiving the email.
{sender_name}
The name of the user or agent who was sending the message that triggered the email notification.
{sender_profile_image}
The profile image of the user or agent who was sending the message that triggered the email notification.
{message}
The links to any attachments that were part of the message that triggered the email notification.
{attachments}
Emails may not be delivered for several reasons; below are the most common ones:
Problems?
Emails may not be delivered several reasons; below are the most common ones:
Reason
Description
Solution
Hosting problems
The email server of your web hosting provider is not able to send emails or the emails are sent
but are automatically detected as spam and deleted by the email clients.
Please contact your web hosting provider regarding email support or use your SMTP server by activating it in
Settings > Notifications > SMTP.
SMTP problems
The email is not sent also if you activated the SMTP option in the
Notifications area.
We don't provide support for problems related to your SMTP. Send a test
email to get details about the issue or use
sendgrid.com,
you can send 40000 emails for 30 days for free, then 100/day forever for free. Note: if you're using Gmail enter
smtp.gmail.com as host and set
465 or
587 as port. You need also to allow access to Gmail to less secure apps, you can do it from
https://myaccount.google.com/lesssecureapps.
TICKETS
Tickets
The settings below are related to the Tickets App.
Installation and usage
Installation
To display the tickets area include the following script into your page.
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.
Information
Tickets are the same of chat conversations and messages, the only difference from the chat is the front-end panel.
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 > 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.
WHATSAPP
WhatsApp
The settings below are related to the WhatsApp app.
In GB Talk > Settings > WhatsApp > Cloud API > 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 GB Talk > Settings > WhatsApp > Cloud API > Configuration URL.
In Verify token enter the secret key you previously entered in GB Talk. Click Verify and save, click Webhook fields > Manage, enable the following Webhook fields: messages.
In GB Talk > Settings > WhatsApp > Cloud API > Token enter the test token for testing, and follow the instructions below for getting the permanent access token.
Visit https://business.facebook.com and go to Left menu > Settings > More system settings, then go to Users > System Users to view the system user you created, or create a new one. Click on that user and select Add Assets.
The system user needs to be an admin.
Click Left menu > Apps and under Select Assets and choose your app. Enable Develop App for that app and save.
Click Generate Token and select your app, enable the following permissions: whatsapp_business_management, whatsapp_business_messaging, business_management. Click Generate Token and save. Paste the token in GB Talk > Settings > WhatsApp > Cloud API > Token.
To get the Phone ID enter https://developers.facebook.com,
select your app and go to Left menu > WhatsApp > Getting started.
You can test the integration from https://developers.facebook.com,
select your app and go to Left menu > WhatsApp > Getting started.
Enter your dashboard and from Left menu > WhatsApp Accounts generate the API key and copy and paste it in GB Talk > Settings > WhatsApp > 360dialog settings.
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 GB Talk > 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 GB Talk .
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 GB Talk ,
get it from GB Talk > 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! GB Talk should start receiving the WhatsApp messages sent to the sandbox account, and you can reply to those messages from the GB Talk .
To publicly use the WhatsApp integration with your customers you need to update your account and enable billing, you can do that here.
After that you will need to 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.
Fallback messages
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.
If you want to send a message after 24 hours from the last user's message you need to use the text message fallback or WhatsApp template message.
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 Template Messages
A WhatsApp Template Message 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. If a language is not found the fist language code is used instead. Language codes list here (copy only the language code, e.g. it, es, en_US).
In Header parameters and Body parameters enter the supported merge fields separated by commas, e.g. {recipient_name}, {conversation_url_parameter}.
The number of parameters entered here must match the number of parameters of the template.
Use this feature if your template uses dynamic values. Order is important, the first merge field will be used as the first template parameter.
Twilio
Enter the template code into GB Talk > Settings > WhatsApp > Template fallback
If you're using the Twilio sandbox for testing you can use pre-approved templates like Your {{1}} code is {{2}},
you can replace the variables with the GB Talk ones like {recipient_name}, for example, Your {recipient_name} code is {recipient_email}.
More details here.
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 supported merge fields separated by commas, example: {recipient_name}, {conversation_url_parameter}.
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.
GB Talk 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 shop
To displays the products of your shop use the merge fields below.
Display multiple products. Replace id with the catalog ID. Add products by grouping them into sections, via the attributes product_id_[A]_[B], replace [A] with the section index, starting from 1, replace [B] with the product index, starting from 1 for each section. You must also add the attribute section_[A]="" for each section, replace [A] with the section index. The attributes header and body are required, footer is optional.
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().
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 GB Talk 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 routing and queue.
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.
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.
MESSENGER
Messenger
The settings below are related to the Messenger app.
Installation
Go to
Settings > Messenger and click
Start synchronization.
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 GB Talk .
Instagram
To link Instagram to your Facebook page and GB Talk 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 GB Talk again and you're done.
More information
If you don't receive Instagram messages make sure to enable Settings > Privacy > Messages > Connected tools - Allow access from your Instagram mobile app.
Also, make sure your Instagram account is not setup as a professional account, it must be a business account.
Every GB Talk user has only 1 Facebook and Instagram conversation.
GB Talk rich messages are automatically converted to Facebook rich messages when possible, some part of the rich message could be removed or changed.
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 GB Talk .
You'll only be able to see the user's Facebook or Instagram name and profile picture.
Messenger conversations and messages are compatible with routing and queue.
Follow-up message is supported, but the delay setting is ignored, the message is sent instantly.
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 GB Talk must be an admin of all Facebook pages of the other Facebook accounts.
TWITTER
Twitter
The settings below are related to the Twitter app.
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 GB Talk > 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(GB Talk ) and to reply to them directly from GB Talk , details at https://chat.gbtalk.net/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 GB Talk > 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 GB Talk > Settings > Twitter.
Enter your Twitter profile username in GB Talk > 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/SupportBoard1.
Save the GB Talk settings and click the button GB Talk > Settings > Twitter > Subscribe and you're done. All messages sent to your Twitter account will be received by GB Talk .
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.
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 GB Talk rich messages are not supported: images slider, slider, card.
TELEGRAM
Telegram
The settings below are related to the Telegram app.
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 GB Talk > 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 GB Talk.
More information
GB Talk 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 routing and queue.
Follow-up message is supported, but the delay setting is ignored, the message is sent instantly.
Offline message is supported, but the timetable is not sent.
Copy the token and paste it into GB Talk > 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 GB Talk.
More information
GB Talk 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 routing and queue.
Follow-up message is supported, but the delay setting is ignored, the message is sent instantly.
Offline message is supported, but the timetable is not sent.
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 GB Talk > Settings > Line > Synchronization > Channel secret.
From the channel Messaging API area generate a Channel access token (long-lived), copy it and paste it into GB Talk > Settings > Line > Synchronization > Access token.
Enter your Webhook URL into Webhook URL and click Verify. Get the Webhook URL from GB Talk > Settings > Line > Synchronization > Webhook URL.
Enable Use webhook.
Scane the QR code with your LINE mobile app to start writing to your channel.
You're done. All messages sent to your LINE bot account will appear in the conversation admin area of GB Talk.
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.
GB Talk 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 routing and queue.
Follow-up message is supported, but the delay setting is ignored, the message is sent instantly.
Offline message is supported, but the timetable is not sent.
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 GB Talk > 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 GB Talk > Settings > WeChat > Synchronization > Get configuration URL. In Token insert any value you want, the same value must be entered in GB Talk > Settings > WeChat > Token.
You're done. All messages sent to your WeChat account will appear in the conversation admin area of GB Talk.
More information
If you receive an error like {"errcode":41001,"errmsg":"access_token missing rid: 631111-470b3b22-48553870"} you need
to whitelist us 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 GB Talk.
Links are not supported in WeChat, they are converted to texts.
GB Talk 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 routing and queue.
Follow-up message is supported, but the delay setting is ignored, the message is sent instantly.
Offline message is supported, but the timetable is not sent.
MORE SETTINGS
More settings
This section contains help for other settings not listed above.
Progressive Web App
The GB Talk admin area is a PWA, which means that you can install it on desktop, Mac, or mobile devices and use it like a fully-functional app.
Note: This feature is optimized for Google Chrome.
Desktop installation
Enter in your admin area https://chat.gbtalk.net, and click the
+ icon on the top right of the URL bar of your Chrome browser.
Mobile installation
Enter in your admin area with Google Chrome https://chat.gbtalk.net
Open your browser's settings.
Scroll down and tap
Add to Home screen.
Confirm by tapping Add.
Keyboard shortcuts
Admin area keyboard shortcuts are enabled on both PC and MAC and work as follows:
Shortcut
Description
ENTER
or
SPACE
Confirm or close a dialog alert; the same as clicking
OK.
ESC
or
CANCEL
Decline a dialog alert and close it.
SHIFT + ENTER or
CTRL + ENTER
Add a line break to a message. This only works for the admin editor.
ESC
Close a lightbox.
CANCEL
In the admin conversations area, archive a conversation, or delete it.
CTRL + UP/DOWN ARROW
In the admin conversations area, navigate between the conversations of the list.
CTRL + RIGHT/LEFT ARROW
In the admin users area, navigate between the users.
CTRL + V
Paste an image from the clipboard and send it as message.
Supervisor
Supervisors must be administrators.
Add multiple supervisors by adding comma separated admin IDs.
URL parameters
Front-end chat
URL parameters allow the chat to perform specific actions on page load. To use them, append the URL parameters below to any URL on your website that displays the chat.
Ex. https://chat.gbtalk.net/?conversation=1234
URL parameter
Description
?token=TOKEN
Login an existing user. Replace TOKEN with the user's token.
?conversation=ID
Open a conversation. Replace ID with the conversation ID.
The attribute token is required for not logged in users.
?chat=open
Open the chat.
Admin area
URL parameters allow the administration area to perform specific actions on page load. To use them, append the URL parameters below to your admin URL.
Ex. https://chat.gbtalk.net/admin.php?conversation=1234
URL parameter
Description
?conversation=ID
Open a conversation of the conversations area. Replace ID with the conversation ID.
?user=ID
Open the profile box of a user. Replace ID with the user ID.
?setting=ID
Open a setting of the settings area. Replace ID with the setting ID.
?report=ID
Open a report of the reports area. Replace ID with the report ID.
?area=name
Open an area of the admin. Replace name with: conversations, users, settings, reports.