README.rdoc in inteltech_sms-0.1.2 vs README.rdoc in inteltech_sms-0.1.3
- old
+ new
@@ -13,11 +13,11 @@
% gem install inteltech_sms
== Usage
-You will require an account with inteltech.com.au for the username and secret key. New accounts come with some free credits.
+You will require an account with http://inteltech.com.au for the username and secret key - They offer a free trial so you can try before buying.
Note: Inteltech's gateway assumes numbers not in international format (ie starting with a plus sign) are australian numbers.
Example ruby code:
@@ -48,10 +48,30 @@
res2 = gateway.send_multiple_sms([test_sms, test_sms2, landline_sms],'Test from Ruby to multiple numbers')
puts "send_multiple_sms (sending to mobiles should work, sending to a landline should fail):"
puts res2.collect {|r| "sms to #{r.sms} #{r.success? ? 'was successfull' : "failed (#{r.class} with code #{r.response_code})"}."}.join("\n")
+=== Optional arguments
+
+There are a few optional parameters that the gateway will accept.
+
+• senderid – 15 character custom sender ID which can be a mobile number or a alphanumeric string.
+e.g. send message from MYCOMPANY. (Additional cost of 0.5 credits/message applies).
+Do not use spaces. If left blank, a random mobile number will be used.
+
+• schedule – Allows you to schedule a message delivery. Must be in unix format. e.g. 1348742950 (Use Time.now.utc.to_i to get the current time)
+
+These are passed to the send_sms and send_multiple_sms methods via an optional hash argument:
+
+ # To schedule the sms in 12 minutes time ...
+
+ res = gateway.send_sms(test_sms,'Test from Ruby', :schedule => Time.now.utc.to_i + (12 * 60))
+
+ # To schedule the sms and supply a custom sender id
+
+ res2 = gateway.send_multiple_sms([test_sms, test_sms2, landline_sms],'Test from Ruby to multiple numbers', :senderid => 'MYCOMPANY', :schedule => 1348742950)
+
== Continuous integration tests
Travis CI testing result: {<img src="https://travis-ci.org/ianheggie/inteltech_sms.png" />}[https://travis-ci.org/ianheggie/inteltech_sms]
== Contributing to inteltech_sms
@@ -72,7 +92,8 @@
* Ian Heggie - Developer - Heggie Enterprises Pty Ltd - Contributed development of tests and packaging as gem
* Timelapse Pty Ltd (timelapse.com.au) - Paid for development of lib/inteltech_sms.rb and released code for public use
=== Other/Ongoing Contributors
-* Intelligent Technologies - Contributing an hour and 5% commission to development costs
+
+* Intelligent Technologies (inteltech.com.au) - Contributing an hour and 5% commission to development costs