Difference between revisions of "SMS Addon - provider api configuration"

From Kolmisoft Wiki
Jump to navigationJump to search
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This manual shows how to configure SMS sending through MOR with SMS Addon with Clickatell.  
This manual shows how to configure SMS sending through MOR with SMS Addon with Clickatell.  


Go Addons -> SMS -> Providers, create a name for your provider, choose tarrif and type: API, fill API string with providers url and authorization params and Good keywords.
Go to '''ADDONS''' block -> '''SMS''' -> '''Providers''' and select ''Provider Type'': ''API''. You will see this window:
 
<br><br>
Example : http://sms_providers_api_url?sms_login_user=username&password=userpassword&api_id=ID&to=<%= DST %>&sms_message=<%= MSG %>  
[[File:Sms apiprovider.png]]
<br><br>
''API string'' here: <code>http://41.204.94.20/vas/sendsms/sendsms.asp?UserName=username&Password=userpassword&api_id=ID&to=<%= DST %>&src=<%= CALLERID %>&text=<%= MSG %>&from_name=<%= USRLASTNAME %></code>


'''NOTE:''' Only '''GET''' method is supported.


Fill in the fields. Above is an example of correctly filled in fields.
<br><br>
== Variables ==
== Variables ==


Line 11: Line 16:
* DST - MOR will put destination number.
* DST - MOR will put destination number.
* MSG - MOR will put sms message.
* MSG - MOR will put sms message.
* USRFIRSTNAME - MOR will put user first name.
* USRLASTNAME - MOR will put user last name.
* CALLERID - MOR will put user primary device callerID.
* SRC - this variable <u>is only used if you use current MOR server as Provider</u>. Because when you send SMS from MOR API you use parameter '''src''' to set who is sender.


'''MOR  SMS variables mast be put in '<%= %>' string. Example : <%= DST %>'''
'''MOR  SMS variables must be put in '<%= %>' string. Example : <%= DST %>'''
 
<br><br>
== Good keywords  ==
== Good keywords  ==
 
<!---This functionality is available from MOR 12--->
We check SMS providers response for Good keywords. If we have found, sms will be charged.
We check SMS providers response for Good keywords. If we have found, sms will be charged.


If Good keywords are set and in providers response not found the keywords sms status set to :  
If Good keywords are set and in providers response not found the keywords sms status set to :  
* 6 - failed, api returns no good keywords.
* 6 - failed, api returns no good keywords.
Notice this feature available from MOR 12
<br><br>
==SMS over API for resellers==
<!---This functionality is available from MOR 12--->
Reseller can use send_sms API function with his own (not admin's) API key. Reseller can't send SMS over API if there is an incopatibility with hash and he has to be subscribed by admin for this functionality.
<br><br>

Latest revision as of 18:01, 1 March 2013

This manual shows how to configure SMS sending through MOR with SMS Addon with Clickatell.

Go to ADDONS block -> SMS -> Providers and select Provider Type: API. You will see this window:

Sms apiprovider.png

API string here: http://41.204.94.20/vas/sendsms/sendsms.asp?UserName=username&Password=userpassword&api_id=ID&to=<%= DST %>&src=<%= CALLERID %>&text=<%= MSG %>&from_name=<%= USRLASTNAME %>

NOTE: Only GET method is supported.

Fill in the fields. Above is an example of correctly filled in fields.

Variables

You can use variables :

  • DST - MOR will put destination number.
  • MSG - MOR will put sms message.
  • USRFIRSTNAME - MOR will put user first name.
  • USRLASTNAME - MOR will put user last name.
  • CALLERID - MOR will put user primary device callerID.
  • SRC - this variable is only used if you use current MOR server as Provider. Because when you send SMS from MOR API you use parameter src to set who is sender.

MOR SMS variables must be put in '<%= %>' string. Example : <%= DST %>

Good keywords

We check SMS providers response for Good keywords. If we have found, sms will be charged.

If Good keywords are set and in providers response not found the keywords sms status set to :

  • 6 - failed, api returns no good keywords.



SMS over API for resellers

Reseller can use send_sms API function with his own (not admin's) API key. Reseller can't send SMS over API if there is an incopatibility with hash and he has to be subscribed by admin for this functionality.

Retrieved from "https://wiki.kolmisoft.com/index.php?title=SMS_Addon_-_provider_api_configuration&oldid=14987"