Permalink
Browse files

cleanup CHANGELOG, update WEBSERVICE to show changes on successful ac…

…tions returns related to queue
  • Loading branch information...
1 parent d8eda78 commit b8618fa7acf1d6838a88ace6f4ba5c31899a44c0 @antonraharja committed Aug 12, 2012
Showing with 30 additions and 25 deletions.
  1. +1 −1 web/docs/CHANGELOG
  2. +29 −24 web/docs/WEBSERVICES
View
@@ -32,7 +32,7 @@ Version 0.9.7 - not released yet
- fix sql syntax "LIMIT count,offset" to "LIMIT count OFFSET offset" thx to f.hinlopen (anton)
- fix dba_insert_id() to work with pgsql thx to f.hinlopen (anton)
- fix NOW() in sql replace with $core_config['datetime']['now'] for compatibility (anton)
-- fix dba_insert_id(), add case option for mysqli, mysql and mysqli syntaxes (anton)
+- fix dba_insert_id(), add case option for mysqli in mysql block (anton)
Version 0.9.6 - 120328
- MAJOR: move SMS sender ID logic in sendsms() and it hooks to sendsms_get_sender() (anton)
View
@@ -1,10 +1,12 @@
WEBSERVICES ACCESS
------------------
+
URL: http://[playSMS_web_domain_or_url]/index.php?app=webservices
PARAMETERS
----------
+
u : username
p : password
@@ -30,24 +32,34 @@ slid : SMS Log ID (for ta=ds, when slid defined 'last' and 'c' has no effect)
ERROR RETURNS
-------------
-OK : action successfully executed and returns nothing
- this is only when "ta=bc"
-OK [SMS_LOG_ID] : action successfully executed and returns an SMS Log ID
-OK [NUMBER],[SMS_LOG_ID] : action successfully executed and returns destination number
- this is only when "ta=pv" and "to" contains multiple destinations
-OK [CREDIT] : action successfully executed and returns user's credit
-ERR 100 : authentication failed
-ERR 101 : type of action not valid
-ERR 102 : one or more field empty
-ERR 200 : send private failed
-ERR 201 : destination number or message is empty
-ERR 300 : send broadcast failed
-ERR 301 : destination group or message is empty
-ERR 400 : no delivery status retrieved
+
+Successful actions:
+
+OK : action successfully executed and returns nothing
+ this is only when "ta=bc"
+OK [SMS_LOG_ID],[QUEUE_CODE] : action successfully executed and returns an SMS Log ID
+ and Queue Code
+OK [NUMBER],[SMS_LOG_ID],[QUEUE_CODE] : action successfully executed and returns destination
+ number, it's SMS Log ID and it's Queue Code
+ this is only when "ta=pv" and "to" contains multiple
+ destinations
+OK [CREDIT] : action successfully executed and returns user's credit
+
+Unsuccessful actions:
+
+ERR 100 : authentication failed
+ERR 101 : type of action not valid
+ERR 102 : one or more field empty
+ERR 200 : send private failed
+ERR 201 : destination number or message is empty
+ERR 300 : send broadcast failed
+ERR 301 : destination group or message is empty
+ERR 400 : no delivery status retrieved
PROTOCOL
--------
+
1. Send SMS
ta : pv
parameters : u, p, to, msg, type, unicode
@@ -64,7 +76,8 @@ PROTOCOL
ta : ds
parameters : u, p, slid, c, last
returns : formatted text:
- SMS log ID; Source number; Destination Number; Message; Delivery Time; Update Pending Status Time; SMS Status
+ SMS log ID; Source number; Destination Number; Message; Delivery Time;
+ Update Pending Status Time; SMS Status
notes : slid retrieves only 1 delivery report at particular SMS log ID
c retrieves as many as c value
last retrieves from last SMS log ID
@@ -78,15 +91,7 @@ PROTOCOL
EXAMPLE
-------
-Example webservice URLs:
-
-http://playsms.org/trial/index.php?app=webservices&ta=pv&u=admin&p=rahasia&to=01234567890&msg=meeting+at+15.00+today!
-http://playsms.org/trial/index.php?app=webservices&ta=pv&u=admin&p=rahasia&to=01234567890,0134455667788&msg=meeting+today!
-http://playsms.org/trial/index.php?app=webservices&ta=bc&u=admin&p=rahasia&to=TI&msg=meeting+at+15.00+today!
-http://playsms.org/trial/index.php?app=webservices&ta=ds&u=admin&p=rahasia&c=100
-http://playsms.org/trial/index.php?app=webservices&ta=cr&u=admin&p=rahasia
-
-Another example, a webservice URL:
+Webservice URL:
http://x.com/index.php?app=webservices&ta=bc&u=admin&p=rahasia&to=TI&msg=meeting+at+15.00+today!
Explanation:

0 comments on commit b8618fa

Please sign in to comment.