Esendex Messenger by Blesta.Club - Product Overview

Welcome, and thank you for choosing the Esendex Messenger! We're delighted to have you as a customer and are committed to ensuring you have a seamless experience. This guide aims to walk you through the installation and configuration of your new extension. If you're new to Blesta or encounter any issues, please don't hesitate to reach out for support.

Messenger Capabilities

The Esendex Messenger is designed to send SMS notifications for various events in Blesta, ensuring you stay informed and connected with your clients and team. The notifications are categorized as follows:

Client Messages

1. Account Registration
   • Description: Welcome notice sent for new account registrations.
2. Auto-Debit Pending
   • Description: Notice indicating an upcoming automatic payment.
3. Invoice Delivery (Paid)
   • Description: Notice containing the total amount of a paid invoice.
4. Invoice Delivery (Unpaid)
   • Description: Notice containing the total amount of an unpaid invoice.
5. Invoice Notice (1st, 2nd, 3rd)
   • Description: Reminder or late notice for invoice payments.
6. Quote Delivery
   • Description: Notice containing a quote number and link.
7. Service Creation
   • Description: Notice sent when a service is created.
8. Service Scheduled Cancellation
   • Description: Notice sent when a service is scheduled for cancellation.
9. Service Suspension
   • Description: Notice sent when a service is automatically suspended.
10. Service Unsuspension
    • Description: Notice sent when a service is automatically unsuspended.

Staff Messages

1. Quote Approval
   • Description: Notice sent after a quote is approved by the client.

Plugin Messages

1. Order Received
   • Plugin: Order System
   • Description: Notice sent when an order is received.
2. Staff Ticket Assigned
   • Plugin: Support Manager
   • Description: Notice sent to a staff member when a ticket is assigned to them.
3. Staff Ticket Updated
   • Plugin: Support Manager
   • Description: Notice sent to a staff member when a ticket is updated.

Setting Up the Messenger

Install the Messenger

1. Download the Messenger:

   • Obtain the Esendex Messenger from the download section of the client area.

2. Upload to Blesta:

   • Upload the Esendex Messenger to your Blesta messenger directory:

     /var/www/html/blesta/components/messengers/esendex/

3. Install the Messenger:

   • Log in to your admin Blesta account and navigate to Settings > Messengers.
   • Find the Esendex Messenger and click the "Install" button.

Configure the Messenger

1. Manage the Messenger:

   • Navigate to Settings > Messengers (/admin/settings/company/messengers/installed/).
   • Find the "Esendex" Messenger and click on "Manage".
   • Input your From (Name), Account Reference, Email, and Password. If you don't know how to find them, refer to the instructions below.

2. Set the Optional Settings:

   • Default Country Code: the bare dialling code for your country, for example 44 for the UK. Numbers stored in local format with a leading zero, or written as +44 (0)7700 900123, are converted to the international format Esendex expects. Leave it blank to send numbers exactly as they are stored.
   • API URL: leave it blank to use https://api.esendex.com/v1.0, and fill it in only if Esendex has given your account a different host. It must be a full https:// address, because your account credentials are sent with every request.
   • Enable Mock API: simulates deliveries from built-in sample responses instead of contacting Esendex, so you can trial the messenger before you have an account. Turn it off for live sends.

3. Test Your Settings:

   • Enter a Test Number and click Test Connection. One test SMS is sent and the result appears next to the button, showing exactly what Esendex said. A test never saves your settings, so click "Update Settings" afterwards to keep them.

4. Messenger Configuration:

   • Under "Messengers", click on "Messenger Configuration".
   • Assign Esendex to the SMS Message Type (currently the only one supported by Blesta).

5. Enable Notifications:

   • Under "Messengers", go to "Message Templates".
   • Ensure the relevant templates are enabled.

Finding Your Account Reference, Email, and Password

• Account Reference:

  • Click on "Administration" at the top right inside Esendex. This will open a page with your accounts. The Account Reference is next to your account name and looks like EX0000000.

• Email:

  • Use your Esendex account email.

• Password:

  • Go to "My Details" at the top right inside Esendex.
  • Scroll down and click "Generate new API password" under "Change API password".
  • Your password is stored encrypted and is never shown back to you. Leave the Password field blank when you save to keep the password already stored, and type a value only when you want to replace it.

Which Number Gets the Text

Notifications go to the recipient's mobile number - the mobile on a client contact's record, or a staff member's mobile number. If a client contact has no mobile stored, their other phone numbers are used instead. Fax numbers are never texted.

Troubleshooting Notifications

• Order Notifications:

  • Go to Billing > Overview (/admin/billing/index/).
  • Scroll to the bottom. You should see an "Orders" panel. In its corner, there is a cogwheel for changing its settings. Click on it, then under "Order Notifications" enable "Messengers". Click "Update Settings" to save your changes.

• Ticket Notifications:

  • Go to Support > Departments (/admin/plugin/support_manager/admin_departments/).
  • Edit your desired department and check "Send Auto-Response Emails for New Tickets". Save your changes by clicking "Edit Department".

• Staff Ticket Notifications:

  • Go to Support > Staff (/admin/plugin/support_manager/admin_staff/).
  • Edit your desired staff member and check which ticket priorities should be sent to the Messenger. Save your changes by clicking "Edit Staff".

Contact Us

If you encounter any issues or have suggestions for improving the extension, please get in touch with us. We are committed to providing robust updates and welcome customer feedback.

Esendex Messenger by Blesta.Club - Installation Guide

Welcome, and thank you for purchasing the Esendex Messenger! We're delighted to have you as a customer and are committed to ensuring you have a seamless experience. This README aims to guide you through the installation of your new extension. If you're new to Blesta or encounter any issues, please don't hesitate to reach out for support.

Installation Guide

For detailed instructions on how to install the Esendex Messenger, please ensure you have the license manager installed for leased extensions and then follow these steps:

1. Obtain the Messenger:

   • Download the Esendex Messenger from the download section of the client area.

2. Upload to Blesta:

   • Upload the Esendex Messenger to your Blesta messenger directory:

     /var/www/html/blesta/components/messengers/esendex/

3. Install the Messenger:

   • Log in to your Blesta admin account.
   • Navigate to Settings > Messengers.
   • Find the Esendex Messenger and click the "Install" button.

4. Configuration:

   • Click "Manage" on the Esendex Messenger and enter your From (Name), Account Reference, Email and Password, plus the optional Default Country Code and API URL. Detailed configuration instructions can be found in the usage guide.
   • No Esendex account yet? Tick Enable Mock API and the messenger runs from built-in sample responses, so you can trial every screen and action with no credentials. Untick it before going live.

5. Check It Works:

   • Enter a Test Number and click Test Connection. One test SMS is sent and the result is reported next to the button. A test never saves your settings, so click "Update Settings" afterwards to keep them.

6. Assign It to the SMS Message Type:

   • Under Settings > Messengers, click "Messenger Configuration" and assign Esendex to the SMS message type. Installing the messenger alone does not send anything - this step is what makes Blesta hand notifications to it.

You're now done with the installation! Proceed to configure the messenger as needed by following the usage guide.

Contact Us

If you encounter any issues or have suggestions for improving the extension, please get in touch with us. We are committed to providing robust updates and welcome customer feedback.

Esendex Messenger by Blesta.Club - Updating Guide

To keep your Esendex Messenger up-to-date, follow the steps outlined below:

Updating Guide

1. Obtain the Updated Messenger:

   • Download the latest version of the Esendex Messenger from the download section of my.blesta.club.

2. Upload to Blesta:

   • Upload the updated Esendex Messenger to your Blesta messenger directory:

     /var/www/html/blesta/components/messengers/esendex/

3. Update the Messenger:

   • Log in to your Blesta admin account.
   • Navigate to Settings > Messengers.
   • Find the Esendex Messenger and click the "Update" button.

4. Blesta version (updating to 3.0.0):

   • From 3.0.0 the Esendex Messenger is built for Blesta 6.0 and newer and no longer runs on Blesta 5. Upgrade Blesta first; if you must stay on Blesta 5, keep the last 2.x release.
   • Nothing else changes on update: your saved settings carry over exactly as they are, and the Manage page only picks up the Blesta 6 admin styling.

5. Know how the Password field behaves (updating to 2.0.0):

   • The Password is stored encrypted and is never shown back to you. Leave it blank when you save to keep the password already stored, and type a value only when you want to replace it. Changing any other setting no longer disturbs your credentials.
   • The same applies to the connection test: re-enter your Password before running a live test on an already-configured messenger.

6. New optional settings (no action required):

   • Default Country Code converts numbers stored in local format to the international format Esendex expects. It defaults to blank, which sends numbers exactly as they are stored, so existing installs behave as before until you fill it in.
   • API URL lets an account on a different Esendex host work without editing code. It defaults to blank, which means https://api.esendex.com/v1.0. It must be a full https:// address, because your account credentials are sent with every request.
   • Enable Mock API simulates deliveries from built-in sample responses so you can trial the messenger without an account. It defaults to off. While it is on, real notifications are simulated rather than delivered, so untick it before going live.
   • Test Number and the Test Connection button send one test SMS and report the result on the page without saving your settings.

No additional changes are needed outside of updating the files. Any breaking changes will be communicated to clients.

Keep your Esendex Messenger up-to-date to ensure you have the latest features and improvements.

Contact Us

If you encounter any issues or have suggestions for improving the extension, please get in touch with us. We are committed to providing robust updates and welcome customer feedback.

Esendex Messenger by Blesta.Club - Usage Guide

Once your Esendex Messenger is installed, you'll want to configure it to suit your needs. Follow the steps below for a comprehensive setup.

Settings

All settings live on Settings > Messengers (/admin/settings/company/messengers/installed/), under "Manage" on the Esendex Messenger.

Connecting to Your Esendex Account

• From (Name): the sender name that appears on every message, so texts arrive branded as your company.
• Account Reference: your Esendex account reference, which looks like EX0000000.
• Email: your Esendex account email.
• Password: your Esendex API password.

Your password is stored encrypted and is never shown back to you. Leave the Password field blank when you save to keep the password already stored, and type a value only when you want to replace it, so changing any other setting no longer disturbs your credentials.

Optional Settings

• Default Country Code: the bare dialling code for your country, for example 44 for the UK. Numbers stored in local format with a leading zero, or written as +44 (0)7700 900123, are converted to the international format Esendex expects before sending. Leave it blank to send numbers exactly as they are stored.
• API URL: the base address of the Esendex REST API. Leave it blank to use https://api.esendex.com/v1.0, and fill it in only if Esendex has given your account a different host. It must be a full https:// address; a plain http:// or an address with no scheme is rejected, because your account credentials are sent with every request.
• Enable Mock API: runs the messenger from built-in sample responses instead of contacting Esendex, so you can trial it before you have an account. No credentials are needed while it is on. Turn it off for live sends - while it is on, real notifications are simulated rather than delivered.
• Test Number: the number that "Test Connection" texts. It is not saved with your settings.

Testing Your Settings

Click Test Connection to send one test SMS to your Test Number. The result appears next to the button and shows exactly what Esendex said, so a wrong account reference or an expired API password is obvious immediately, and a failure to reach Esendex at all is reported as such rather than as a bare error code. A test never saves anything - click "Update Settings" afterwards to keep what you typed. Because the Password field is never shown back to you, re-enter it before running a live test on an already-configured messenger. With Enable Mock API ticked you can run the test with no credentials at all.

Which Number Gets the Text

Notifications go to the recipient's mobile number: the mobile on a client contact's record, or a staff member's mobile number. If a client contact has no mobile stored, their other phone numbers are used instead. Fax numbers are never texted.

Message Length

Each notification is measured in real SMS segments, distinguishing standard GSM text from Unicode, and the segment count and encoding are recorded with the send so you can see what a notification actually costs. Very long bodies are trimmed at a clean character boundary rather than being rejected by the carrier, and HTML from your message templates is stripped so tags never consume billable segments. What was sent and what Esendex answered is recorded in Blesta's messenger log under Tools > Logs; your credentials are never written to it.

Messenger Capabilities

The Esendex Messenger is designed to send SMS notifications for various events in Blesta, including:

Client Messages

1. Account Registration
   • Description: Welcome notice sent for new account registrations.
2. Auto-Debit Pending
   • Description: Notice indicating an upcoming automatic payment.
3. Invoice Delivery (Paid)
   • Description: Notice containing the total amount of a paid invoice.
4. Invoice Delivery (Unpaid)
   • Description: Notice containing the total amount of an unpaid invoice.
5. Invoice Notice (1st, 2nd, 3rd)
   • Description: Reminder or late notice for invoice payments.
6. Quote Delivery
   • Description: Notice containing a quote number and link.
7. Service Creation
   • Description: Notice sent when a service is created.
8. Service Scheduled Cancellation
   • Description: Notice sent when a service is scheduled for cancellation.
9. Service Suspension
   • Description: Notice sent when a service is automatically suspended.
10. Service Unsuspension
    • Description: Notice sent when a service is automatically unsuspended.

Staff Messages

1. Quote Approval
   • Description: Notice sent after a quote is approved by the client.

Plugin Messages

1. Order Received
   • Plugin: Order System
   • Description: Notice sent when an order is received.
2. Staff Ticket Assigned
   • Plugin: Support Manager
   • Description: Notice sent to a staff member when a ticket is assigned to them.
3. Staff Ticket Updated
   • Plugin: Support Manager
   • Description: Notice sent to a staff member when a ticket is updated.

Setting Up the Messenger

1. Configure the Messenger:

   • Navigate to Settings > Messengers (/admin/settings/company/messengers/installed/).
   • Find the "Esendex" Messenger and click on "Manage".
   • Input your From (Name), Account Reference, Email, and Password. If you don't know how to find them, refer to the instructions below.
   • Set a Default Country Code if your contacts' numbers are stored in local format.
   • Click "Update Settings" to save.

2. Check the Connection:

   • Enter a Test Number and click Test Connection. The result appears next to the button.
   • If you don't have an Esendex account yet, tick Enable Mock API first to try it with no credentials, then untick it before going live.

3. Messenger Configuration:

   • Under "Messengers", click on "Messenger Configuration".
   • Assign Esendex to the SMS Message Type (currently the only one supported by Blesta).

4. Enable Notifications:

   • Under "Messengers", go to "Message Templates".
   • Ensure the relevant templates are enabled.

Installing the messenger alone does not send anything - step 3 is what makes Blesta hand notifications to it.

Finding Your Account Reference, Email, and Password

• Account Reference:

  • Click on "Administration" at the top right inside Esendex. This will open a page with your accounts. The Account Reference is next to your account name and looks like EX0000000.

• Email:

  • This is your Esendex account email.

• Password:

  • Go to "My Details" at the top right inside Esendex. Scroll down and click "Generate new API password" under "Change API password".

Troubleshooting Notifications

Not getting order notifications?

1. Order Notifications:
   • Go to Billing > Overview (/admin/billing/index/).
   • Scroll to the bottom. You should see an "Orders" panel. In its corner, there is a cogwheel for changing its settings. This.
   • Click on it, then under "Order Notifications" enable "Messengers". Enable "Messengers".
   • Click "Update Settings" to save your changes. Update Settings.

Not getting ticket notifications?

1. Ticket Notifications:

   • Go to Support > Departments (/admin/plugin/support_manager/admin_departments/).
   • Edit your desired department and check "Send Auto-Response Emails for New Tickets". Send Auto-Response Emails for New Tickets.
   • Save your changes by clicking "Edit Department". Edit Department.

2. Staff Ticket Notifications:

   • Go to Support > Staff (/admin/plugin/support_manager/admin_staff/).
   • Edit your desired staff member and check which ticket priorities should be sent to the Messenger. Ticket Priorities.
   • Save your changes by clicking "Edit Staff". Edit Staff.

Contact Us

If you encounter any issues or have suggestions for improving the extension, please get in touch with us. We are committed to providing robust updates and welcome customer feedback.