https://github.com/moceanapi/dolibarr
https://github.com/moceanapi/dolibarr
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/moceanapi/dolibarr
- Owner: MoceanAPI
- Created: 2022-04-08T10:03:17.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-11-02T06:08:50.000Z (about 2 years ago)
- Last Synced: 2025-02-08T17:09:44.590Z (11 months ago)
- Size: 26.4 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dolibarr MoceanAPI module user documentation
## Table of Contents
- [Installation](#installation)
- [Prerequisites](#prerequisites)
- [Features](#features)
- [Send SMS Notification](#send-sms-notification)
- [Configuration](#configuration)
- [Send Invoice Reminder](#send-invoice-reminder)
- [Reminder Prerequisite](#reminder-prerequisite)
- [Set PHP timezone in server](#set-php-timezone-in-server)
- [Setup Cron Job](#setup-cron-job)
- [Send Reminder Configuration](#send-reminder-configuration)
- [Voice call](#voice-call)
- [Frequently Asked Questions](#faq)
- [Feature Request](#feature-request)
- [Feedback](#feedback)
## Installation
1. Download the latest version of MoceanAPI module [here](https://www.dolistore.com/en/modules/1615-MoceanAPI-Send-SMS.html)
2. Go to **Setup - Modules/Application**
3. Search for **MoceanAPI** and activate the module.
4. Installation is now complete and you can access the module via **Top Navigation**
## Prerequisites
1. Before you can send SMS, you need a `MoceanAPI account`. Register an account [here](https://dashboard.moceanapi.com/register?fr=dolibarr) in 5 minutes or less
2. Navigate to `MoceanAPI module` in dolibarr and specify your `API Token`, `Sender`(Your business name), `Default country` and `Active hour to send SMS reminder`.
You can find your `API Credentials` [here](https://dashboard.moceanapi.com/user/apisetting)
## Features
### Send SMS Notification
You can send SMS notifications based on specific events that occured in dolibarr.
For eg: `Send SMS when an invoice is validated`
#### Configuration
1. Navigate to **MoceanAPI** app via **Top Navigation**
2. Click on the module you'd like to configure. For eg: **Invoice** module
3. You can then configure the trigger for SMS notification. For eg: **Send SMS when Invoice is validated**
4. Once you're satisfied with all the configurations, you can click on **Save SMS Setting** at the bottom of the page
5. Test the SMS notification by Validating an Invoice.
6. SMS sent information will be available in the **SMS Outbox**
### Send Invoice Reminder
#### Reminder Prerequisite
##### Set PHP timezone in server
1. `SSH` into your server
2. Modify your `php.ini` file
`nano /etc/php/7.4/apache2/php.ini`
3. You may need to change the command based on the PHP version your server is using. For eg: if you're using `PHP Version 8.1` your command would be
`nano /etc/php/8.1/apache2/php.ini`
4. Look for **date.timezone** and set the timezone to your local timezone.
5. Save the file and restart your web server
##### Setup Cron Job
1. Navigate to **Setup > Modules / Application** in Dolibarr and enable the **Scheduled Jobs** module and click on the **gear icon**
2. Generate a security key to launch the cronjob using a script.
3. Copy the command generated by dolibarr and replace the values according to your dolibarr installation
4. Copy and paste the modified command into your cronjob entry in your server, in my case it would be
`*/5 * * * * /srv/dolibarr-16.0.0/scripts/cron/cron_run_jobs.php 715WIrfV14Blvdv4aQV26VMIrJwR4g2g admin > /srv/dolibarr-16.0.0/documents/cron_run_jobs.php.log`
**Note**: You may need to add `/path/to/php` infront of the script to run it successfully, the final code would be:
`*/5 * * * * /usr/bin/php /srv/dolibarr-16.0.0/scripts/cron/cron_run_jobs.php 715WIrfV14Blvdv4aQV26VMIrJwR4g2g admin > /srv/dolibarr-16.0.0/documents/cron_run_jobs.php.log`
5. Navigate to **Admin Tools > Scheduled Jobs**
6. If `Scheduled` is green color, your configuration is correct. If not, please recheck the steps above.
**Contact us if you require assistance**
#### Send Reminder Configuration
1. Navigate to `Invoice` module in `MoceanAPI` app.
2. Click on `Add Reminder`
3. Configure the reminder criteria (when you want to send the reminder). You can personalise your SMS message using `keywords`
4. Click on `Save` once you're satisfied with your configuration
5. Enable the SMS notification and click on `Save SMS Setting` at the bottom of the page.
### Voice Call
Before you can call, you need to set a **callback number**. This will usually be your number.
After you recipient have answered the call, we will forward the call to you and you'll be connected to the call.
1. Navigate to `Contact` of your choice
2. You should see a **Button** `MoceanAPI - Call`.
3. Click on it, and we'll connect the call to your recipient.
## FAQ
1. Can I get Test Credits ?
You can get 20 FREE credits and credits are valid for 14 days. Subject to approval.
2. Can I send international messages?
Yes. We are an international SMS provider. You can send out SMS both locally and internationally based on our price list.
3. What is the maximum characters per SMS I can put into the message?
160 characters for a normal text message, 70 characters for a Unicode text message (Arabic, Chinese, and etc)
4. Is there a limit to how many numbers I can send at one time?
There is no limit on numbers to be sent in one go.
5. What format does my phone number need to be in?
Mobile phone numbers need to be entered in international formatting with the country code and without spaces, plus signs or leading zeros.
6. I have multiple phone numbers in my contact, which one will be used to receive SMS ?
We will send SMS to the `mobile number` of your contact
**Did not find what you're looking for ?**
Do raise a support ticket with our Support Team at [support@moceanapi.com](mailto:support@moceanapi.com).
## Feature Request
Do raise a support ticket with our Support Team at [support@moceanapi.com](mailto:support@moceanapi.com).
## Feedback
Send feedback to our Support Team at [support@moceanapi.com](mailto:support@moceanapi.com).