Fax XML-RPC Schnittstelle

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

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

Über die Fax Schnittstelle haben sie die Möglichkeit Faxe an die infra-struktur zu übermitteln. Die Unterstützen Formate sind PDF und PNG. Um ein Fax in die infra-struktur einzutragen sind folgende Schritte nötig.

1. Eintragen des Faxes über die Funktion number_entry -> Rückgabewert ist die FaxID.
2. Einzelnes Eintragen der Faxseiten über die insert_FaxPage Funktion, hier ist die FaxID als Referenz anzugeben.
3. Setzen der Gesamtzahl der Faxseiten über die update_FaxPageCount Funktion, hier ist die FaxID als Referenz anzugeben.

• Funktionsübersicht

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

Trägt einen neuen Fax(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_FaxPage( $callID, $faxPage, $faxSource,$isdnkey )

Trägt eine neue Faxseite in die infra-sturktur ein

Parameter	Datentyp	Beschreibung
callid	String	Die ID des Fax (Rückgabewert der number_entry Funktion)
faxPage	String	Die Seitennummer der Faxdatei beginnend ab 1
faxSource	String	Der base64 Kodierte Quelltext der Faxdatei
isdnkey	String	Der in der infra-struktur konfigurierte ISDN-Key.
Rückgabewert
success	boolean

update_FaxPageCount( $callID, $faxPage, $faxSource,$isdnkey )

Aktualisiert die Anzahl der Faxseiten

Parameter	Datentyp	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.
Rückgabewert
success	boolean

Hauptkapitel

• XML-RPC Dokumentation

Verwandte Themen

• Anruf XML-RPC Schnittstelle
• Fax XML-RPC Schnittstelle
• Audio XML-RPC Schnittstelle