SMS & Viber Notifications with Yuboto Documentation Prestashop Module

This module connects your PrestaShop store to Yuboto Octapush, so you can send SMS or Viber messages to your customers straight from PrestaShop. Messages can go out automatically whenever an order changes to a status you choose, or manually at any time, either from the order page or from a dedicated Send SMS screen.

You decide which channel is used: SMS only, Viber only, or Viber with an automatic SMS fallback if the Viber message cannot be delivered. Every message sent is logged, so you always have a record of what was sent, when, and whether it was delivered.

1. In your back office go to Modules › Module Manager › Upload a module, and choose the module ZIP file.
2. Alternatively, unzip the archive and upload the zosmsuboto folder to /modules/ on your server via FTP.
3. Search for “01 SMS Viber with Yuboto Octapush” in the Module Manager, click Install, then Configure.

Before you go live: get your Yuboto Octapush credentials ready first, then fill in the Credentials and Settings tabs before turning on any order status messages.

This module sends messages through your own Yuboto Octapush account, so you need an account there before it can send anything.

• Yuboto account: sign up for an Octapush account at Yuboto if you do not already have one, and top up a balance for SMS and/or Viber sending.
• API key: from the Yuboto Octapush admin page, open Programmers and generate an API key using the first option offered.
• SMS sender name: the name shown as the sender of your SMS messages. Up to 11 letters and digits with no spaces (for example your company name), or a numeric sender.
• Viber sender: only needed if you plan to send Viber messages. This must match the business Viber sender name approved on your Yuboto account.

Reached from Modules › Module Manager › 01 SMS Viber with Yuboto Octapush › Configure, the Credentials and Settings tabs control how messages are sent.

Credentials tab

Enter your SMS sender name, Viber sender name and API key here.

Send method

Choose how messages are sent: SMS sends only text messages, Viber sends only Viber messages, and Viber Fallback tries Viber first and automatically sends an SMS instead if the Viber message is not delivered, not seen, expired, blocked or rejected. Viber Fallback is the suggested choice for most stores.

• Balance alert: when enabled, your Yuboto balance is checked on every message sent, and a warning is shown in the back office if it drops below the amount you set.
• Balance amount: the threshold used for the balance alert above.
• Viber expiry text: the text shown to the recipient if a Viber message expires before being seen. Leave empty to use Yuboto's default text.
• Show message form in order: when enabled, adds a message panel directly inside the order page, so you can send an instant SMS or Viber message to that customer.

The Order States tab lists every order status configured in your shop. For each status you can:

• Turn the automatic message for that status on or off
• Write the message text to send, separately for each installed language

Whenever an order changes to a status with messaging enabled, the module automatically sends the corresponding text to the customer's phone number, using the send method chosen in Module Settings. If the text for a status is left empty, no message is sent for that status.

You can use the following placeholders anywhere in your order status message texts. Each one is automatically replaced with the matching order detail before the message is sent.

For example, the text “Hi [*name*], your order [*reference*] has shipped. Track it here: [*tracking_url*]” is sent to the customer with every placeholder filled in automatically.

When Show message form in order is enabled, every order page shows a message panel where you can:

• See the phone number the module will send to, taken from the delivery address, or from the customer's own phone number if the address has none
• Write and send a one-off custom message to that customer, right away, without waiting for a status change
• View the most recent messages sent for that order, along with their result
• Open the full Message History for that order in one click

This is useful for answering a question, confirming a detail, or following up, without leaving the order page.

The module also adds a standalone Send SMS page to your back office menu, useful for messages that are not tied to a specific order. From this page you can:

• Search for and select an existing customer by name or email, and the module looks up their phone number automatically
• Or type a phone number directly, for a contact who is not a registered customer
• Optionally override the send method for this one message only (SMS, Viber, or Viber Fallback), instead of using the module's default
• Write the message text and send it

The module automatically checks the text of every message before sending it. Messages using only standard Latin characters and punctuation (GSM-7 encoding) allow up to 160 characters in a single message; messages containing Greek letters or other special characters (Unicode encoding) allow up to 70 characters in a single message.

Longer texts are automatically split into multiple linked parts and billed accordingly by Yuboto, up to an overall limit of 2000 characters. If a message text goes over this limit, the module blocks the send and shows an error instead of sending a broken or truncated message.

With Check balance and alert enabled, the module checks your Yuboto balance in the background whenever the settings page is saved, and again on each message sent. If the balance is at or below the threshold you set, a warning is shown in the back office so you can top up before you run out and messages stop being delivered.

Every message the module sends, whether automatic or manual, is recorded under Advanced Parameters › SMS History. Each entry shows the date, the related order (if any), the customer, the phone number, the result, and any error returned by Yuboto, so you can review exactly what was sent and confirm it went through.

To adjust any of the module's own wording, go to International › Translations, choose Installed modules translations, select 01 SMS Viber with Yuboto Octapush and your language, edit the fields you want to change, then save. Your order status message texts themselves are written per language directly on the module's Settings page, not through the Translations page.

Found an issue, or have a suggestion to make the module better? We would love to hear from you, please open a ticket on addons.prestashop.com under your purchase, so we can help as quickly as possible.