From 4bc1027015c92bf067f54410f2110ae1f81c324e Mon Sep 17 00:00:00 2001 From: Jesse Young Date: Mon, 19 Sep 2011 00:41:25 -0700 Subject: [PATCH] reorganize server api reference --- .phrozn/entries/serverapi.twig | 14 ++++++++++++-- serverapi.html | 17 ++++++++++++++++- 2 files changed, 28 insertions(+), 3 deletions(-) diff --git a/.phrozn/entries/serverapi.twig b/.phrozn/entries/serverapi.twig index bab33a0..ed61bed 100755 --- a/.phrozn/entries/serverapi.twig +++ b/.phrozn/entries/serverapi.twig @@ -24,7 +24,7 @@ HTTP Request Format

Example requests

- In each of the example requests below, the Server URL is set as http://192.168.70.1:3000/sg/kalsms, + In each of the example requests below, the Server URL is http://192.168.70.1:3000/sg/kalsms and the phone number of the phone with KalSMS is 16505551212.

@@ -321,6 +321,16 @@ The Content-Type header should be text/xml, with the content as follows:

HTTP Response for action=send_status

+Example: +
+HTTP/1.1 200 OK
+Content-Type: text/plain
+Content-Length: 2
+
+OK
+
+

- The response content is currently undefined and ignored. + The response content for send_status requests is currently undefined and ignored. + HTTP status code 200 signifies success, and anything else signifies failure.

diff --git a/serverapi.html b/serverapi.html index 0ced57f..911fb79 100755 --- a/serverapi.html +++ b/serverapi.html @@ -55,6 +55,11 @@ HTTP Request Format

Example requests

+

+ In each of the example requests below, the Server URL is http://192.168.70.1:3000/sg/kalsms + and the phone number of the phone with KalSMS is 16505551212. +

+

An incoming SMS from 6505551234 with message body "test":

@@ -348,8 +353,18 @@ The Content-Type header should be text/xml, with the content as follows:
         
 

HTTP Response for action=send_status

+Example: +
+HTTP/1.1 200 OK
+Content-Type: text/plain
+Content-Length: 2
+
+OK
+
+

- The response content is currently undefined and ignored. + The response content for send_status requests is currently undefined and ignored. + HTTP status code 200 signifies success, and anything else signifies failure.