<title>Iro ·  api docs current</title>

				<li><a href="index.html" class="menu">Iro</a></li><li><a href="current.html" class="menu active">API Documentation</a></li><li><a href="database.html" class="menu">Datenbase Schema</a></li><li><a href="about.html" class="menu">About us</a></li>

				<h2>API Documentation</h2>

				<li value="1">1. <a href="#api-intro">Intro</a></li>

				<a href="#api-interfaces">Interfaces</a>

				<ol>

					<li value="2.1">2.1 <a href="#interface-xmlrpc">XML-RPC</a></li>

					<li value="2.1">2.2 <a href="#interface-soap">SOAP</a></li>

					<li value="2.3">2.3 <a href="#interface-json">JSON</a></li>

					<li value="2.4">2.4 <a href="#interface-jsonp">JSONP</a></li>

				</ol>

					<a href="#api-methods">Methods</a>

						<li value="3.1">3.1 <a href="#method-status">Status</a></li><li value="3.2">3.2 <a href="#method-sms">Sms</a></li><li value="3.3">3.3 <a href="#method-fax">Fax</a></li><li value="3.4">3.4 <a href="#method-mail">Mail</a></li><li value="3.5">3.5 <a href="#method-routes">Routes</a></li><li value="3.6">3.6 <a href="#method-defaultRoute">DefaultRoute</a></li><li value="3.7">3.7 <a href="#method-bill">Bill</a></li><li value="3.8">3.8 <a href="#method-telnumber">Telnumber</a></li><li value="3.9">3.9 <a href="#method-email">Email</a></li>

			<h3>Intro</h3>

				Iro API has many methods, that are usefull if you want to send a bunch of messages. This Site describes the API for Iro 1.0.

				You can use diffrent interfaces to get to same result.

					Interface-URI: <code>http://localhost:8000/xmlrpc</code>

				</p>

			</div>

			<div class="item" id="interface-soap">

				<h4>SOAP</h4>

				<p>

					Interface-URI: <code>http://localhost:8000/soap</code>

				</p>

			</div>

			<div class="item" id="interface-json">

				<h4>JSON</h4>

				<p>

					Interface-URI: <code>http://localhost:8000/json/<em>&lt;methode&gt;</em></code>

					Not yet implementet

				</p>

			</div>

			<div class="item" id="interface-jsonp">

				<h4>JSONP</h4>

				<p>

					Interface-URI: <code>http://localhost:8000/jsonp/<em>&lt;methode&gt;</em>?callback=&lt;callback&gt;</code>

				</p>

				<p>

					Not yet implementet

			<h3>Methods</h3>

			<div class="item" id="method-status">

				<h4>Status</h4>

				<p><code>status(user=None, id=False, detailed=None)</code></p>

				<p>Returns the status of one or more jobs.</p>

							<td>parameter</td>

							<td>type</td>

							<td>description</td>

						</tr>

					</thead>

					<tbody>

						<tr>

							<td>user</td>

							<td>string</td>

							<td>apikey of a user</td>

						</tr><tr>

							<td>id</td>

							<td>integer</td>

							<td>one job id</td>

						</tr><tr>

							<td>detailed</td>

							<td>boolean</td>

							<td>return more details about the status</td>

						</tr>

					</tbody>

				</table>

				<h5>Return</h5>

				<table class="docs">

					<thead>

						<tr>

							<td>parameter</td>

							<td>type</td>

							<td>description</td>

							<td>return</td>

							<td>dict</td>

							<td><ul class="simple">

<li><cite>key</cite> -- is the job id</li>

<li>[<cite>key</cite>][<strong>'status'</strong>] -- status of the job</li>

</ul></td>

			</div><div class="item" id="method-sms">

				<h4>Sms</h4>

				<p><code>sms(user, message, recipients, route='default', info='')</code></p>

				<p>Send a sms.</p>

				<h5>Parameter</h5>

							<td>parameter</td>

							<td>type</td>

							<td>description</td>

							<td>user</td>

							<td>string</td>

							<td>apikey of a user</td>

						</tr><tr>

							<td>message</td>

							<td>string</td>

							<td>message</td>

						</tr><tr>

							<td>recipients</td>

							<td>list</td>

							<td>a list of telefon numbers (use ITU-T E.123)</td>

						</tr><tr>

							<td>route</td>

							<td>string|list</td>

							<td>route to use to send, or a list of routes as fallback</td>

						</tr><tr>

							<td>info</td>

							<td>string</td>

							<td>a name, to combine different jobs to one billing group</td>

				<h5>Return</h5>

							<td>parameter</td>

							<td>type</td>

							<td>description</td>

							<td>return</td>

							<td>integer</td>

							<td>the job id</td>

			</div><div class="item" id="method-fax">

				<h4>Fax</h4>

				<p><code>fax(user, subject, fax, recipients, route='default', info='')</code></p>

				<p>Send a fax.</p>

				<h5>Parameter</h5>

							<td>parameter</td>

							<td>type</td>

							<td>description</td>

							<td>user</td>

							<td>string</td>

							<td>apikey of a user</td>

						</tr><tr>

							<td>subject</td>

							<td>string</td>

							<td>subject</td>

						</tr><tr>

							<td>fax</td>

							<td>string</td>

							<td>content (base64 encoded)</td>

						</tr><tr>

							<td>recipients</td>

							<td>list</td>

							<td>a list of telefon numbers (use ITU-T E.123)</td>

						</tr><tr>

							<td>route</td>

							<td>string|list</td>

							<td>route to use to send, or a list of routes as fallback</td>

						</tr><tr>

							<td>info</td>

							<td>string</td>

							<td>a name, to combine different jobs to one billing group</td>

				<h5>Return</h5>

				<table class="docs">

					<thead>

						<tr>

							<td>parameter</td>

							<td>type</td>

							<td>description</td>

						</tr>

					</thead>

					<tbody>

						<tr>

							<td>return</td>

							<td>integer</td>

							<td>the job id</td>

						</tr>

					</tbody>

				</table>

			</div><div class="item" id="method-mail">

				<h4>Mail</h4>

				<p><code>mail(user, subject, body, recipients, frm=None, route='default', info='')</code></p>

				<p>Send a mail.</p>

							<td>parameter</td>

							<td>type</td>

							<td>description</td>

							<td>user</td>

							<td>string</td>

							<td>apikey of a user</td>

						</tr><tr>

							<td>subject</td>

							<td>mail body</td>

							<td>a list of email addresses</td>

							<td>sender mail address</td>

							<td>route</td>

							<td>string|list</td>

							<td>route to use to send, or a list of routes as fallback</td>

						</tr><tr>

							<td>info</td>

							<td>a name, to combine different jobs to one billing group</td>

				<h5>Return</h5>

							<td>parameter</td>

							<td>type</td>

							<td>description</td>

							<td>return</td>

							<td>integer</td>

							<td>the job id</td>

			</div><div class="item" id="method-routes">

				<h4>Routes</h4>

				<p><code>routes(user, typ=None)</code></p>

				<p>Returns a list of all possible offernames.</p>

							<td>parameter</td>

							<td>type</td>

							<td>description</td>

							<td>user</td>

							<td>string</td>

							<td>apikey of a user</td>

							<td>typ</td>

							<td>string</td>

							<td>a typ of message -- one of in this list [&quot;sms&quot;,&quot;fax&quot;,&quot;mail&quot;]</td>

				<h5>Return</h5>

							<td>parameter</td>

							<td>type</td>

							<td>description</td>

						</tr>

					</thead>

					<tbody>

						<tr>

							<td>return</td>

							<td>list</td>

							<td>a list of all possible offer names for a typ</td>

						</tr>

					</tbody>

				</table>

			</div><div class="item" id="method-defaultRoute">

				<h4>DefaultRoute</h4>

				<p><code>defaultRoute(user, typ=None)</code></p>

				<p>Returns all default offernames.</p>

				<h5>Parameter</h5>

				<table class="docs">