29,131
edits
Changes
Module OVH (SMS, ClickToDial, ...) (view source)
Revision as of 17:33, 25 November 2024
, 6 months ago→SMS setup
Line 1:
Line 1:
+*
−|minversion=3.4.0
===For module version 3.7.0 or less (use old OVH API soAPI)===
−Then go on Dolibarr, OVH module setup, tab "Common", and add your OVH account:
−<pre>
−* Nic handle
−* Mot de passe
−</pre>
−For field "URL of SOAP OVH service", type the value provided as example.
−<pre>
−* http://www.ovh.com/soapi/soapi-re-1.32.wsdl
−</pre>
−Once information are input, you can click onto "Test connexion" to check that Dolibarr can communicate with OVH server.
−[[File:warning.png]] Your Dolibarr server must be able to contact OVH server on port 1664.
−'''TroubleShooting'''
−* If your server is not allowed to reach HTTPS web site and you get a "timeout" or "connection refused" error, try with this URL
−<pre>
−* http://www.ovh.com/soapi/soapi-re-1.32.wsdl
−</pre>
−* Your Dolibarr sevrer may not be able to contact OVH server on port 1664. Check your firewall setup.
−===For module version 3.8.0 or more (use new OVH API REST v6)===
<pre>
</pre>
+
+
+
+
+
+
+
<!-- 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:Complementary modules]]
[[Category:OVH]]
[[Category:OVH]]
+[[Category:DoliCloud]]
{{TemplateDocDevEn}}
{{TemplateDocDevEn}}
{{TemplateDocUser}}
{{TemplateDocUser}}
Line 6:
Line 14:
{{TemplateModuleInfo
{{TemplateModuleInfo
|modulename=OVH
|modulename=OVH
−|editor=NLTechno
+|editor=DoliCloud
−|web=[http://www.nltechno.com www.nltechno.com]
+|web={{URLNLTechno}}
−|webbuy={{LinkToPluginDownloadDoliStore|keyword=}}
+|webbuy={{LinkToPluginDownloadDoliStore|keyword=ovh}}
|status=stable
|status=stable
|prerequisites=
|prerequisites=
* An OVH account.
* An OVH account.
−* To use Click2Dial, you also need an OVH SIP subscription and id provided by OVH
+* 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
−* Your Dolibarr server must be able to contact OVH server with port 1664.
+* Dolibarr 3.8+
−|note=
|note=
}}
}}
= Features =
= Features =
−Add features to link Dolibarr between [http://www.ovh.com OVH] web hosting services.
+Add features to link Dolibarr between [https://www.ovh.com OVH] web hosting services.
Current version allows to:
Current version allows to:
* Send SMS to a thirdparty or member
* Send SMS to a thirdparty or member
Line 34:
Line 40:
== Common setup ==
== Common setup ==
All services of this module use OVH API. So you must have an OVH (www.ovh.com) account.
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:
Go on Dolibarr, OVH module setup, tab "Authentication", and add the following keys:
−* Application name
* Application name
* Application key
* Application key
* Application secret
* Application secret
−To get those 3 values, you must go on page https://eu.api.ovh.com/createApp/
To get those 3 values, you must go on page https://eu.api.ovh.com/createApp/
Line 78:
Line 54:
== SMS setup ==
== SMS setup ==
−Sending of SMS need to buy SMS packages at OVH, so with your OVH account, select number of SMS to buy at OVH website. OVH commercial page for this is http://www.ovh.co.uk/sms_and_fax/
+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).
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>
== ClickToDial setup ==
== ClickToDial setup ==
Line 86:
Line 80:
* Note URL suggested
* Note URL suggested
* Go into setup of module ClickToDial (you must enable module) and paste URL provided, into field "Link by default".
* Go into setup of module ClickToDial (you must enable module) and paste URL provided, into field "Link by default".
−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/pass 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, ce couple login/pass that will be used will be same for everybody).
+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).
Note: to get the couple login/pass, go into documentation provided by OVH and available here: http://guides.ovh.com/TelFaqClick2Call
Note: to get the couple login/pass, go into documentation provided by OVH and available here: http://guides.ovh.com/TelFaqClick2Call
+
+<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 ==
== Import OVH invoices setup ==
Line 96:
Line 96:
== 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 ==
Line 101:
Line 105:
== Fetching invoices ==
== Fetching invoices ==
−Go into menu "Home - Modules tools - OVH invoices import". If this menu does not exists onto your instance, call URL page http://yourdolibarr/ovh/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.
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.