2011-09-19 03:45:09 +00:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset='utf-8'>
|
2011-09-24 03:42:11 +00:00
|
|
|
<meta http-equiv="cache-control" content="no-cache, must-revalidate" >
|
2011-09-23 22:18:36 +00:00
|
|
|
<title>EnvayaSMS: Server API Reference</title>
|
2011-09-24 03:42:11 +00:00
|
|
|
<link rel='stylesheet' type='text/css' href='/styles/site.css' />
|
2011-09-19 03:45:09 +00:00
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
2011-09-23 00:25:32 +00:00
|
|
|
<a href="http://github.com/youngj/EnvayaSMS"><img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" /></a>
|
2011-09-19 03:45:09 +00:00
|
|
|
|
|
|
|
|
<div id="container">
|
2011-09-23 22:18:36 +00:00
|
|
|
|
|
|
|
|
<a style='float:left' href="/"><img src='/media/icon.png' height='72' width='72' style='margin-right:10px' /></a>
|
|
|
|
|
<h1 style='padding-top:13px'><a href="/">EnvayaSMS</a>
|
2011-09-19 03:45:09 +00:00
|
|
|
|
|
|
|
|
<span class="small">
|
2011-09-23 00:25:32 +00:00
|
|
|
SMS gateway for Android
|
|
|
|
|
</span>
|
|
|
|
|
|
2011-09-19 03:45:09 +00:00
|
|
|
</h1>
|
|
|
|
|
|
2011-09-23 00:25:32 +00:00
|
|
|
<div class='menu' style='clear:both;padding-top:5px'>
|
2011-09-23 22:18:36 +00:00
|
|
|
<a href='/'>Home</a>
|
2011-09-19 03:45:09 +00:00
|
|
|
·
|
2011-09-23 22:18:36 +00:00
|
|
|
<a href='/install/'>Install</a>
|
2011-09-19 03:45:09 +00:00
|
|
|
·
|
2011-10-01 22:47:55 +00:00
|
|
|
<a href='/test/'>Test</a>
|
|
|
|
|
·
|
2011-09-23 22:18:36 +00:00
|
|
|
<a href='/how/'>How it Works</a>
|
2011-09-19 03:45:09 +00:00
|
|
|
·
|
2011-09-23 22:18:36 +00:00
|
|
|
<a class='active' href='/serverapi/'>API Reference</a>
|
2011-09-19 03:45:09 +00:00
|
|
|
·
|
2011-09-23 22:18:36 +00:00
|
|
|
<a href='/faq/'>FAQ</a>
|
2011-09-23 19:16:53 +00:00
|
|
|
·
|
2011-09-23 22:18:36 +00:00
|
|
|
<a href='/history/'>History</a>
|
2011-09-23 23:36:51 +00:00
|
|
|
·
|
|
|
|
|
<a href='/community/'>Community</a>
|
2011-09-19 03:45:09 +00:00
|
|
|
</div>
|
2011-09-23 22:18:36 +00:00
|
|
|
|
2011-09-19 03:45:09 +00:00
|
|
|
<h2>Server API Reference</h2>
|
2011-09-23 22:18:36 +00:00
|
|
|
|
|
|
|
|
<p>
|
2011-09-23 00:25:32 +00:00
|
|
|
EnvayaSMS communicates with the server via HTTP POST requests that expect an XML response.
|
2011-09-19 03:45:09 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
2011-09-23 00:25:32 +00:00
|
|
|
For convenience, EnvayaSMS includes <a href='https://github.com/youngj/EnvayaSMS/tree/master/server'>server libraries and example code</a>
|
2011-09-19 03:45:09 +00:00
|
|
|
for certain languages to simplify handling its POST requests and generating response XML.
|
|
|
|
|
</p>
|
|
|
|
|
|
2012-03-04 23:25:53 +00:00
|
|
|
<p>
|
|
|
|
|
Drupal users can also install the <a href='https://drupal.org/project/sms_envaya'>Drupal module</a> (developed by Mark Burdett / VozMob).
|
|
|
|
|
</p>
|
|
|
|
|
|
2011-09-19 03:45:09 +00:00
|
|
|
<p>
|
|
|
|
|
If a server library is not yet available for your programming language, you can still use
|
2011-09-23 00:25:32 +00:00
|
|
|
EnvayaSMS by implementing code in accordance with the API reference below.
|
|
|
|
|
We encourage you to contribute new libraries and example code back to the EnvayaSMS project!
|
2011-09-19 03:45:09 +00:00
|
|
|
</p>
|
|
|
|
|
|
2011-10-10 00:07:56 +00:00
|
|
|
<h3>Testing Your Implementation</h3>
|
|
|
|
|
<p>
|
|
|
|
|
The <a href='https://raw.github.com/youngj/EnvayaSMS/master/server/php/example/www/test.html'>EnvayaSMS Request Simulator</a>
|
|
|
|
|
is a standalone HTML file that allows you to simulate EnvayaSMS's HTTP requests entirely in your browser via JavaScript.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
Just copy the HTML file somewhere on your site, and open it in a web browser. The URL of the EnvayaSMS Request Simulator
|
|
|
|
|
must be on the same domain as the Server URL.
|
|
|
|
|
</p>
|
|
|
|
|
|
2011-09-19 03:45:09 +00:00
|
|
|
<h3>
|
|
|
|
|
HTTP Request Format
|
|
|
|
|
</h3>
|
|
|
|
|
|
2011-09-19 07:33:47 +00:00
|
|
|
<h4>Example requests</h4>
|
|
|
|
|
|
2011-09-19 07:41:25 +00:00
|
|
|
<p>
|
2011-09-23 05:19:03 +00:00
|
|
|
In each of the example requests below, the Server URL is <code style='white-space:nowrap'>http://192.168.70.1:3000/sg/app</code>
|
2011-09-23 00:25:32 +00:00
|
|
|
and the phone number of the phone with EnvayaSMS is <code>16505551212</code>.
|
2011-09-19 07:41:25 +00:00
|
|
|
</p>
|
|
|
|
|
|
2011-09-19 07:33:47 +00:00
|
|
|
<p>An incoming SMS from <code>6505551234</code> with message body "test":</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
2011-09-23 05:19:03 +00:00
|
|
|
POST /sg/app HTTP/1.1
|
2011-09-23 04:34:18 +00:00
|
|
|
X-Request-Signature: sAemG31uRllk/K9xck2WRNaF/WI=
|
2011-10-01 22:47:55 +00:00
|
|
|
Content-Length: 120
|
2011-09-19 07:33:47 +00:00
|
|
|
Content-Type: application/x-www-form-urlencoded
|
|
|
|
|
Host: 192.168.70.1:3000
|
|
|
|
|
Connection: Keep-Alive
|
|
|
|
|
|
2011-10-01 22:47:55 +00:00
|
|
|
from=6505551234&message_type=sms&message=test&version=2&phone_number=16505551212
|
|
|
|
|
&action=incoming×tamp=1317506831000
|
2011-09-19 07:33:47 +00:00
|
|
|
</pre>
|
|
|
|
|
|
2011-09-22 03:40:48 +00:00
|
|
|
<p>An incoming MMS message with an <code>image/jpeg</code> part and a <code>text/plain</code> part with message 'Test':</p>
|
2011-09-19 07:33:47 +00:00
|
|
|
|
2011-09-22 03:40:48 +00:00
|
|
|
<pre style='white-space:pre-wrap'>
|
2011-09-23 05:19:03 +00:00
|
|
|
POST /sg/app HTTP/1.1
|
2011-09-23 04:34:18 +00:00
|
|
|
X-Request-Signature: OgpiQet9guVhEp+0klrONR8qGNs=
|
2011-09-22 03:40:48 +00:00
|
|
|
Content-Length: 13087
|
2011-10-01 22:47:55 +00:00
|
|
|
Content-Type: multipart/form-data; boundary=i66xAht5IMn1Tfk7tL9DgY8ZHZxq0d0RG
|
2011-09-22 03:40:48 +00:00
|
|
|
Host: 192.168.70.1:3000
|
|
|
|
|
Connection: Keep-Alive
|
|
|
|
|
|
2011-10-01 22:47:55 +00:00
|
|
|
--i66xAht5IMn1Tfk7tL9DgY8ZHZxq0d0RG
|
2011-09-22 03:40:48 +00:00
|
|
|
Content-Disposition: form-data; name="from"
|
|
|
|
|
Content-Type: text/plain; charset=UTF-8
|
|
|
|
|
Content-Transfer-Encoding: 8bit
|
|
|
|
|
|
|
|
|
|
+16505551234
|
2011-10-01 22:47:55 +00:00
|
|
|
--i66xAht5IMn1Tfk7tL9DgY8ZHZxq0d0RG
|
|
|
|
|
Content-Disposition: form-data; name="timestamp"
|
|
|
|
|
Content-Type: text/plain; charset=UTF-8
|
|
|
|
|
Content-Transfer-Encoding: 8bit
|
|
|
|
|
|
|
|
|
|
1317506831000
|
|
|
|
|
--i66xAht5IMn1Tfk7tL9DgY8ZHZxq0d0RG
|
2011-09-22 03:40:48 +00:00
|
|
|
Content-Disposition: form-data; name="message"
|
|
|
|
|
Content-Type: text/plain; charset=UTF-8
|
|
|
|
|
Content-Transfer-Encoding: 8bit
|
|
|
|
|
|
|
|
|
|
Test
|
2011-10-01 22:47:55 +00:00
|
|
|
--i66xAht5IMn1Tfk7tL9DgY8ZHZxq0d0RG
|
2011-09-22 03:40:48 +00:00
|
|
|
Content-Disposition: form-data; name="message_type"
|
|
|
|
|
Content-Type: text/plain; charset=UTF-8
|
|
|
|
|
Content-Transfer-Encoding: 8bit
|
|
|
|
|
|
|
|
|
|
mms
|
2011-10-01 22:47:55 +00:00
|
|
|
--i66xAht5IMn1Tfk7tL9DgY8ZHZxq0d0RG
|
2011-09-22 03:40:48 +00:00
|
|
|
Content-Disposition: form-data; name="mms_parts"
|
|
|
|
|
Content-Type: text/plain; charset=UTF-8
|
|
|
|
|
Content-Transfer-Encoding: 8bit
|
|
|
|
|
|
2011-10-01 22:47:55 +00:00
|
|
|
[{"type":"application/smil","filename":"01smil","cid":"<0000>","name":"part0"},
|
|
|
|
|
{"type":"text/plain","filename":"Text01.txt","cid":"<569>","name":"part1"},
|
|
|
|
|
{"type":"image/jpeg","filename":"Image0001.jpg","cid":"<570>","name":"part2"}]
|
|
|
|
|
--i66xAht5IMn1Tfk7tL9DgY8ZHZxq0d0RG
|
2011-09-22 03:40:48 +00:00
|
|
|
Content-Disposition: form-data; name="version"
|
|
|
|
|
Content-Type: text/plain; charset=UTF-8
|
|
|
|
|
Content-Transfer-Encoding: 8bit
|
|
|
|
|
|
|
|
|
|
3
|
2011-10-01 22:47:55 +00:00
|
|
|
--i66xAht5IMn1Tfk7tL9DgY8ZHZxq0d0RG
|
2011-09-22 03:40:48 +00:00
|
|
|
Content-Disposition: form-data; name="phone_number"
|
|
|
|
|
Content-Type: text/plain; charset=UTF-8
|
|
|
|
|
Content-Transfer-Encoding: 8bit
|
|
|
|
|
|
|
|
|
|
16505551212
|
2011-10-01 22:47:55 +00:00
|
|
|
--i66xAht5IMn1Tfk7tL9DgY8ZHZxq0d0RG
|
2011-09-22 03:40:48 +00:00
|
|
|
Content-Disposition: form-data; name="action"
|
|
|
|
|
Content-Type: text/plain; charset=UTF-8
|
|
|
|
|
Content-Transfer-Encoding: 8bit
|
|
|
|
|
|
|
|
|
|
incoming
|
2011-10-01 22:47:55 +00:00
|
|
|
--i66xAht5IMn1Tfk7tL9DgY8ZHZxq0d0RG
|
2011-09-22 03:40:48 +00:00
|
|
|
Content-Disposition: form-data; name="part0"; filename="01smil"
|
|
|
|
|
Content-Type: application/smil; charset=UTF-8
|
|
|
|
|
Content-Transfer-Encoding: binary
|
|
|
|
|
|
|
|
|
|
<smil>
|
|
|
|
|
<head>
|
|
|
|
|
<layout>
|
|
|
|
|
<root-layout height="160" width="128"/>
|
|
|
|
|
<region fit="meet" height="70%" id="Image" left="0%" top="30%" width="100%"/>
|
|
|
|
|
<region fit="scroll" height="30%" id="Text" left="0%" top="0%" width="100%"/>
|
|
|
|
|
</layout>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<par dur="8000ms">
|
|
|
|
|
<text region="Text" src="cid:569"/>
|
|
|
|
|
<img region="Image" src="cid:570"/>
|
|
|
|
|
</par>
|
|
|
|
|
</body>
|
|
|
|
|
</smil>
|
|
|
|
|
|
2011-10-01 22:47:55 +00:00
|
|
|
--i66xAht5IMn1Tfk7tL9DgY8ZHZxq0d0RG
|
2011-09-22 03:40:48 +00:00
|
|
|
Content-Disposition: form-data; name="part1"; filename="Text01.txt"
|
|
|
|
|
Content-Type: text/plain; charset=UTF-8
|
|
|
|
|
Content-Transfer-Encoding: binary
|
|
|
|
|
|
|
|
|
|
Test
|
2011-10-01 22:47:55 +00:00
|
|
|
--i66xAht5IMn1Tfk7tL9DgY8ZHZxq0d0RG
|
2011-09-22 03:40:48 +00:00
|
|
|
Content-Disposition: form-data; name="part2"; filename="Image0001.jpg"
|
|
|
|
|
Content-Type: image/jpeg
|
|
|
|
|
Content-Transfer-Encoding: binary
|
|
|
|
|
|
|
|
|
|
<em>BINARY IMAGE DATA</em>
|
2011-10-01 22:47:55 +00:00
|
|
|
--i66xAht5IMn1Tfk7tL9DgY8ZHZxq0d0RG--
|
2011-09-19 07:33:47 +00:00
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p>Checking for outgoing SMS messages:</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
2011-09-23 05:19:03 +00:00
|
|
|
POST /sg/app HTTP/1.1
|
2011-09-23 04:34:18 +00:00
|
|
|
X-Request-Signature: 139CL71b7r1Zw/E2wcccWFviSlg=
|
2011-09-19 07:33:47 +00:00
|
|
|
Content-Length: 50
|
|
|
|
|
Content-Type: application/x-www-form-urlencoded
|
|
|
|
|
Host: 192.168.70.1:3000
|
|
|
|
|
Connection: Keep-Alive
|
|
|
|
|
|
|
|
|
|
action=outgoing&version=2&phone_number=16505551212
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p>Notifying the server of the status of a sent message:</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
2011-09-23 05:19:03 +00:00
|
|
|
POST /sg/app HTTP/1.1
|
2011-09-23 04:34:18 +00:00
|
|
|
X-Request-Signature: 6uJtI6+QqlVBbUsR4T0WsQomods=
|
2011-09-19 07:33:47 +00:00
|
|
|
Content-Length: 80
|
|
|
|
|
Content-Type: application/x-www-form-urlencoded
|
|
|
|
|
Host: 192.168.70.1:3000
|
|
|
|
|
Connection: Keep-Alive
|
|
|
|
|
|
|
|
|
|
id=1536&status=sent&error=&action=send_status&version=2&phone_number=16505551212
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<h4>Specification</h4>
|
|
|
|
|
|
2011-09-19 03:45:09 +00:00
|
|
|
<p>
|
2011-09-23 00:25:32 +00:00
|
|
|
The following parameters are sent in all POST requests from EnvayaSMS:
|
2011-09-19 03:45:09 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
<dt>"version" ::= <integer></dt>
|
|
|
|
|
<dd>
|
2011-09-23 00:25:32 +00:00
|
|
|
EnvayaSMS's version code. This is an integer that will be incremented whenever
|
|
|
|
|
a new version of EnvayaSMS is released. (It is not the same as the version name shown
|
2011-09-20 04:43:30 +00:00
|
|
|
on the Help screen.)
|
2011-09-19 03:45:09 +00:00
|
|
|
<br />
|
|
|
|
|
<br />
|
|
|
|
|
This allows the server to support phones running different API versions at the same time.
|
2011-09-23 00:25:32 +00:00
|
|
|
If a deployment has many phones running with EnvayaSMS, the server should update its code first,
|
|
|
|
|
then the phones can be upgraded to the new version of EnvayaSMS as convenient.
|
2011-09-19 03:45:09 +00:00
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt>"phone_number" ::= <text></dt>
|
|
|
|
|
<dd>
|
2011-09-23 00:25:32 +00:00
|
|
|
The phone number of the phone running EnvayaSMS, as entered under Menu > Settings.
|
2011-09-19 03:45:09 +00:00
|
|
|
<br /><br />
|
2011-09-23 00:25:32 +00:00
|
|
|
This allows the server to differentiate between EnvayaSMS clients if multiple phones
|
|
|
|
|
are running EnvayaSMS.
|
2011-09-19 03:45:09 +00:00
|
|
|
</dd>
|
|
|
|
|
|
2011-10-10 23:21:30 +00:00
|
|
|
<dt>"log" ::= <text></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Log messages printed to the EnvayaSMS console since the last successful HTTP request.
|
|
|
|
|
<br /><br />
|
|
|
|
|
You may wish to append this data to a log file to allow administrators
|
|
|
|
|
to see error details without needing physical access to the phone.
|
|
|
|
|
<br /><br />
|
|
|
|
|
EnvayaSMS does not guarantee that the server receives log messages in order. Occasionally,
|
|
|
|
|
the server may receive the same log message multiple times.
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt>"action" ::= "outgoing" | "incoming" | "send_status" | "device_status" | "test" </dt>
|
2011-09-19 03:45:09 +00:00
|
|
|
<dd>
|
|
|
|
|
The request action determines the purpose of the HTTP request:
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
<dt>"outgoing":</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Poll the server for outgoing messages
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt>"incoming":</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Forward an incoming SMS or MMS message to the server
|
|
|
|
|
</dd>
|
2011-09-27 22:47:02 +00:00
|
|
|
|
2011-09-19 03:45:09 +00:00
|
|
|
<dt>"send_status":</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Update the server on the status of sending an outgoing message
|
|
|
|
|
</dd>
|
2011-09-27 22:47:02 +00:00
|
|
|
|
2011-10-10 23:21:30 +00:00
|
|
|
<dt>"device_status":</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Notify the server of a change in the Android device's state.
|
|
|
|
|
</dd>
|
|
|
|
|
|
2011-09-27 22:47:02 +00:00
|
|
|
<dt>"test":</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Test the server connection.
|
|
|
|
|
</dd>
|
2011-10-10 23:21:30 +00:00
|
|
|
|
2011-09-27 22:47:02 +00:00
|
|
|
|
2011-09-19 03:45:09 +00:00
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
The other POST parameters sent depend on the request action.
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
2011-09-23 00:25:32 +00:00
|
|
|
The following HTTP Headers are sent in all POST requests from EnvayaSMS:
|
2011-09-19 03:45:09 +00:00
|
|
|
|
|
|
|
|
<dl>
|
2011-09-23 04:34:18 +00:00
|
|
|
<dt>"X-Request-Signature" ::= <text></dt>
|
2011-09-19 03:45:09 +00:00
|
|
|
<dd>
|
2011-09-20 04:43:30 +00:00
|
|
|
A signature of the request to verify the phone and the server share the same password.
|
|
|
|
|
(This doesn't protect against MITM snooping or replay attacks, so it is recommended to
|
|
|
|
|
use the <code>https://</code> protocol.)
|
2011-09-19 03:45:09 +00:00
|
|
|
<br />
|
|
|
|
|
<br />
|
|
|
|
|
The signature is calculated by the following algorithm:
|
|
|
|
|
|
|
|
|
|
<ol>
|
2011-09-20 04:43:30 +00:00
|
|
|
<li>Sort all POST parameters, not including file uploads,
|
|
|
|
|
by the name of the field (in the usual ASCII order).</li>
|
2011-09-19 03:45:09 +00:00
|
|
|
|
|
|
|
|
<li>Generate an input string by concatenating:
|
|
|
|
|
<ul>
|
|
|
|
|
<li>the server URL,</li>
|
2011-12-01 17:53:44 +00:00
|
|
|
<li>each of the sorted POST parameters, in the format name=value for each name/value pair,</li>
|
2011-09-19 03:45:09 +00:00
|
|
|
<li>the password,</li>
|
|
|
|
|
</ul>
|
|
|
|
|
with a comma in between each element, like so:
|
2011-09-19 04:42:01 +00:00
|
|
|
<br />
|
2011-12-01 17:53:44 +00:00
|
|
|
<code>"<serverURL>,<name1>=<value1>,<...>,<nameN>=<valueN>,<password>"</code>
|
2011-09-19 03:45:09 +00:00
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>Generate the SHA-1 hash of the input string in UTF-8</li>
|
|
|
|
|
|
|
|
|
|
<li>Encode the SHA-1 hash using Base64 with no line breaks.</li>
|
|
|
|
|
</ol>
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
2011-09-25 16:13:18 +00:00
|
|
|
Additional parameters sent in POST requests with <code>action=incoming</code>:
|
2011-09-19 03:45:09 +00:00
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
<dt>"from" ::= <text></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The phone number of the message sender.
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt>"message_type" ::= "sms" | "mms"</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Whether this message is an SMS or MMS.
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt>"message" ::= <text></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The message body of the SMS, or the content of the <code>text/plain</code> part of the MMS.
|
2011-09-24 06:19:41 +00:00
|
|
|
For multipart SMS messages, this field contains all parts concatenated and may be longer than 160 characters.
|
2011-09-19 03:45:09 +00:00
|
|
|
</dd>
|
2011-09-29 23:14:02 +00:00
|
|
|
|
|
|
|
|
<dt>"timestamp" ::= <long integer></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The timestamp of the incoming message, in milliseconds since midnight, January 1, 1970 UTC.
|
|
|
|
|
</dd>
|
2011-09-19 03:45:09 +00:00
|
|
|
</dl>
|
|
|
|
|
|
2011-09-25 16:13:18 +00:00
|
|
|
Additional parameters sent in POST requests with <code>action=incoming</code> and <code>message_type=mms</code>:
|
2011-09-19 03:45:09 +00:00
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
<dt>"mms_parts" ::= <json_array></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Metadata for each part of the MMS. Each item in the JSON array is an object
|
|
|
|
|
with the following keys and values:
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
<dt>"name" ::= <text></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The name of an additional form field where the content of the MMS part
|
|
|
|
|
is sent as an attached file.
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt>"cid" ::= <text></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The Content ID of the MMS part. This allows the server to resolve
|
|
|
|
|
references in the SMIL part of the MMS
|
|
|
|
|
(e.g. <code><img region="Image" src="cid:805"/></code>).
|
|
|
|
|
</dt>
|
|
|
|
|
|
|
|
|
|
<dt>"type" ::= "application/smil" | "text/plain" | "image/jpeg" | ...</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The Content Type of the MMS part.
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt>"filename" ::= <text></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The filename of the MMS part, as sent by the sender phone,
|
|
|
|
|
e.g. <code>"Image001.jpg"</code>.
|
|
|
|
|
</dt>
|
|
|
|
|
</dl>
|
|
|
|
|
|
2011-09-22 03:40:48 +00:00
|
|
|
In addition, the request contains form fields with the content of each MMS part,
|
|
|
|
|
with names as listed in the <code>mms_parts</code> field. Text parts are encoded in UTF-8.
|
2011-09-19 03:45:09 +00:00
|
|
|
</dt>
|
|
|
|
|
</dl>
|
|
|
|
|
|
2011-09-25 16:13:18 +00:00
|
|
|
Additional parameters sent in POST requests with <code>action=outgoing</code>:
|
2011-09-19 03:45:09 +00:00
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
<dt>
|
|
|
|
|
(None)
|
|
|
|
|
</dt>
|
|
|
|
|
</dl>
|
|
|
|
|
|
2011-09-25 16:13:18 +00:00
|
|
|
Additional parameters sent in POST requests with <code>action=send_status</code>:
|
2011-09-19 03:45:09 +00:00
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
<dt>"id" ::= <text></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The Server's ID for the outgoing message (from the <code>id</code> attribute
|
|
|
|
|
of an <a href='#sms'>sms</a> tag in a previous XML response from the server).
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt>"status" ::= "queued" | "failed" | "sent"</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The current status of the outgoing message.
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt>"error" ::= <text></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
A description of the reason for the error, if the message
|
|
|
|
|
failed to send; or, an empty string if the message
|
|
|
|
|
has been sent successfully.
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
2011-10-10 23:21:30 +00:00
|
|
|
Additional parameters sent in POST requests with <code>action=device_status</code>:
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
<dt>"status" ::= "power_connected" | "power_disconnected" <br />
|
|
|
|
|
| "battery_low" | "battery_okay"</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
This field describes a condition that has changed on the Android device.
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
<dt>"power_connected":</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The phone is now connected to external power.
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt>"power_disconnected":</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
This phone is no longer connected to external power.
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt>"battery_low":</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The phone's battery level has dropped below 15%.
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt>"battery_okay":</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The phone's battery level is now at least 20% (after dropping below 15%).
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
2011-09-19 03:45:09 +00:00
|
|
|
<h3>
|
|
|
|
|
HTTP Response Format
|
|
|
|
|
</h4>
|
|
|
|
|
|
|
|
|
|
<p>
|
2011-09-23 23:14:39 +00:00
|
|
|
For a successful request, the server should return HTTP status code 200.
|
2011-09-19 03:45:09 +00:00
|
|
|
If the signature check failed, the server should return status code 403.
|
|
|
|
|
Other status codes may be used to signify errors.
|
|
|
|
|
</p>
|
|
|
|
|
|
2011-09-19 07:33:47 +00:00
|
|
|
<h4>HTTP response for action=incoming and action=outgoing</h4>
|
2011-09-19 03:45:09 +00:00
|
|
|
|
2011-09-19 07:33:47 +00:00
|
|
|
Example:
|
|
|
|
|
<pre>
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: text/xml
|
|
|
|
|
Content-Length: 189
|
|
|
|
|
|
|
|
|
|
<?xml version='1.0' encoding='UTF-8'?>
|
|
|
|
|
<messages>
|
|
|
|
|
<sms id='1540' to='16505551213'>This is a test</sms>
|
|
|
|
|
<sms id='1541' to='16505551214'>This is a another test message.</sms>
|
|
|
|
|
</messages>
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
Specification:
|
|
|
|
|
<p>
|
2011-09-25 16:13:18 +00:00
|
|
|
The <code>Content-Type</code> header should be <code>text/xml</code>, with the content as follows:
|
2011-09-19 07:33:47 +00:00
|
|
|
</p>
|
2011-09-19 03:45:09 +00:00
|
|
|
<dl>
|
|
|
|
|
<dt><messages></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The root XML element.
|
|
|
|
|
<br />
|
|
|
|
|
<br />
|
|
|
|
|
Attributes:
|
|
|
|
|
<dl><dt>none</dt></dl>
|
2011-09-19 07:33:47 +00:00
|
|
|
<br />
|
2011-09-19 03:45:09 +00:00
|
|
|
Content:
|
|
|
|
|
<dl>
|
|
|
|
|
<dt><sms>*</dt>
|
|
|
|
|
<dd>The SMS messages to send.</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt id='sms'><sms></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Describes an outgoing SMS to send.
|
|
|
|
|
<br /><br />
|
|
|
|
|
Attributes:
|
|
|
|
|
<dl>
|
|
|
|
|
<dt>"id" ::= <text> (optional)</dt>
|
|
|
|
|
<dd>
|
2011-09-23 00:25:32 +00:00
|
|
|
An ID for this outgoing message. (EnvayaSMS will send this
|
2011-09-19 03:45:09 +00:00
|
|
|
back to the server as the id field in a send_status request.)
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>"to" ::= <text> (optional for incoming, required for outgoing)</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The phone number to send the SMS to. If omitted for
|
|
|
|
|
action=incoming, it will be sent as a reply to the original
|
|
|
|
|
sender.
|
|
|
|
|
</dd>
|
2011-09-28 21:50:35 +00:00
|
|
|
<dt>"priority" ::= <integer> (optional)</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The priority level of the outgoing message. If your server is sending outgoing messages
|
|
|
|
|
faster than the phone can send them out, the priority level allows you to specify
|
|
|
|
|
the order to send them (e.g. so that you can send transactional SMS replies
|
|
|
|
|
before asynchronous notifications).
|
|
|
|
|
<br />
|
|
|
|
|
<br />
|
|
|
|
|
Larger integers represent higher priorities.
|
|
|
|
|
If omitted, the default priority level is 0.
|
|
|
|
|
<br />
|
|
|
|
|
<br />
|
|
|
|
|
Within a priority level, SMS messages are processed and sent in the order
|
|
|
|
|
they were received from the server, and from top to bottom within the XML rsponse.
|
|
|
|
|
</dd>
|
2011-09-19 03:45:09 +00:00
|
|
|
</dl>
|
2011-09-19 07:33:47 +00:00
|
|
|
<br />
|
2011-09-19 03:45:09 +00:00
|
|
|
Content:
|
|
|
|
|
<dl>
|
|
|
|
|
<dt>CDATA</dt>
|
|
|
|
|
<dd>
|
2011-09-24 06:19:41 +00:00
|
|
|
The content of the SMS message to send. If the content is longer than the maximum size of a single SMS (typically 160 characters),
|
|
|
|
|
it will automatically be sent as a multipart SMS.
|
2011-09-19 03:45:09 +00:00
|
|
|
</dd>
|
2011-09-19 07:33:47 +00:00
|
|
|
</dl>
|
2011-09-19 03:45:09 +00:00
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
2011-09-19 07:33:47 +00:00
|
|
|
<h4>HTTP Response for action=send_status</h4>
|
2011-09-19 03:45:09 +00:00
|
|
|
|
2011-09-19 07:41:25 +00:00
|
|
|
Example:
|
|
|
|
|
<pre>
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: text/plain
|
|
|
|
|
Content-Length: 2
|
|
|
|
|
|
|
|
|
|
OK
|
|
|
|
|
</pre>
|
|
|
|
|
|
2011-09-19 07:33:47 +00:00
|
|
|
<p>
|
2011-09-19 07:41:25 +00:00
|
|
|
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.
|
2011-09-19 07:33:47 +00:00
|
|
|
</p>
|
2011-09-19 03:45:09 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="footer">
|
2011-09-23 00:25:32 +00:00
|
|
|
get the source code on GitHub : <a href="http://github.com/youngj/EnvayaSMS">youngj/EnvayaSMS</a>
|
2011-09-19 03:45:09 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
2011-09-22 06:10:31 +00:00
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
|
|
|
|
|
var _gaq = _gaq || [];
|
2011-09-23 00:29:40 +00:00
|
|
|
_gaq.push(['_setAccount', 'UA-25868450-2']);
|
2011-09-22 06:10:31 +00:00
|
|
|
_gaq.push(['_trackPageview']);
|
|
|
|
|
|
|
|
|
|
(function() {
|
|
|
|
|
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
|
|
|
|
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
|
|
|
|
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
|
|
|
|
})();
|
|
|
|
|
|
|
|
|
|
</script>
|
2011-09-19 03:45:09 +00:00
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
