diff -r 665c3ea02d35 -r b218238e76b9 doc/current.html --- a/doc/current.html Fri Mar 30 16:39:12 2012 +0200 +++ b/doc/current.html Mon Apr 23 21:38:30 2012 +0200 @@ -3,7 +3,7 @@ - Iro · API docs + Iro · api docs current @@ -19,349 +19,501 @@
-

API Dokumentation

+

API Documentation

    -
  1. 1. Einführung
    2. +
  2. 1. Intro
  3. 2. - Interfaces -
      -
    1. 2.1 XML-RPC
      2. -
    + Interfaces +
      +
    1. 2.1 XML-RPC
      2. +
    2. 2.2 SOAP
      3. +
    3. 2.3 JSON
      4. +
    4. 2.4 JSONP
      5. +
  4. 3. - Methoden + Methods
      -
    1. 3.1 StartSMS
    2. 3.2 StartFAX
    3. 3.3 StartMail
    4. 3.4 Status
    5. 3.5 Stop
    6. 3.6 GetProvider
    7. 3.7 GetDefaultProvider
      8. +
    8. 3.1 Status
    9. 3.2 Sms
    10. 3.3 Fax
    11. 3.4 Mail
    12. 3.5 Routes
    13. 3.6 DefaultRoute
    14. 3.7 Bill
    15. 3.8 Telnumber
    16. 3.9 Email
-

Einführung

+

Intro

- Die Iro API enthält Funktion, die für den Massenversand nützlich sind. + 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.

Interfaces

- Die Iro API stellt zur Zeit nur ein Interfaces bereit. + You can use diffrent interfaces to get to same result.

XML-RPC

- Interface-URI: https://<benutzer>:<passwort>@localhost:8000 + Interface-URI: http://localhost:8000/xmlrpc +

+
+
+

SOAP

+

+ Interface-URI: http://localhost:8000/soap +

+
+
+

JSON

+

+ Interface-URI: http://localhost:8000/json/<methode>

- Die aufgerufene Methode wird dabei im <methodName /> übergeben. + Not yet implementet +

+
+
+

JSONP

+

+ Interface-URI: http://localhost:8000/jsonp/<methode>?callback=<callback> +

+

+ Not yet implementet

-

Methoden

-
-

StartSMS

-

startSMS(message, recipients, provider='default')

-

Versendet eine SMS.

+

Methods

+
+

Status

+

status(user=None, id=False, detailed=None)

+

Returns the status of one or more jobs.

Parameter
- - - + + + + + + + + + + + + + + + + + + + + +
ParameterTypBeschreibungparametertypedescription
userstringapikey of a user
idintegerone job id
detailedbooleanreturn more details about the status
+
Return
+ + + + + + - - - - - - - - - - - + + +
parametertypedescription
messagestring Nachricht
recipientslist eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
providerstring Provider über den geschickt werden sollreturndict
    +
  • key -- is the job id
    • +
  • [key]['status'] -- status of the job
    • +
-
Ausgabe
+
+

Sms

+

sms(user, message, recipients, route='default', info='')

+

Send a sms.

+
Parameter
- - - + + + - - - + + + + + + + + + + + + + + + + + + +
ParameterTypBeschreibungparametertypedescription
idhash Die ID des Auftragesuserstringapikey of a user
messagestringmessage
recipientslista list of telefon numbers (use ITU-T E.123)
routestring|listroute to use to send, or a list of routes as fallback
infostringa name, to combine different jobs to one billing group
-
-

StartFAX

-

startFAX(subject, fax, recipients, provider='default')

-

Versendet ein FAX.

-
Parameter
+
Return
- - - + + + - - - - - - - - - - - - - - - + + +
ParameterTypBeschreibungparametertypedescription
subjectstring der Betreff
faxstring das pdf base64 kodiert
recipientslist eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
providerstring Provider über den geschickt werden sollreturnintegerthe job id
-
Ausgabe
+
+

Fax

+

fax(user, subject, fax, recipients, route='default', info='')

+

Send a fax.

+
Parameter
- - - + + + - - - + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypBeschreibungparametertypedescription
idhash Die ID des Auftragesuserstringapikey of a user
subjectstringsubject
faxstringcontent (base64 encoded)
recipientslista list of telefon numbers (use ITU-T E.123)
routestring|listroute to use to send, or a list of routes as fallback
infostringa name, to combine different jobs to one billing group
-
-

StartMail

-

startMail(subject, body, recipients, frm, provider='default')

-

Versendet eine Email.

+
Return
+ + + + + + + + + + + + + + + +
parametertypedescription
returnintegerthe job id
+
+

Mail

+

mail(user, subject, body, recipients, frm=None, route='default', info='')

+

Send a mail.

Parameter
- - - + + + + + + + - + - + - + - + - + + + + + - +
ParameterTypBeschreibungparametertypedescription
userstringapikey of a user
subject string der Betreffsubject
body string der Email Bodymail body
recipients list eine Liste von Emailadressena list of email addresses
frm string Die Absender Emailadressesender mail address
providerroutestring|listroute to use to send, or a list of routes as fallback
info string Provider über den geschickt werden solla name, to combine different jobs to one billing group
-
Ausgabe
+
Return
- - - + + + - - - + + +
ParameterTypBeschreibungparametertypedescription
idhash Die ID des Auftragesreturnintegerthe job id
-
-

Status

-

status(id=None, detailed=False)

-

Gibt den aktuellen Status eines Auftrages zurück.

+
+

Routes

+

routes(user, typ=None)

+

Returns a list of all possible offernames.

Parameter
- - - + + + - - - + + + - - - + + +
ParameterTypBeschreibungparametertypedescription
idhash Eine Auftragsnummeruserstringapikey of a user
detailedboolean Details ausgebentypstringa typ of message -- one of in this list ["sms","fax","mail"]
-
Ausgabe
+
Return
- - - + + + + + + + + + + + + +
ParameterTypBeschreibungparametertypedescription
returnlista list of all possible offer names for a typ
+
+

DefaultRoute

+

defaultRoute(user, typ=None)

+

Returns all default offernames.

+
Parameter
+ + + + + + - - - - - + - + - + - +
parametertypedescription
jobslist Eine Liste der Aufträge.
job.nameuser string Angebener Nameapikey of a user
job.statustyp string Status des Auftragesa typ of message -- one of in this list ["sms","fax","mail"]
-
-

Stop

-

stop(id)

-

Stoppt den angegeben Auftrag.

+
Return
+ + + + + + + + + + + + + + + +
parametertypedescription
returnlista list of all possible offer names for a typ
+
+

Bill

+

bill(user=None)

+

Returns the bill, of not paid messages.

Parameter
- - - + + + - - - + + +
ParameterTypBeschreibungparametertypedescription
idhash Eine Auftragsnummeruserstringapikey of a user
-
-

GetProvider

-

getProvider(typ)

-

Gibt eine Liste aller verfügbaren Provider zurück.

-
Parameter
+
Return
- - - + + + - - - + + +
ParameterTypBeschreibungparametertypedescription
typstring Der Typ zu dem die Providerloste ausgeben werden soll -Einer der Liste ["sms","fax","mail"]returndict
    +
  • route -- one offer name ; "total" complete sum
    • +
  • [route][info][anz] -- Number of sended messages in one billing group
    • +
  • [route][info][price] -- Price for one billing group
    • +
  • [route | total][anz] -- Number of sended messages for one offer
    • +
  • [route | total][price] -- Price for one offer
    • +
-
Ausgabe
+
+

Telnumber

+

telnumber(recipients)

+

Return True, if all telnumbers a vaild.

+
Parameter
- - - + + + - + - +
ParameterTypBeschreibungparametertypedescription
providerlistrecipients list Eine Liste aller möglichen Providera list of telnumbers (use ITU-T E.123)
-
-

GetDefaultProvider

-

getDefaultProvider(typ)

-

Gibt den Standardprovider zurück.

-
Parameter
+
Return
- - - + + + - - - + + +
ParameterTypBeschreibungparametertypedescription
typstring Der Typ zu dem die Providerloste ausgeben werden soll -Einer der Liste ["sms","fax","mail"]returnbooleanTrue -- all numbers are valid
-
Ausgabe
+
+

Email

+

email(recipients)

+

Return True, if all mailadresses a valid.

+
Parameter
- - - + + + - - - + + + + + +
ParameterTypBeschreibungparametertypedescription
providerstring Der Standardprovider für den angeben Typrecipientslista list of mailadresses
+
Return
+ + + + + + + + + + + + +
parametertypedescription
returnbooleanTrue -- all addresses are valid