link"Add-on eComBot- Telegram, Viber, FB Messenger chat bots for ecommerce" documentation

Add-on is compatible with the following Themes:

• YoupiTheme (compatible with correspond CS-Cart version);
• UniTheme2 (compatible with correspond CS-Cart version);
• Responsive.

General technical support conditions are available at this link (be sure to review these conditions, all solutions from the AlexBranding development team come with limited technical support).

In order to use our technical support, you need to:

1. Log in with your order owner account on https://cs-cart.alexbranding.com;
2. Go to the page My Account → Orders;
3. Find the corresponding order with the problem add-on in the orders list and pass to its details;
4. Find the “Support” link next to the corresponding add-on name (near you can find Documentation link also) and click on it;
5. Fill in the data with the problem, provide access to your CS-Cart installation (path to the administration panel, admin mail, admin password + FTP access) and create a ticket (after you will create the ticket, you will receive an e-mail and a special code to track the ticket in the future);
6. Wait for the specialist answer in accordance with the regulations of the technical support service and the priority of your ticket.

If you didn't receive an answer within the deadlines, according to the chosen ticket priority, send e-mail info@alexbranding.com with the ticket number, for which you did not receive an answer in time, and the team manager will solve the problem in compliance with regulations.

You can test the addon work with admin access using our demo server Demos for CS-Cart solutions from Alexbranding by choosing it in Addons list or just follow the link.

We recommend to note general restrictions:

1. All solutions from AlexBranding developers team require pre-installation of the AB: Addons Manager service addon. It is delivered free of charge and is responsible for such services: installation, upgrades, license verifications. Excluding this service addon usage is not possible;
2. Addon files may have a closed (encoded) part, in which only a license check is located;
3. The addon will work only on those domains, that are specified in the user's license. If you try to use the solution on CS-Cart installations, whose domains are not included in the license, the addon will be automatically turned off;
4. Local installation is not possible, so that the addon works on the additional domain (subdomain), enter this domain (subdomain) in the Domain field, when ordering (or write to info@alexbranding.com) - adding technical domains for the developing or for testing is always free.

After your order has been processed by our manager, it will be transferred to Completed state, you will receive an email to your mailbox with ordered add-ons license numbers (usually it takes from 15 minutes to 8 hours depending on the day time and week day).

Then follow the steps below, which differs depending on your version of the CS-Cart platform:

You can also install the add-on with a standard installation for CS-Cart. To do this, download the appropriate archive with an add-on version compatible with your version of the CS-Cart platform.
Go to the website cs-cart.alexbranding.com, log in under the account of the order holder and go to the page My Profile → Orders → Relevant Order, go to details and you will see a list of available archives for the ordered add-on. Download the version (archive) you need and make the installation (standard for CS-Cart installation: Add-ons → Downloaded add-ons and in the gearwheel menu select Manual installation).

To start using the add-on do the following:

1. Install the add-on in the ordinary way of CS-Cart
2. Set messengers and get API keys.
3. Specify API keys of messengers at the add-on settings.
4. Specify available languages to communicate with clients in messengers.
5. Create and activate message templates to track prices for decrease and increase of product prices.
6. Create promotion to form promo code with discount.
7. Create and activate messages to provide promo code with discount.
8. Set Cron tasks for automatic dispatch of messages to the clients that have already begun to track product(s).

For access to the add-on settings you should go to the page Administration panel → Add-ons → Manage add-ons and at the add-on name in the gearwheel menu select appropriate menu item.

To set Telegram messenger refer to “Telegram dimensioning guide” (you can take this link on the page Bot list in the tooltip to the field of API key as well.)

To set Viber messenger refer to “Viber dimensioning guide” (you can take this link on the page Bot list in the tooltip to the field of API key as well.)

After getting API key, copy it to the corresponding field on the page Bot list.

Tracked events with the add-on:

• Client's full name who has subscribed to price tracking of a product;
• Client’s nickname — name variant that the user entered in the messenger;
• Number of tracked products — add-on counts all products that are tracked.

To set Messenger refer to “Messenger dimensioning guide” (you can take this link on the page Bot list in the tooltip to the field Token as well.) To set the messenger accurately, follow step-by-step instructions:

1. Create the Page with a type Company or Brand at Facebook.

2. Create developer account at Facebook on the website Facebook Developers, where you should click the button Get Started and select the type Developer:

   • select the application type Company;
   • on the page Add products to application click the button Add products to your app click the button Set up at the product Messenger (Customize the way you interact with people on Messenger);
   • in the section Access Tokens click Add or remove Pages and link the application with your Facebook Page;
   • in the section Access Tokens click Generate token and copy it.

3. Go to the add-on page EcomBot: Bot list to set the bot Messenger:

   • in the field Token paste generated token;
   • in the field Verify token enter random phrase;
   • add greeting text;
   • save your data;
   • copy generated link Callback URL.

4. Go back to the website Facebook Developers, where on the page Messenger → Settings in the section Webhooks act as follows:

   • paste Callback URL and enter your made-up Verify token;
   • in the table below in front of Facebook Page click Edit and choose the following Subscription Fields: messages, messaging_postbacks, messaging_referrals, messaging_optins.

5. Go to Facebook Page and set the access:

   • on the page Settings go to the division Advanced messaging;
   • in the section Requested features click the button Request in front of the option One-time notification.

Tracked events with the add-on:

• Client's full name who has subscribed to price tracking of a product;
• Client’s nickname — name variant that the user entered in the messenger;
• Number of tracked products — add-on counts all products that are tracked.

On the page Bot list (Administration panel → Manage add-on → AB: EcomBot → Bot list) you can set messengers that are available to work with bots.

1. API key — after receiving API key place it to this field;
2. UTM stamp (utm_source) — stamp that is used to track advertising campaign on the Internet. Now UTM stamp does not work at messengers;
3. Position — manage disposition order of messenger button;
4. Status — status of messenger activity.

1. API key — after receiving API key place it to this field;
2. Message author — title or name that will be displayed in dialog of the messenger. You can use bot name that you used to create the bot;
3. Message logo — link to image that will be set as a message logo instead of bot image. Maximum size is 720px x 720px, 100Kbit;
4. UTM stamp (utm_source) — stamp that is used to track advertising campaign on the Internet. Now UTM stamp does not work at messengers;
5. Position — manage disposition order of messenger button;
6. Status — status of messenger activity.

1. Token — after receiving Token place it to this field;
2. Verify token — enter random phrase for verify token;
3. Greeting text — enter greeting text that will be displayed in messenger;
4. Callback URL — copy generated link “Callback URL” and paste it together with your random “Verify token” on the website “Facebook Developers”;
5. Position — manage disposition order of messenger button;
6. Status — status of messenger activity.

On the page Script list (Administration panel → Manage add-ons → AB: EcomBot → Script list) there is the template list with its settings and messages for actions and events in the messenger. On this page you can manage template settings, edit and enable/disable templates (status management is available after saving of template settings only) as well as specify languages that will be used to send messages in the messenger. For each template and its messages there is text formatting and set of appropriate placeholders available.

On the page there is activation and setting list to track prices on decrease and increase separately.

1. Tracking time, days — number of days that process of product price tracking will be held;
2. Product availability accounting — influences on buttons display and sending of messages;
3. Tracking on decrease — price tracking on decrease;
4. Tracking on increase — price tracking on increase. There are settings to track prices on decrease and increase separately:
   • Enable — ability to enable and disable corresponding price tracking;
   • Delta price type — ability to choose a variant of price inaccuracy: Absolute - deviation between primary sum and its precise value; Relative - percentage of price inaccuracy;
   • Delta price value — value when messages about price changing will be sent to users.
5. Status — status of Price tracking script activity.

On the page there are messages for actions and events in the messenger. You can use special tags in the messages to format text. To format text wrap appropriate part of code with opening and closing tag.

The following placeholders are available in messages:

• [product_name] - Product name
• [tracking_days] - Number of days to track (provided for message template “Message when adding has been successful” from the section “Action. Add a product to tracking)
• [product_link] - Link to product
• [current_price] - Current product price
• [current_price_with_currency] - Current product price with a currency
• [previous_price] - Previous product price
• [previous_price_with_currency] - Previous product price with a currency
• [price_difference_percent] - Variation of prices between previous and current price in percentage terms
• [price_difference] - Variation of prices between previous and current price
• [firstname] - Customer name
• [lastname] - Customer surname
• [username] - Username (nickname) of a customer
• [any_name] - Customer name or customer surname, or username, or any value of the language variable eb.clients.no_name. The first filled in value will be chosen
• [counter] - Counter of messages that were sent together (provided for message template “Message when a product is available on the storefront and has a price” from the section “Action. Get a list of tracking products”)
• [price_tracking_start] - Date and time of tracking start

Tab is designed to send personal discount to users with the help of generated promo codes.
In the first place you shall use standard CS-Cart mechanic Marketing → Promotions and create a separate promotion for Cart, where in the tab Bonus you should select Use discount on the product from the sent promo code. Do not establish conditions for the promotion as discount value will be set in the template Price tracking, tab Offer discount itself. Here you shall link created promotion with offered discount by selecting the promotion in the field Related promotion.

Further, you shall create a message, specify time of sending and discount value by promo code. By default all messages will be sent by Cron task Plan sending of promo code according to appointmented time for each message individually.
All generated promo codes and its state can be specified on the page Promo codes list.

1. Enable — ability to enable and disable sending of promo code by Cron task;
2. Related promotion — select promotion for Cart. Bonuses from selected promotion will be used if a user places active promo code. Current conditions that were set for the selected promotion will be missed. To form promo code you shall add the bonus “Use discount on the product from the sent promo code” in the tab “Bonus” of the appropriate promotion.
3. Newsletter strategy — adds strategies with an ability to set unique messages and settings.

There is a functionality that allows to work at unique case in the pop-up window of settings of newsletter strategy. Among conditions there following: price range, number of available products and selection of categories to assign personal discounts.
After saving of conditions, tab Offer discount will be available. At this tab you shall create a message with promo code, specify when this message should be sent and set a size of a discount that will be given with a promo code. There are tooltips at every setting so you could use the functionality easy.

For example, condition of time Through specified time with a range 00:20 allows to send user an automatic message by Cron task after 20 minutes when the user subscribes to track a price of a product.

In the field Lifetime, m you shall always specify a value more than zero. Otherwise, your message won't be sent.

Button Test allows to check every message separately and send promo code with a discount individually to a client-subscriber for a specific tracked product. Pay attention that any conditions, specified for the newsletter strategy, will be ignored. It is designed to test your message for sending it to individual user only.

Special tags are available for each message to format text as well as the following placeholders:

• [product_name] - Product name
• [product_link] - Link to product
• [current_price] - Current product price
• [current_price_with_currency] - Current product price with a currency
• [firstname] - Customer name
• [lastname] - Customer surname
• [username] - Username (nickname) of a customer
• [any_name] - Customer name or customer surname, or username, or any value of the language variable eb.clients.no_name. The first filled in value will be chosen
• [promo_code] - Promo code
• [discounted_price] - Price with promo code
• [price_tracking_start] - Date and time of tracking start

This page is provided to set standard message templates within a framework of installed languages. Selected languages on this page allows your clients to choose desired language of messages and communication in the messengers.

• Available languages — language variants that can be used for messages in a messenger;
• Status — status of template activity.

On the page there are messages for actions in the messenger. You can use special tags in the messages to format text. To format text wrap appropriate part of code with opening and closing tag.

The following placeholders are available in messages:

• [firstname] - Customer name
• [lastname] - Customer surname
• [username] - Username (nickname) of a customer
• [any_name] - Customer name or customer surname, or username, or any value of the language variable eb.clients.no_name. The first filled in value will be chosen

On the page Customer list (Administration panel → Manage add-ons → AB: EcomBot → Customer list) there is an information about customers and their tracked products.

Following information about customers is available:

• Customer’s full name;
• Customer’s nickname;
• Bot name;
• List of tracked products.

On the page List of tracking products (Administration panel → Manage add-ons → AB: Ecombot → List of tracking products) there is an information about products that are tracked by customers.

Following information is available:

• Name of tracking product;
• Customer’s full name;
• Customer’s nickname;
• Tracking period (from, to);
• Product base price;
• Price in a customer's currency;
• Customer's currency.

Page Promo codes list (Administration panel → Manage add-ons → AB: EcomBot → Promo codes list) is designed to save and control promo codes that were formed by means of sent messages with promo codes of appropriate discount (page Price tracking, tab Offer discount). On the page there is recorded data for each promo code. If any promo code was used, there will be a link to the formed order.

Following information is available:

• Promo code;
• Product name;
• Percentage discount that is given by promo code;
• Date and time of promo code creation;
• Status of promo code use.

On the page Cron tasks (Administration panel → Manage add-ons → AB: EcomBot → Cron tasks) you can set automatic sending of messages about price changing at tracking products and delete outdated trackings. You may set these tasks as individually as all together by means of the third Cron task.
To send messages with promo codes of personal discount, use the Cron task Plan sending of promo code and Send messages from queue.
You may perform the actions above manually, by clicking the button Go in front of the corresponding action.

Sending of the planned messages will be done with a delay in 0.35 seconds. This limit is established according to messengers recommendations to avoid sending to be blocked. Thus, when you specify a parameter --limit=1000 then 1,000 trackings will be processed within maximum 350 seconds (about 6 minutes). This time may be less if there are tracked products where notifications are not needed (price was not changed or changed insufficiently, products are not available on the storefront or products without price).