Audio XML-RPC Schnittstelle: Unterschied zwischen den Versionen

Aus infra-struktur AdminWiki 2.10
Zur Navigation springenZur Suche springen
Die Seite wurde neu angelegt: „Die XML-RPC Schnittstelle der Anrufliste erreichen sie unter folgender Adresse. http://instanzname.infra-struktur.de/api/xmlrpc-server/calllistxmlrpc.php Über ...“
 
Simon (Diskussion | Beiträge)
Keine Bearbeitungszusammenfassung
 
(3 dazwischenliegende Versionen von einem anderen Benutzer werden nicht angezeigt)
Zeile 5: Zeile 5:
Über die Audio Schnittstelle haben sie die Möglichkeit Audio Files an die infra-struktur zu übermitteln.
Über die Audio Schnittstelle haben sie die Möglichkeit Audio Files an die infra-struktur zu übermitteln.


Um ein mp3 in die infra-struktur einzutragen sind folgende Schritte nötig.


1. Eintragen des Faxes über die Funktion number_entry  -> Rückgabewert ist die FaxID.<br>
[[Datei:Hinweis.png]] HINWEIS: Diese Funktion headert später in der infra-struktur über die Dateiendung, man kann also auch andere Formate als Audio benutzen!
2. Einzelnes Eintragen der Faxseiten über die insert_FaxPage Funktion, hier ist die FaxID als Referenz anzugeben.<br>
 
3. Setzen der Gesamtzahl der Faxseiten über die update_FaxPageCount Funktion, hier ist die FaxID als Referenz anzugeben.<br>
 
Um ein z. B. mp3 in die infra-struktur einzutragen sind folgende Schritte nötig.
 
1. Eintragen des Anrufs über die Funktion number_entry  -> Rückgabewert ist die callID.<br>
2. Einzelnes Eintragen der Dateien über die insert_File Funktion, hier ist die callID als Referenz anzugeben.<br>




Zeile 16: Zeile 19:
''<u>number_entry( $msn, $cidnum, $serverLocation,$isdnkey,$lastCallTime=null )</u>''
''<u>number_entry( $msn, $cidnum, $serverLocation,$isdnkey,$lastCallTime=null )</u>''
   
   
Trägt einen neuen Fax(anruf) in die infra-sturktur ein
Trägt einen neuen Anruf in die infra-sturktur ein


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 29: Zeile 32:
| serverLocation    || String ||| Ein in der infra-struktur konfigurierter Standort (siehe. [[Anruflisten_-_MSN]] )
| serverLocation    || String ||| Ein in der infra-struktur konfigurierter Standort (siehe. [[Anruflisten_-_MSN]] )
|-
|-
| isdnkey    || String ||| Der in der infra-struktur konfigurierte ISDN-Key (siehe. [[ISDN-Key]] )
| isdnkey    || String ||| Der in der infra-struktur konfigurierte [[Allgemeinverwaltung|ISDN-Key]]
|-
|-
| lastCallTime    || String ||| dieser Parameter ist optional. Über diesen Parameter hat man die Möglichkeit einen Anrufzeitpunkt
| lastCallTime    || String ||| dieser Parameter ist optional. Über diesen Parameter hat man die Möglichkeit einen Anrufzeitpunkt
Zeile 41: Zeile 44:




''<u>insert_FaxPage( $callID, $faxPage, $faxSource,$isdnkey )</u>''
''<u>insert_File( $callID,$Source,$fileType,$isdnkey )</u>''
   
   
Trägt eine neue Faxseite in die infra-sturktur ein
Trägt eine neue Datei in die infra-sturktur Anrufliste ein


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 50: Zeile 53:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| callid    ||String ||| Die ID des Fax (Rückgabewert der number_entry Funktion)
| callid    ||String ||| Die ID de (Rückgabewert der number_entry Funktion)
|-
|-
| faxPage     || String ||| Die Seitennummer der Faxdatei beginnend ab 1
| Source     || Binary ||| Der base64 Kodierte Quelltext der Datei
|-
|-
| faxSource     || String ||| Der base64 Kodierte Quelltext der Faxdatei
| fileType     || String ||| dreistellige Dateiendung mit der die Datei geheadert werden soll
|-
|-
| isdnkey    || String ||| Der in der infra-struktur konfigurierte ISDN-Key (siehe. [[ISDN-Key]] )
| isdnkey    || String ||| Der in der infra-struktur konfigurierte [[Allgemeinverwaltung|ISDN-Key]]
|-
|-
|-
|-
Zeile 64: Zeile 67:
|}
|}


== Hauptkapitel ==
* [[XML-RPC Dokumentation]]


 
== Verwandte Themen ==
 
* [[Anruf XML-RPC Schnittstelle]]
 
* [[Fax XML-RPC Schnittstelle]]
''<u>update_FaxPageCount( $callID, $faxPage, $faxSource,$isdnkey )</u>''
* [[Audio XML-RPC Schnittstelle]]
Aktualisiert die Anzahl der Faxseiten
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| callid    ||String ||| Die ID des Fax (Rückgabewert der number_entry Funktion)
|-
| faxPages    || String ||| Die Gesamtzahl der Faxseiten
|-
| isdnkey    || String ||| Der in der infra-struktur konfigurierte ISDN-Key (siehe. [[ISDN-Key]] )
|-
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| success    || boolean |||
|}

Aktuelle Version vom 17. Juni 2015, 14:53 Uhr

Die XML-RPC Schnittstelle der Anrufliste erreichen sie unter folgender Adresse.

http://instanzname.infra-struktur.de/api/xmlrpc-server/calllistxmlrpc.php

Über die Audio Schnittstelle haben sie die Möglichkeit Audio Files an die infra-struktur zu übermitteln.


HINWEIS: Diese Funktion headert später in der infra-struktur über die Dateiendung, man kann also auch andere Formate als Audio benutzen!


Um ein z. B. mp3 in die infra-struktur einzutragen sind folgende Schritte nötig.

1. Eintragen des Anrufs über die Funktion number_entry -> Rückgabewert ist die callID.
2. Einzelnes Eintragen der Dateien über die insert_File Funktion, hier ist die callID als Referenz anzugeben.


  • Funktionsübersicht

number_entry( $msn, $cidnum, $serverLocation,$isdnkey,$lastCallTime=null )

Trägt einen neuen Anruf in die infra-sturktur ein

Parameter Datentyp Beschreibung
msn String Die Kennung der Leitung auf die der Anruf signalisiert wurde
cidnum String Die vollständige Rufnummer des Anrufers
serverLocation String Ein in der infra-struktur konfigurierter Standort (siehe. Anruflisten_-_MSN )
isdnkey String Der in der infra-struktur konfigurierte ISDN-Key
lastCallTime String dieser Parameter ist optional. Über diesen Parameter hat man die Möglichkeit einen Anrufzeitpunkt

anzugeben, wird er nicht mit übermittelt wird die Serverzeit genutzt. Der Parameter muss sofern er angegeben wir nach folgender Sntax zusammengesetzt ein Y-m-d|H:i:s

Rückgabewert
callID String die ID des eingetragenen Anrufs


insert_File( $callID,$Source,$fileType,$isdnkey )

Trägt eine neue Datei in die infra-sturktur Anrufliste ein

Parameter Datentyp Beschreibung
callid String Die ID de (Rückgabewert der number_entry Funktion)
Source Binary Der base64 Kodierte Quelltext der Datei
fileType String dreistellige Dateiendung mit der die Datei geheadert werden soll
isdnkey String Der in der infra-struktur konfigurierte ISDN-Key
Rückgabewert
success boolean

Hauptkapitel

Verwandte Themen