From 816245f0ac7238a38af8416a7fe8bd1fded9811a Mon Sep 17 00:00:00 2001
From: Jesse Young <youngj@telerivet.com>
Date: Thu, 15 Mar 2012 19:16:54 -0700
Subject: [PATCH] update website for version 2.0.5

---
 .phrozn/entries/history/index.twig   | 14 ++++++++
 .phrozn/entries/serverapi/index.twig | 52 ++++++++++++++++++++++-----
 community/index.html                 |  5 +--
 faq/index.html                       |  3 +-
 history/index.html                   | 15 +++++++-
 index.html                           |  2 +-
 serverapi/index.html                 | 53 +++++++++++++++++++++++-----
 test/index.html                      |  4 +--
 8 files changed, 120 insertions(+), 28 deletions(-)

diff --git a/.phrozn/entries/history/index.twig b/.phrozn/entries/history/index.twig
index 1182c57..469ac82 100755
--- a/.phrozn/entries/history/index.twig
+++ b/.phrozn/entries/history/index.twig
@@ -2,6 +2,20 @@ id: history
 title: History
 ---
 
+Verson 2.0.5 (2012/03/15)
+
+<ul>
+    <li>
+        Option to notify server of incoming calls (enabling users to access simple SMS services for free by calling and hanging up, then receiving a SMS reply)
+    </li>
+    <li>
+        Send additional information from phone to server, such as the phone's current network type, age (delay) of incoming messages, device manufacturer, model, and SDK version
+    </li>
+    <li>
+        Various bug fixes
+    </li>
+</ul>
+
 EnvayaSMS for Drupal (2012/03/04)
 
 <ul>
diff --git a/.phrozn/entries/serverapi/index.twig b/.phrozn/entries/serverapi/index.twig
index a23eadc..f0fa887 100755
--- a/.phrozn/entries/serverapi/index.twig
+++ b/.phrozn/entries/serverapi/index.twig
@@ -47,13 +47,13 @@ HTTP Request Format
 <pre>
 POST /sg/app HTTP/1.1
 X-Request-Signature: sAemG31uRllk/K9xck2WRNaF/WI=
-Content-Length: 120
+Content-Length: 140
 Content-Type: application/x-www-form-urlencoded
 Host: 192.168.70.1:3000
 Connection: Keep-Alive
 
 from=6505551234&message_type=sms&message=test&version=2&phone_number=16505551212
-&action=incoming&timestamp=1317506831000
+&action=incoming&amp;age=23&amp;network=WIFI&amp;timestamp=1317506831000
 </pre>
 
 <p>An incoming MMS message with an <code>image/jpeg</code> part and a <code>text/plain</code> part with message 'Test':</p>
@@ -216,6 +216,11 @@ The following parameters are sent in all POST requests from EnvayaSMS:
         the server may receive the same log message multiple times.
     </dd>
         
+    <dt>"network" ::= &lt;text&gt;</dt>
+    <dd>
+        The phone's current type of internet connectivity. Typically this is either "MOBILE" or "WIFI".
+    </dd>
+        
     <dt>"action" ::= "outgoing" | "incoming" | "send_status" | "device_status" | "test" </dt>
     <dd>
         The request action determines the purpose of the HTTP request:
@@ -310,6 +315,12 @@ Additional parameters sent in POST requests with <code>action=incoming</code>:
     <dd>
         The timestamp of the incoming message, in milliseconds since midnight, January 1, 1970 UTC.
     </dd>    
+    
+    <dt>"age" ::= &lt;long integer&gt;</dt>
+    <dd>
+        The length of time between when the incoming message was received by the phone, and when the message was transmitted to the server, in milliseconds.
+    </dd>    
+    
 </dl>
         
 Additional parameters sent in POST requests with <code>action=incoming</code> and <code>message_type=mms</code>:
@@ -368,7 +379,7 @@ Additional parameters sent in POST requests with <code>action=send_status</code>
         of an <a href='#sms'>sms</a> tag in a previous XML response from the server).
     </dd>
 
-    <dt>"status" ::= "queued" | "failed" | "sent"</dt>
+    <dt>"status" ::= "queued" | "failed" | "cancelled" | "sent"</dt>
     <dd>
         The current status of the outgoing message.
     </dd>
@@ -409,6 +420,12 @@ Additional parameters sent in POST requests with <code>action=device_status</cod
         <dd>
             The phone's battery level is now at least 20% (after dropping below 15%).
         </dd>                    
+        
+        <dt>"send_limit_exceeded":</dt>
+        <dd>
+            EnvayaSMS is delaying sending outgoing messages because the rate limit for sending messages has been exceeded. (Installing additional expansion packs may be needed.)
+        </dd>                    
+        
         </dl>
     </dd>
 </dl>
@@ -420,8 +437,9 @@ HTTP Response Format
      
 <p>     
 For a successful request, the server should return HTTP status code 200.
-If the signature check failed, the server should return status code 403.
-Other status codes may be used to signify errors.
+Failed requests should return HTTP status codes between 400 and 499 inclusive.
+Failed requests may optionally return an error message to display in the phone logs, as
+a text/xml response like <code>&lt;response&gt;&lt;error&gt;...&lt;/error&gt;&lt;/response&gt;</code>
 </p>
     
 <h4>HTTP response for action=incoming and action=outgoing</h4>
@@ -430,13 +448,15 @@ Example:
 <pre>
 HTTP/1.1 200 OK
 Content-Type: text/xml
-Content-Length: 189
+Content-Length: 212
 
 &lt;?xml version='1.0' encoding='UTF-8'?&gt;
+&lt;response&gt;
 &lt;messages&gt;
   &lt;sms id='1540' to='16505551213'&gt;This is a test&lt;/sms&gt;
   &lt;sms id='1541' to='16505551214'&gt;This is a another test message.&lt;/sms&gt;
 &lt;/messages&gt;
+&lt;/response&gt;
 </pre>
 
 Specification:
@@ -444,9 +464,24 @@ Specification:
 The <code>Content-Type</code> header should be <code>text/xml</code>, with the content as follows:
 </p>
 <dl>
-    <dt>&lt;messages&gt;</dt>
+    <dt>&lt;response&gt;</dt>
     <dd>
         The root XML element.
+        <br /><br />
+        Content: 
+        <dl>
+            <dt>&lt;messages&gt; (optional if request successful)</dt>
+            <dd>The SMS messages to send.</dd>
+        </dl>
+        <dl>
+            <dt>&lt;error&gt; (optional if request failed)</dt>
+            <dd>An error message.</dd>
+        </dl>
+    </dd> 
+    
+    <dt>&lt;messages&gt;</dt>
+    <dd>
+        A container for the messages to send. 
         <br />
         <br />
         Attributes:
@@ -515,6 +550,7 @@ OK
 </pre>
 
 <p>
-    The response content for <code>send_status</code> requests is currently undefined and ignored.
     HTTP status code 200 signifies success, and anything else signifies failure.
+    The response content for successful <code>send_status</code> requests is currently ignored, except that    
+    requests with HTTP code 400-499 may return an error message as text/xml.
 </p>
diff --git a/community/index.html b/community/index.html
index c20596d..243572e 100755
--- a/community/index.html
+++ b/community/index.html
@@ -41,8 +41,7 @@
     
     <h2>Community</h2>
   
-    
-<h4>Discussion Forum</h4>
+    <h4>Discussion Forum</h4>
 
 <p>
 For general discussion, questions, or feedback about EnvayaSMS, use the public forum at 
@@ -83,8 +82,6 @@ Facebook: <a href='http://facebook.com/envaya'>Envaya</a>
 <p>
 To contact the EnvayaSMS developers privately, email <a href='sms-developers@envaya.org'>sms-developers@envaya.org</a>.
 </p>
-
-
     
     <div class="footer">
       get the source code on GitHub : <a href="http://github.com/youngj/EnvayaSMS">youngj/EnvayaSMS</a>
diff --git a/faq/index.html b/faq/index.html
index 68a8d8e..37cd677 100755
--- a/faq/index.html
+++ b/faq/index.html
@@ -41,8 +41,7 @@
     
     <h2>Frequently Asked Questions</h2>
   
-    
-<ul class='faq_links'>
+    <ul class='faq_links'>
     <li>
         <a href='#q_alternative'>Why not use X as an SMS gateway instead of an Android app? (where X = Twilio, Tropo, Clickatell, FrontlineSMS, RapidSMS, Kannel, etc.)</a>
     </li>
diff --git a/history/index.html b/history/index.html
index 59828f8..670351e 100755
--- a/history/index.html
+++ b/history/index.html
@@ -41,7 +41,20 @@
     
     <h2>History</h2>
   
-    
+    Verson 2.0.5 (2012/03/15)
+
+<ul>
+    <li>
+        Option to notify server of incoming calls (enabling users to access simple SMS services for free by calling and hanging up, then receiving a SMS reply)
+    </li>
+    <li>
+        Send additional information from phone to server, such as the phone's current network type, age (delay) of incoming messages, device manufacturer, model, and SDK version
+    </li>
+    <li>
+        Various bug fixes
+    </li>
+</ul>
+
 EnvayaSMS for Drupal (2012/03/04)
 
 <ul>
diff --git a/index.html b/index.html
index d3fc0ed..334dec6 100755
--- a/index.html
+++ b/index.html
@@ -115,7 +115,7 @@ It works wherever the phone can receive SMS messages and access the Internet
     <br />
 <a href='/install/' class='button' style='margin-left:110px;'>
 Install EnvayaSMS Now
-</a>    
+</a>
     
     <div class="footer">
       get the source code on GitHub : <a href="http://github.com/youngj/EnvayaSMS">youngj/EnvayaSMS</a>
diff --git a/serverapi/index.html b/serverapi/index.html
index 049f019..08d8dd2 100755
--- a/serverapi/index.html
+++ b/serverapi/index.html
@@ -87,13 +87,13 @@ HTTP Request Format
 <pre>
 POST /sg/app HTTP/1.1
 X-Request-Signature: sAemG31uRllk/K9xck2WRNaF/WI=
-Content-Length: 120
+Content-Length: 140
 Content-Type: application/x-www-form-urlencoded
 Host: 192.168.70.1:3000
 Connection: Keep-Alive
 
 from=6505551234&message_type=sms&message=test&version=2&phone_number=16505551212
-&action=incoming&timestamp=1317506831000
+&action=incoming&amp;age=23&amp;network=WIFI&amp;timestamp=1317506831000
 </pre>
 
 <p>An incoming MMS message with an <code>image/jpeg</code> part and a <code>text/plain</code> part with message 'Test':</p>
@@ -256,6 +256,11 @@ The following parameters are sent in all POST requests from EnvayaSMS:
         the server may receive the same log message multiple times.
     </dd>
         
+    <dt>"network" ::= &lt;text&gt;</dt>
+    <dd>
+        The phone's current type of internet connectivity. Typically this is either "MOBILE" or "WIFI".
+    </dd>
+        
     <dt>"action" ::= "outgoing" | "incoming" | "send_status" | "device_status" | "test" </dt>
     <dd>
         The request action determines the purpose of the HTTP request:
@@ -350,6 +355,12 @@ Additional parameters sent in POST requests with <code>action=incoming</code>:
     <dd>
         The timestamp of the incoming message, in milliseconds since midnight, January 1, 1970 UTC.
     </dd>    
+    
+    <dt>"age" ::= &lt;long integer&gt;</dt>
+    <dd>
+        The length of time between when the incoming message was received by the phone, and when the message was transmitted to the server, in milliseconds.
+    </dd>    
+    
 </dl>
         
 Additional parameters sent in POST requests with <code>action=incoming</code> and <code>message_type=mms</code>:
@@ -408,7 +419,7 @@ Additional parameters sent in POST requests with <code>action=send_status</code>
         of an <a href='#sms'>sms</a> tag in a previous XML response from the server).
     </dd>
 
-    <dt>"status" ::= "queued" | "failed" | "sent"</dt>
+    <dt>"status" ::= "queued" | "failed" | "cancelled" | "sent"</dt>
     <dd>
         The current status of the outgoing message.
     </dd>
@@ -449,6 +460,12 @@ Additional parameters sent in POST requests with <code>action=device_status</cod
         <dd>
             The phone's battery level is now at least 20% (after dropping below 15%).
         </dd>                    
+        
+        <dt>"send_limit_exceeded":</dt>
+        <dd>
+            EnvayaSMS is delaying sending outgoing messages because the rate limit for sending messages has been exceeded. (Installing additional expansion packs may be needed.)
+        </dd>                    
+        
         </dl>
     </dd>
 </dl>
@@ -460,8 +477,9 @@ HTTP Response Format
      
 <p>     
 For a successful request, the server should return HTTP status code 200.
-If the signature check failed, the server should return status code 403.
-Other status codes may be used to signify errors.
+Failed requests should return HTTP status codes between 400 and 499 inclusive.
+Failed requests may optionally return an error message to display in the phone logs, as
+a text/xml response like <code>&lt;response&gt;&lt;error&gt;...&lt;/error&gt;&lt;/response&gt;</code>
 </p>
     
 <h4>HTTP response for action=incoming and action=outgoing</h4>
@@ -470,13 +488,15 @@ Example:
 <pre>
 HTTP/1.1 200 OK
 Content-Type: text/xml
-Content-Length: 189
+Content-Length: 212
 
 &lt;?xml version='1.0' encoding='UTF-8'?&gt;
+&lt;response&gt;
 &lt;messages&gt;
   &lt;sms id='1540' to='16505551213'&gt;This is a test&lt;/sms&gt;
   &lt;sms id='1541' to='16505551214'&gt;This is a another test message.&lt;/sms&gt;
 &lt;/messages&gt;
+&lt;/response&gt;
 </pre>
 
 Specification:
@@ -484,9 +504,24 @@ Specification:
 The <code>Content-Type</code> header should be <code>text/xml</code>, with the content as follows:
 </p>
 <dl>
-    <dt>&lt;messages&gt;</dt>
+    <dt>&lt;response&gt;</dt>
     <dd>
         The root XML element.
+        <br /><br />
+        Content: 
+        <dl>
+            <dt>&lt;messages&gt; (optional if request successful)</dt>
+            <dd>The SMS messages to send.</dd>
+        </dl>
+        <dl>
+            <dt>&lt;error&gt; (optional if request failed)</dt>
+            <dd>An error message.</dd>
+        </dl>
+    </dd> 
+    
+    <dt>&lt;messages&gt;</dt>
+    <dd>
+        A container for the messages to send. 
         <br />
         <br />
         Attributes:
@@ -555,10 +590,10 @@ OK
 </pre>
 
 <p>
-    The response content for <code>send_status</code> requests is currently undefined and ignored.
     HTTP status code 200 signifies success, and anything else signifies failure.
+    The response content for successful <code>send_status</code> requests is currently ignored, except that    
+    requests with HTTP code 400-499 may return an error message as text/xml.
 </p>
-
     
     <div class="footer">
       get the source code on GitHub : <a href="http://github.com/youngj/EnvayaSMS">youngj/EnvayaSMS</a>
diff --git a/test/index.html b/test/index.html
index bd49b76..419c35a 100755
--- a/test/index.html
+++ b/test/index.html
@@ -41,8 +41,7 @@
     
     <h2>Testing EnvayaSMS</h2>
   
-    
-<p>
+    <p>
 <img src='/media/avd.png' width='242' height='227' style='float:right;padding-left:10px;' />
 If you don't yet have an Android phone, you can test EnvayaSMS in an emulated phone on your computer. 
 </p>
@@ -99,7 +98,6 @@ The URL of the EnvayaSMS Request Simulator must be on the same domain as the Ser
 Of course, you can also test EnvayaSMS by connecting a real Android phone to your development web server.
 For more information, see the <a href='/faq/#q_tunnel'>FAQ</a>.
 </p>
-
     
     <div class="footer">
       get the source code on GitHub : <a href="http://github.com/youngj/EnvayaSMS">youngj/EnvayaSMS</a>