Dolibarr ERP CRM Wiki

Changes

Module OVH (SMS, ClickToDial, ...) (view source)

Revision as of 17:33, 25 November 2024

5,477 bytes added ,  6 months ago
m
→‎SMS setup
Line 1: Line 1: −
[[Category:Complementary Modules]]
+
<!-- BEGIN origin interlang links -->
 +
<!-- You can edit this section but do NOT remove these comments
 +
    Links below will be automatically replicated on translated pages by PolyglotBot -->
 +
[[fr:Module_OVH_(SMS,_ClickToDial,_...)_FR]]
 +
<!-- END interlang links -->
 +
<seo metak="module sms, module ovh, send sms" />
 +
 
 +
[[Category:Complementary modules]]
 
[[Category:OVH]]
 
[[Category:OVH]]
 +
[[Category:DoliCloud]]
 
{{TemplateDocDevEn}}
 
{{TemplateDocDevEn}}
 
{{TemplateDocUser}}
 
{{TemplateDocUser}}
 
= Informations =
 
= Informations =
 
{{TemplateModuleInfo
 
{{TemplateModuleInfo
−
|editor=NLTechno ([http://www.nltechno.com www.nltechno.com])
+
|modulename=OVH
−
|web=http://www.dolistore.com/
+
|editor=DoliCloud
 +
|web={{URLNLTechno}}
 +
|webbuy={{LinkToPluginDownloadDoliStore|keyword=ovh}}
 
|status=stable
 
|status=stable
 
|prerequisites=
 
|prerequisites=
−
|minversion=3.1.0
+
* An OVH account.
 +
* To use Click2Dial, you also need an OVH SIP subscription (You need the plan "Enterpise", plan "Discover" is not supported) and its IDs provided by OVH
 +
* Dolibarr 3.8+
 
|note=
 
|note=
 
}}
 
}}
    
= Features =
 
= Features =
−
Ajoute des fonctionnalités d'interface avec les services de l'hébergeur [http://www.ovh.com OVH].
+
Add features to link Dolibarr between [https://www.ovh.com OVH] web hosting services.
 +
Current version allows to:
 +
* Send SMS to a thirdparty or member
 +
* Import your OVH invoices
 +
* Use the ClickToDial OVH system
    
= Installation =
 
= Installation =
−
{{InstallModuleFr}}
+
{{InstallModuleDoliStoreFr|keyword=ovh}}
    
= Setup =
 
= Setup =
−
{{ActivationModuleFr}}
+
{{ActivationModuleEn}}
 +
 
 +
== Common setup ==
 +
All services of this module use OVH API. So you must have an OVH (www.ovh.com) account.
 +
 
 +
Go on Dolibarr, OVH module setup, tab "Authentication", and add the following keys:
 +
 
 +
* Application name
 +
* Application key
 +
* Application secret
 +
 
 +
To get those 3 values, you must go on page  https://eu.api.ovh.com/createApp/
 +
 
 +
Click and save once the 3 values are entered.
 +
 
 +
A 4th field to fill will appear. To get value of this field, click on link '''Click here to login and get a new consumer key (You must choose UNLIMITED validity)'''. This will open an OVH authentication window. Enter your NICHandle and password and duration "UNLIMITED". When going back from this page, the 4th field will be defined.
 +
 
 +
== SMS setup ==
 +
Sending of SMS need to buy SMS packages at OVH, so with your OVH account, select quantity of SMS to buy at OVH website. Buying SMS credit and getting your API key to use the module is available into the area "Telecom" of your OVH manager (https://www.ovh.com). You must subscribe a quantity of SMS using the mode "Standard" (available by Web API). Do not subscripe SMS using the mode "SMPP".
 +
 
 +
'''Availability'''
 +
 
 +
According to OVH, this service should be available :
 +
 
 +
* To send SMS: in all countries in the world, as long as you can create an OVH account from your country. SMS sent will appears to the recipients as coming from an "alpha name", for example "My Company" (you setup this in your OVH account).
 +
* To receive an answer after sending a SMS: This is possible only if your OVH account is in Europe and you have an european phone number. The SMS must also be sent in same country than your phone number.
 +
 
 +
 
 +
'''Subscription'''
 +
 
 +
Once your credit of SMS has been payed, you must go on the OVH panel to define the "Sender label" that may appears to your recipient when you will send SMS. Creating a sender must be done from your OVH customer dashboard, menu '''Telecom - SMS - Your SMS account - Then tab Senders.'''
 +
 
 +
[[File: Warning.png]] Warning: This step requires a delay on the part of OVH to be validated. As long as the sender is not validated by OVH, sending SMS will not be possible. Validation is done once for each different "sender label" you want to use.
 +
 
 +
Once this is done, go into Dolibarr, setup of module OVH, "SMS" tab and add name of SMS group to use (groups created from your online OVH manager).
 +
 
 +
<div class="divforimgcentpercent">
 +
[[File:Screen shot sms setup.png]]
 +
</div>
   −
Ensuite, sur la page de configuration du module, ajouter les informations de votre compte OVH:
+
== ClickToDial setup ==
−
<pre>
+
To use ClickToDial, go on ClickToDial tab,
−
* Nic handle
+
* Note URL suggested
−
* Mot de passe
+
* Go into setup of module ClickToDial (you must enable module) and paste URL provided, into field "Link by default".
−
</pre>
+
You can copy URL as it is. If you do so, you must also go into the user card to fill the OVH SIP login (and eventually the password) into tab "ClickTodial" of user card. Or, you can also replace into the pasted URL, the field __LOGIN__ (and __PASS__) into URL with this value directly (in such case, this couple login/pass that will be used will be same for everybody).
−
Pour le champ "URL du service SOAP OVH", saisissez la valeur donnée en exemple.
  −
<pre>
  −
* https://www.ovh.com/soapi/soapi-re-1.26.wsdl
  −
</pre>
  −
Une fois ces informations saisies, vous pouvez cliquer sur "Tester la connexion" pour vérifier que Dolibarr communique bien avec le serveur OVH.
     −
- Pour l'envoi de SMS, sur l'onglet SMS, ajouter le nom du compte SMS à utiliser (créé sous votre manager OVH).
+
Note: to get the couple login/pass, go into documentation provided by OVH and available here: http://guides.ovh.com/TelFaqClick2Call
−
- Pour l'utilisation de ClickToDial, sur l'onglet ClickToDial, reprendre l'URL qui est indiqué et copier la dans la configuration du module ClickToDial qu'il vous faut activer.
+
 
 +
<div class="divforimgcentpercent">
 +
[[File:Screen shot click2dial.png]]
 +
</div>
 +
 
 +
[[File:Warning.png]] Check also your OVH phone service is setup has a SIP service and not as an Analogic service.
 +
 
 +
== Import OVH invoices setup ==
 +
Just select the supplier third party to have imported invoices linked to.
    
= Usage =
 
= Usage =
 
== SMS ==
 
== SMS ==
 
* Go into card of a Thirdparty, Contact or Member. A new tab is visible to send SMS.
 
* Go into card of a Thirdparty, Contact or Member. A new tab is visible to send SMS.
 +
 +
<div class="divforimgcentpercent">
 +
[[File:Screen shot sms.png]]
 +
</div>
    
== ClickToDial ==
 
== ClickToDial ==
−
* Si vous avez bien activer le module ClickToDial et recopié l'URL comme indiqué dans le chapitre ci-dessus, un picto doit être présent à côté de chaque numéro de téléphones. En cliquant dessus, la numérotation est déclenché et votre système de téléphonie OVH s'exécute.
+
* If the ClickToDial module (it's another module provided by default with all Dolibarr) was also activated, and URL provided by at previous chapter was filled into its setup page, a picto must be visible near to each phone number. Clicking on picto will launch phone numbering and launch your OVH phoning system.
    
== Fetching invoices ==
 
== Fetching invoices ==
−
See page [[Script importovhinvoice.php]]
+
Go into menu "Home - Modules tools - OVH invoices import". If this menu does not exists onto your instance, call URL page http://yourdolibarr/custom/ovh/importovhinvoice.php
 +
 
 +
You can the choose which invoice to import.
 +
 
 +
<div class="divforimgcentpercent">
 +
[[File:Screen shot invoiceimport.png]]
 +
</div>
    
= Development =
 
= Development =
 
{{TemplateModNLTechnoEn}}
 
{{TemplateModNLTechnoEn}}
 +
 +
=TroubleShooting=
 +
 +
If you are on debian or ubuntu and get this error
 +
<syntaxhighlight lang="bash">
 +
Error creating resource: [message] fopen(): SSL operation failed with code 1. OpenSSL Error messages: error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed [file]
 +
.../htdocs/ovh/includes/guzzlehttp/ringphp/src/Client/StreamHandler.php [line] 406 [message] fopen(): Failed to enable crypto [file]
 +
.../ovh/includes/guzzlehttp/ringphp/src/Client/StreamHandler.php [line] 406 [message] fopen(https://api.ovh.com/1.0/auth/credential): failed to open stream: operation failed [file]
 +
.../ovh/includes/guzzlehttp/ringphp/src/Client/StreamHandler.php [line] 406 [message] Undefined variable: http_response_header [file]
 +
.../ovh/includes/guzzlehttp/ringphp/src/Client/StreamHandler.php [line] 407
 +
</syntaxhighlight>
 +
 +
Check that package "ca-certificates" is installed.
 +
 +
== "Method Not Allowed" error on the /telephony API ==
 +
If, when using ClickToDial, you get the error
 +
<syntaxhighlight lang="bash">
 +
Error: Client error response [url] https://api.ovh.com/1.0/telephony/?%3F%3F%2Fline%2FSIPLineNumber%2Fclick2Call [status code] 405 [reason phrase] Method Not Allowed
 +
</syntaxhighlight>
 +
Check that your subscription is the Enterprise offer. OVH does not allow the use of ClickToDial with the Discovery offer.
 +
 +
== "Only SMPP endpoint allowed for this account" error ==
 +
If, when sending SMS messages you get the error:
 +
<syntaxhighlight lang="bash">
 +
Only SMPP endpoint allowed for this account.
 +
</syntaxhighlight>
 +
This means that you have purchased a batch of SMS from OVH by choosing the "SMPP" mode instead of the batch of SMS usable in "Standard" mode. You need to purchase another batch of SMS using the correct batch choice.
Retrieved from "https://wiki.dolibarr.org/index.php?title=Special:MobileDiff/24535...61948"