API Dokumentation
--
--
-
- 1. Einführung -
- 2.
- Interfaces
-
-
-
- 2.1 XML-RPC -
- - 3.
- Methoden
-
-
-
- 3.1 StartSMS
- 3.2 StartFAX
- 3.3 StartMail
- 3.4 Status
- 3.5 Stop
- 3.6 GetProvider
- 3.7 GetDefaultProvider -
-
Einführung
-- Die Iro API enthält Funktion, die für den Massenversand nützlich sind. -
-Interfaces
-- Die Iro API stellt zur Zeit nur ein Interfaces bereit. -
-XML-RPC
-
- Interface-URI: https://<benutzer>:<passwort>@localhost:8000
-
- Die aufgerufene Methode wird dabei im <methodName /> übergeben.
-
Methoden
-StartSMS
-startSMS(message, recipients, provider='default')
Versendet eine SMS.
-Parameter
-| Parameter | -Typ | -Beschreibung | -
| message | -string | -Nachricht | -
| recipients | -list | -eine Liste von Emfänger-Nummern (gemäß ITU-T E.123) | -
| provider | -string | -Provider über den geschickt werden soll | -
Ausgabe
-| Parameter | -Typ | -Beschreibung | -
| id | -hash | -Die ID des Auftrages | -
StartFAX
-startFAX(subject, fax, recipients, provider='default')
Versendet ein FAX.
-Parameter
-| Parameter | -Typ | -Beschreibung | -
| subject | -string | -der Betreff | -
| fax | -string | -das pdf base64 kodiert | -
| recipients | -list | -eine Liste von Emfänger-Nummern (gemäß ITU-T E.123) | -
| provider | -string | -Provider über den geschickt werden soll | -
Ausgabe
-| Parameter | -Typ | -Beschreibung | -
| id | -hash | -Die ID des Auftrages | -
StartMail
-startMail(subject, body, recipients, frm, provider='default')
Versendet eine Email.
-Parameter
-| Parameter | -Typ | -Beschreibung | -
| subject | -string | -der Betreff | -
| body | -string | -der Email Body | -
| recipients | -list | -eine Liste von Emailadressen | -
| frm | -string | -Die Absender Emailadresse | -
| provider | -string | -Provider über den geschickt werden soll | -
Ausgabe
-| Parameter | -Typ | -Beschreibung | -
| id | -hash | -Die ID des Auftrages | -
Status
-status(id=None, detailed=False)
Gibt den aktuellen Status eines Auftrages zurück.
-Parameter
-| Parameter | -Typ | -Beschreibung | -
| 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(id)
Stoppt den angegeben Auftrag.
-Parameter
-| Parameter | -Typ | -Beschreibung | -
| id | -hash | -Eine Auftragsnummer | -
GetProvider
-getProvider(typ)
Gibt eine Liste aller verfügbaren Provider zurück.
-Parameter
-| Parameter | -Typ | -Beschreibung | -
| 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 | -
GetDefaultProvider
-getDefaultProvider(typ)
Gibt den Standardprovider zurück.
-Parameter
-| Parameter | -Typ | -Beschreibung | -
| 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 | -