geplante API Dokumentation
--
- -Einführung
-- Die Iro API enthält Funktion, die für den Massenversand nützlich sind. -
-Interfaces
-- Die Iro API wird über verschiedene Interfaces bereit gestellt, die unterschiedlich angesprochen werden, aber das selbe tun. -
-XML-RPC
-
- Interface-URI: http://localhost:8000/xmlrpc
-
- Die aufgerufene Methode wird dabei im <methodName /> übergeben.
-
SOAP
-
- Interface-URI: http://localhost:8000/soap
-
- Die aufgerufene Methode wird dabei im <methodName /> übergeben.
-
XML
-
- Interface-URI: http://localhost:8000/xml/<methode>
-
- Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. -
-- Parameter können via HTTP per GET oder POST im Format application/x-www-form-urlencoded übergeben werden. -
-- Die Ausgabe erfolgt als XML Markup. -
-JSON
-
- Interface-URI: http://localhost:8000/json/<methode>
-
- Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. -
-- Parameter können via HTTP per GET oder POST im Format application/x-www-form-urlencoded oder JSON-Objekt übergeben werden. -
-- Die Ausgabe erfolgt als JSON-Objekt. -
-JSONP
-
- Interface-URI: http://localhost:8000/jsonp/<methode>?callback=<callback>
-
- Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. -
-- Der Name für die Callback-Methode wird als Parameter Callback übergeben. -
-- Parameter können via HTTP per GET im Format application/x-www-form-urlencoded übergeben werden. -
-- Die Ausgabe erfolgt als Javascript-Funktionsaufruf mit einem JSON-Objekt als Parameter. -
-Methoden
-Sms
-sms(apikey, message, recipients, route='default')
Versendet eine SMS.
-Parameter
-| Parameter | -Typ | -Beschreibung | -
| apikey | -string | -Der API Key | -
| message | -string | -Nachricht | -
| recipients | -list | -eine Liste von Emfänger-Nummern (gemäß ITU-T E.123) | -
| route | -string|list | -Route über den geschickt werden soll, -oder eine Liste von Routen, um Fallbacks anzugeben | -
Ausgabe
-| Parameter | -Typ | -Beschreibung | -
| id | -hash | -Die ID des Auftrages | -
Fax
-fax(apikey, subject, fax, recipients, route='default')
Versendet ein FAX.
-Parameter
-| Parameter | -Typ | -Beschreibung | -
| apikey | -string | -Der API Key | -
| subject | -string | -Der Betreff | -
| fax | -string | -Das PDF base64 kodiert | -
| recipients | -list | -Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123) | -
| route | -string|list | -Route über den geschickt werden soll, -oder eine Liste von Routen, um Fallbacks anzugeben | -
Ausgabe
-| Parameter | -Typ | -Beschreibung | -
| id | -hash | -Die ID des Auftrages | -
mail(apikey, subject, body, recipients, frm, route='default')
Versendet eine Email.
-Parameter
-| Parameter | -Typ | -Beschreibung | -
| apikey | -string | -Der API Key | -
| subject | -string | -Der Betreff | -
| body | -string | -Der Email Body | -
| recipients | -list | -Eine Liste von Emailadressen | -
| frm | -string | -Die Absender Emailadresse | -
| route | -string|list | -Route über den geschickt werden soll, -oder eine Liste von Routen, um Fallbacks anzugeben | -
Ausgabe
-| Parameter | -Typ | -Beschreibung | -
| id | -hash | -Die ID des Auftrages | -
Status
-status(apikey, id=None, detailed=False)
Gibt den aktuellen Status eines Auftrages zurück.
-Parameter
-| Parameter | -Typ | -Beschreibung | -
| apikey | -string | -Der API Key | -
| id | -hash | -Eine Auftragsnummer | -
| detailed | -boolean | -Details ausgeben | -
Ausgabe
-| Parameter | -Typ | -Beschreibung | -
| jobs | -list | -Eine Liste der Aufträge. | -
| job.name | -string | -Angebener Name | -
| job.status | -string | -Status des Auftrages | -
Stop
-stop(apikey, id)
Stoppt den angegeben Auftrag.
-Parameter
-| Parameter | -Typ | -Beschreibung | -
| apikey | -string | -Der API Key | -
| id | -hash | -Eine Auftragsnummer | -
Routes
-routes(apikey, typ)
Gibt eine Liste aller verfügbaren Provider zurück.
-Parameter
-| Parameter | -Typ | -Beschreibung | -
| apikey | -string | -Der API Key | -
| typ | -string | -Der Typ zu dem die Providerloste ausgeben werden soll -Einer der Liste ["sms","fax","mail"] | -
Ausgabe
-| Parameter | -Typ | -Beschreibung | -
| providerlist | -list | -Eine Liste aller möglichen Provider | -
DefaultRoute
-defaultRoute(apikey, typ)
Gibt den Standardprovider zurück.
-Parameter
-| Parameter | -Typ | -Beschreibung | -
| apikey | -string | -Der API Key | -
| typ | -string | -Der Typ zu dem die Providerloste ausgeben werden soll -Einer der Liste ["sms","fax","mail"] | -
Ausgabe
-| Parameter | -Typ | -Beschreibung | -
| provider | -string | -Der Standardprovider für den angeben Typ | -