Anruf HTTP GET Schnittstelle
Zur XML-RPC Schnittstelle gibt es ab der Version 2.9.7.42 eine weitere Möglichkeit Anrufe in die infra-struktur Anrufliste zu schreiben und zwar ganz einfach über GET-Parameter, der Aufruf lautet:
https://<Instanz>-classic.infra-struktur.eu/anrufliste/newEntryRPC.php?isdnKey=12345&location=Standard&msn=0&number=02941272630
Folgende Parameter enthält der Aufruf:
- isdnKey -> wird in der Allgemeinverwaltung festgelegt
- location -> der Name des Standorts aus der Anruflisten - MSN
- msn -> die gewählte interne MSN
- number -> die ankommende Rufnummer
Als Datum und Uhr wird die Serverzeit genommen.
Mit diesem Aufruf lässt sich z.B. ganz einfach eine Anbindung über eine Standard Fritzbox realisieren. Man kann über Telnet auf eine Fritzbox und dort in einem Script den Aufruf eintragen und immer wenn ein Call auf die Fritzbox kommt, wird einfach ein
wget https://<Instanz>-classic.infra-struktur.eu/anrufliste/newEntryRPC.php?isdnKey=12345&location=Standard&msn=0&number=02941272630
gemacht und der Anruf ist eingetragen. Weitere Infos zur Fritzbox unter: [1]
Neue Version
Vorerst zum testen gibt es eine neue Version der Schnittstelle.
Hier die Beschreibung dazu.
Adresse: http://[instance]-classic.infra-struktur.[eu|com]/api/calllist/index.php
Übergabe per GET oder POST (GET hat Vorrang vor POST)
Folgende Werte müssen übergeben werden:
isdnKey - Der ISDN-Key.
location - Der Name eines in der Anrufliste konfigurierten Standortes.
msn - Der Name einer in der Anrufliste konfigurierten MSN.
number - Die Nummer des Anrufers.
Es sollte beachtet werden, das z.b. die Nummer „+492941247790“ zur Übergabe als Parameter codiert werden muss, damit das führende + auf dem Server passend ausgewertet werden kann. (http://de.wikipedia.org/wiki/URL-Encoding)
Folgende Werte können übergeben werden:
reason - Der base64 codierte Grund eines Anrufes.
fileSource - Der base64 codierte Inhalt einer Datei.
fileType - Der Typ einer Datei. Der Standardwert liegt auf „fax“.
mimeType - Der mimetype einer Datei. Der Standardwert liegt auf „application/download“.
timestamp - Ein Unixtimestamp mit der der Eintrag erzeugt werden soll. Der Standardwert liegt auf dem Zeitpunkt des Aufrufs.
Es können folgende Fehlerwerte auftreten:
1001 - MISSING_MANDATORY_REQUEST_PARAM_ISDNKEY
Meldung: „isdnKey“ request param is mandatory, provide it via GET or POST (if both are set, GET will be preferred)
1002 - MISSING_MANDATORY_REQUEST_PARAM_LOCATION
Meldung: „location“ request param is mandatory, provide it via GET or POST (if both are set, GET will be preferred)
1003 - MISSING_MANDATORY_REQUEST_PARAM_MSN
Meldung: „msn“ request param is mandatory, provide it via GET or POST (if both are set, GET will be preferred)
1004 - MISSING_MANDATORY_REQUEST_PARAM_NUMBER
Meldung: „number“ request param is mandatory, provide it via GET or POST (if both are set, GET will be preferred)
2001 - MISSING_MANDATORY_DATABASE_CONNECTION_PARAM_HOST
Meldung: „host“ database connection param is mandatory, please contact the support
2002 - MISSING_MANDATORY_DATABASE_CONNECTION_PARAM_USERNAME
Meldung: „username“ database connection param is mandatory, please contact the support
2003 - MISSING_MANDATORY_DATABASE_CONNECTION_PARAM_PASSWORD
Meldung: „password“ database connection param is mandatory, please contact the support
2004 - MISSING_MANDATORY_DATABASE_CONNECTION_PARAM_DATABASE
Meldung: „database“ database connection param is mandatory, please contact the support
3001 - DATABASE_CONNECTION_CREATE
Meldung: Connection Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
3101 - DATABASE_QUERY_ON_VALIDATE_ISDNKEY_IN_DB
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
3102 - DATABASE_QUERY_ON_GET_LOCATIONID_BY_LOCATIONNAME
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
Meldung: No results found while trying to get the location id by location name
3103 - DATABASE_QUERY_ON_GET_LOCATION_CONFIGURATION
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
Meldung: No results found while trying to get the location configuration
3104 - DATABASE_QUERY_ON_GET_INTERNATIONAL_PREFIX_ID_BY_INTERNATIONAL_PREFIX
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
Meldung: No results found while trying to get the internationalPrefixId
3105 - DATABASE_QUERY_ON_IS_MSN_A_FAX_MSN_FOR_MSN_AND_LOCATIONID
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
Meldung: No results found while checking if the msn is a fax msn
3106 - DATABASE_QUERY_ON_CHECK_SIGNAL_TOLERANCE
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
3107 - DATABASE_QUERY_ON_GET_LIST_ID_FOR_MSN_AND_LOCATION_ID
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
Meldung: No results found while trying to get the list id for msn and location id
3108 - DATABASE_QUERY_ON_GET_NUMBER_TO_NAME_ID_BY_NUMBER
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
3109 - DATABASE_QUERY_ON_GET_MSN_ID_BY_MSN_AND_LOCATION_ID
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
Meldung: No results found while trying to get the msn id by msn and location id
3110 - DATABASE_QUERY_ON_INSERT_ENTRY
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
3111 - DATABASE_QUERY_ON_CITY_NAME_BY_PREFIX_AND_INTERNATIONAL_PREFIX
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
3112 - DATABASE_QUERY_ON_FORMAT_NUMBER_WITH_LOCATION
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
3113 - DATABASE_QUERY_ON_INSERT_CALL_TO_CALLLIST
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
3114 - DATABASE_QUERY_ON_INSERT_FILE
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
3115 - DATABASE_QUERY_ON_SET_REASON
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
3116 - DATABASE_QUERY_ON_GET_COUNTRY_NAME_FOR_NATIONAL_PREFIX_ID
Meldung: Query Error (MySQLi: [MySQLi Fehlernummer]) [MySQLi Fehlermeldung]
4001 - API_INVALID_ISDNKEY
Meldung: the provided isdn key „[isdnKey]“ is not valid
4002 - API_NOT_VALIDATED
Meldung: you first need to validate your isdn key
4101 - API_MINIMUM_NUMBER_LENGTH
Meldung: the number „[number]“ is below the required minimum number length of [minimumNumberLength]
4102 - API_NUMBER_IS_HIDDEN_SIGNAL
Meldung: the number „[number]“ is the hidden signal „[hiddenSignal]“
4103 - API_CALL_IS_WITHIN_SIGNAL_TOLERANCE
Meldung: the call from the number „[number]“ is within the signal tolerance of [signalTolerance] seconds
4104 - API_NO_CALLLIST_FOUND
Meldung: no appropriate call list found for MSN „[msn]“ and location id [locationId]
