KSIDol documentation > KSIDol modules > Send SMS

Module guide: Send SMS

Non-technical user guide: what the module is for, how to use it and how it fits together with Dolibarr.

SMS providerOVH SMS (API)

Connected Dolibarr records15+ types

Personalization variables~150

Send tracking5 statuses + agenda

1. Module overview

The Send SMS module adds to Dolibarr the ability to send text messages to your customers, prospects, contacts and suppliers, directly from the records you consult every day (third party, quotation, order, invoice, intervention, contract, shipment, member...). A "Send an SMS" button appears on these records: it opens a form pre-filled with the recipient's name and phone number, with no re-keying. Messages are sent via OVH's SMS API, using your validated sender name. The module relies entirely on Dolibarr's native data: it reuses the contact details of third parties and contacts, the references and amounts of documents, and records each send in the agenda to keep a trace. It also offers reusable SMS templates, variables that fill in automatically (name, reference, amount, dates, download links...), full send tracking and per-user SMS quota management.

Send SMS from Dolibarr records (button + built-in window) or from a dedicated menu
Recipient's number and name retrieved automatically from the record
SMS templates with variables that fill in on their own (customer, reference, amount, dates, document links)
Real-time preview, character/segment counter and test mode before actual sending
Tracking of every send with status (sent, queued, failed, test) and the ability to resend
Per-user SMS quota and automatic alerts when the stock runs low
Every send is logged in the Dolibarr agenda, linked to the customer and the relevant document

2. Send an SMS from a record or the menu

This is the main function. A "Send an SMS" button is added to the relevant records (third party, quotation, order, invoice, intervention, contract, shipment, member, contact, as well as supplier orders, invoices and proposals). There is also a dedicated "Send SMS" menu to compose a free-form message.

From a record, the form opens in a movable, resizable window, with the name and phone already filled in
The number can be corrected or entered manually (international format, e.g. +336...)
Message area with a character counter and number of SMS segments
Live message preview, taking replaced variables into account
Send button and immediate display of a confirmation or error message
"Send SMS" menu for a send outside any document (one-off message)

3. Reusable SMS templates

The module lets you build a library of message templates, so you don't have to retype recurring texts (appointment reminder, delivery information, follow-up, etc.). Templates are managed in the "SMS templates" menu.

Create, edit, enable/disable and delete templates
Each template has a code, a label, a content and a type (generic or linked to a document: quotation, order, invoice, intervention, supplier...)
In the send form, you pick a template from a list and apply it in one click
"Test" function: generate a preview of the template from a real object (by entering its identifier) to check the result before using it
Only active templates compatible with the record type are offered for sending

4. Automatic personalization (variables)

Templates and messages can contain variables that are automatically replaced with the real data at send time. The form displays the list of available variables and their value for the current record.

Recipient's contact details: third-party name, contact name, phone
Document information: reference, customer reference, label, notes, dates (creation, validation, due, delivery...)
Document amounts: net, VAT, gross, remaining amount due, in figures or in words
Your company's details (name, address, registration numbers, phone...) and the user's signature
Handy links: direct download of the document (quotation, order, invoice, contract, intervention), online signature link, online payment link
Optional automatic addition of the company signature at the bottom of the message

5. Advanced send options

At send time, several fine-grained settings are available to adapt to the type of message and to regulations.

Message priority: high, medium or low
Message type: transactional (e.g. confirmation, code) or marketing
Delay before sending in minutes: the SMS is deferred by OVH
STOP notice: for marketing SMS the notice is added; it can be disabled for transactional messages
Sender: sender name validated on your OVH account, proposed by default

6. Test mode before actual sending

Test mode lets you prepare and check an SMS without any message actually being sent or billed. Useful for validating a template or its formatting.

"Test mode" switch in the send form (can be enabled by default in the configuration)
A warning banner reminds you that no SMS will be delivered
The test message is saved in the tracking with the "Test" status and does not consume any quota
An event is also created in the agenda to keep a trace of the test

7. Send tracking (history)

The "Send tracking" menu lists all processed SMS, with their status and content, for full control.

Columns: date, recipient, sender, status, context (record type), message and actions
Managed statuses: New, Queued, Sent, Failed, Test
Filters by status, by context (customer, quotation, order, invoice...) and free search (content, recipient, sender)
In case of failure, the error message returned by OVH is displayed
"Send" action to retry an SMS that is queued, failed or new
"Delete" action to remove a line from the history
Reminder of the options used (priority, type, delay, STOP) under each message

8. Per-user quotas and stock alerts

The module lets you assign an SMS quota to each user and monitor the remaining credit, both on the OVH side and on the user side.

Assign a number of allowed SMS per user, with tracking of "used" and "available"
Sending is blocked when the user's quota is exhausted, with an alert message
Badge showing the remaining SMS on the send and configuration pages
Visual alert (card + dot in the top menu) when the stock drops below a configurable threshold
SMS ordering link shown to the user to top up credit
Discrepancy check between the OVH account's actual credit and the total of the assigned quotas

9. Configuration and administration tools

The configuration page (reserved for administrators) centralizes the connection to OVH and the default settings. It also offers verification tools.

OVH SMS connection: endpoint, Application Key, Application Secret, Consumer Key and service (sms-XXXXX), with a help button to generate the OVH access key
Country code handling: automatic detection, systematic addition of the default country code, or no change
Default values: test mode, priority, type, delay, STOP notice, default sender
Display of the SMS credit available on the OVH account
SMS reorder URL and stock alert threshold
"Test the configuration" tool (diagnoses endpoint, credentials, service, API access, tables)
"Reset the module" tool to start over on the current entity (data and settings)

10. Links with Dolibarr

The module does not work in isolation: it integrates with the native building blocks of Dolibarr.

Third parties and contacts : The module reads the name and phone number (mobile as priority) of the third party or contact to pre-fill the send. An SMS button is added to third-party and contact records, and the customer is linked to the created agenda event.
Customer quotations, orders and invoices : An SMS button appears on commercial proposals, orders and invoices. Variables reuse the document's reference, dates and amounts (net, VAT, gross, remaining due), and can insert a direct download link, an online signature link or an online payment link.
Interventions, contracts and shipments : Intervention, contract and shipment/delivery records also feature the SMS button, retrieving the customer and their contact details and a document download link when one exists.
Supplier documents : The module is also added to supplier orders, invoices and proposals, reusing the supplier third party and the corresponding references.
Agenda (events) : Each SMS (sent, failed or test) automatically generates an event in the Dolibarr agenda, linked to the customer, the contact, the source document and the project where applicable, with the status, the sender and an excerpt of the message.
Members : Member records are supported: send an SMS to a member, with a link to their related company if one exists.
Documents, online signature and payment : Variables can insert direct download links for PDF documents, as well as the native online signature and online payment links generated by Dolibarr.
Issuing company and users : Your company's details (legal information, address, registration numbers) and the connected user's signature feed the variables and the signature added to the SMS; send quotas are managed per Dolibarr user.