The FB_CALLMONITOR module connects to a AVM FritzBox Fon and listens for telephone
events (Receiving incoming call, Making a call)
In order to use this module with fhem you must enable the Callmonitor feature via
telephone shortcode.
#96*5* - for activating #96*4* - for deactivating
Just dial the shortcode for activating on one of your phones, after 3 seconds just hang up. The feature is now activated.
After activating the Callmonitor-Support in your FritzBox, this module is able to
generate an event for each external call. Internal calls were not be detected by the Callmonitor.
This module work with any FritzBox Fon model.
Define
define <name> FB_CALLMONITOR <ip-address>[:port]
port is 1012 by default.
Set
- rereadPhonebook - Reloads the FritzBox phonebook (from given file, via telnet or directly if available)
- password - set the FritzBox password (only available when password is really needed for network access to FritzBox phonebook, see attribute fritzbox-remote-phonebook)
Get
- search <phone-number> - returns the name of the given number via reverse-search (internal phonebook, cache or internet lookup)
Attributes
- do_not_notify
- readingFnAttributes
- disable
Optional attribute to disable the Callmonitor. When disabled, no phone events can be detected.
Possible values: 0 => Callmonitor is activated, 1 => Callmonitor is deactivated.
Default Value is 0 (activated)
- reverse-search (phonebook,klicktel.de,dasoertliche.de,search.ch,dasschnelle.at)
Enables the reverse searching of the external number (at dial and call receiving).
This attribute contains a comma separated list of providers which should be used to reverse search a name to a specific phone number. The phonebook (and cache) will always use first, afterwards all web providers.
It is possible to select a specific web service, which should be used for reverse searching.
per default, reverse search is disabled.
- reverse-search-cache
If this attribute is activated each reverse-search result is saved in an internal cache
and will be used instead of reverse searching every time the same number.
Possible values: 0 => off , 1 => on
Default Value is 0 (off)
- reverse-search-cache-file <file>
Write the internal reverse-search-cache to the given file and use it next time FHEM starts.
So all reverse search results are persistent written to disk and will be used instantly after FHEM starts.
- reverse-search-phonebook-file <file>
This attribute can be used to specify the (full) path to a phonebook file in FritzBox format (XML structure). Using this option it is possible to use the phonebook of a FritzBox even without FHEM running on a Fritzbox.
The phonebook file can be obtained by an export via FritzBox web UI
Default value is /var/flash/phonebook (phonebook filepath on FritzBox)
- remove-leading-zero
If this attribute is activated, a leading zero will be removed from the external number (e.g. in telefon systems).
Possible values: 0 => off , 1 => on
Default Value is 0 (off)
- unique-call-ids
If this attribute is activated, each call will use a biunique call id. So each call can be separated from previous calls in the past.
Possible values: 0 => off , 1 => on
Default Value is 0 (off)
- local-area-code
Use the given local area code for reverse search in case of a local call (e.g. 0228 for Bonn, Germany)
- fritzbox-remote-phonebook
If this attribute is activated, the phonebook should be obtained via telnet connection (in case FHEM is not running on a FritzBox). This is only possible if a password (and depending on configuration a username as well) is configured. To use this feature, telnet access has to be activated via telephone shortcode #96*7*.
Possible values: 0 => off , 1 => on (use remote telnet connection to obtain FritzBox phonebook)
Default Value is 0 (off)
- fritzbox-user
Use the given user for telnet connect. This attribute is only needed, if you use multiple users on your FritzBox.
Generated Events:
- event (call|ring|connect|disconnect) - which event in detail was triggerd
- direction (incoming|outgoing) - the call direction in general (incoming or outgoing call)
- external_number - The participants number which is calling (event: ring) or beeing called (event: call)
- external_name - The result of the reverse lookup of the external_number via internet. Is only available if reverse-search is activated. Special values are "unknown" (no search results found) and "timeout" (got timeout while search request). In case of an timeout and activated caching, the number will be searched again next time a call occurs with the same number
- internal_number - The internal number (fixed line, VoIP number, ...) on which the participant is calling (event: ring) or is used for calling (event: call)
- internal_connection - The internal connection (FON1, FON2, ISDN, DECT, ...) which is used to take or perform the call
- external_connection - The external connection (fixed line, VoIP account) which is used to take or perform the call
- call_duration - The call duration in seconds. Is only generated at a disconnect event. The value 0 means, the call was not taken by anybody.
- call_id - The call identification number to separate events of two or more different calls at the same time. This id number is equal for all events relating to one specific call.
- missed_call - This event will be raised in case of a missing incoming call. If available, also the name of the calling number will be displayed.
- missed_call_line - Will be raised together with "missed_call". It shows the number of the internal line which received the missed call.
=end html
=begin html_DE
FB_CALLMONITOR
Das Modul FB_CALLMONITOR verbindet sich zu einer AVM FritzBox Fon und verarbeitet
Telefonie-Ereignisse.(eingehende & ausgehende Telefonate)
Um dieses Modul nutzen zu können, muss der Callmonitor via Kurzwahl mit einem Telefon aktiviert werden.
.
#96*5* - Callmonitor aktivieren #96*4* - Callmonitor deaktivieren
Einfach die entsprechende Kurzwahl auf irgend einem Telefon eingeben, welches an die Fritz!Box angeschlossen ist.
Nach ca. 3 Sekunden kann man einfach wieder auflegen. Nun ist der Callmonitor aktiviert.
Sobald der Callmonitor auf der Fritz!Box aktiviert wurde erzeugt das Modul entsprechende Events (s.u.) für alle externen Anrufe. Interne Anrufe werden nicht durch den Callmonitor erfasst.
Dieses Modul funktioniert mit allen Fritz!Box Modellen, welche Telefonie unterstützen (Namenszusatz: Fon).
Definition
define <name> FB_CALLMONITOR <IP-Addresse>[:Port]
Port 1012 ist der Standardport und muss daher nicht explizit angegeben werden.
Set-Kommandos
- rereadPhonebook - Liest das Telefonbuch der FritzBox neu ein (per Datei, Telnet oder direkt lokal)
- password - speichert das FritzBox Passwort, welches für den Telnet-Zugang zur FritzBox benötigt wird. Dieses Kommando ist nur verfügbar, wenn ein Passwort benötigt wird um das Telefonbuch via Netzwerk einzulesen, siehe dazu Attribut fritzbox-remote-phonebook.
Get-Kommandos
- search <Rufnummer> - gibt den Namen der Telefonnummer zurück (aus Cache, Telefonbuch oder Rückwärtssuche)
Attribute
- do_not_notify
- readingFnAttributes
- disable
Optionales Attribut zur Deaktivierung des Callmonitors. Es können dann keine Anruf-Events mehr erkannt und erzeugt werden.
Mögliche Werte: 0 => Callmonitor ist aktiv, 1 => Callmonitor ist deaktiviert.
Standardwert ist 0 (aktiv)
- reverse-search (phonebook,klicktel.de,dasoertliche.de,search.ch,dasschnelle.at)
Aktiviert die Rückwärtssuche der externen Rufnummer (bei eingehenden/ausgehenden Anrufen).
Dieses Attribut enthält eine komma-separierte Liste mit allen Anbietern die für eine Rückwärtssuche benutzt werden sollen. Das interne Telefonbuch (phonebook) und der Cache (sofern aktiviert) wird dabei immer zuerst benutzt. Falls die Rufnummer dort nicht verzeichnet ist, werden externe Suchanbieter verwendet.
Es ist möglich einen bestimmten Suchanbieter zu verwenden, welcher für die Rückwärtssuche verwendet werden soll.
Der Wert "phonebook" verwendet ausschließlich das interne Telefonbuch der FritzBox (siehe Attribut reverse-search-phonebook-file)
Standardmäßig ist diese Funktion deaktiviert (nicht gesetzt)
- reverse-search-cache
Wenn dieses Attribut gesetzt ist, werden alle Ergebisse der Rückwärtssuche in einem modul-internen Cache gespeichert
und alle existierenden Ergebnisse aus dem Cache genutzt anstatt eine erneute Rückwärtssuche durchzuführen.
Mögliche Werte: 0 => deaktiviert , 1 => aktiviert
Standardwert ist 0 (deaktiviert)
- reverse-search-cache-file <Dateipfad>
Da der Cache nur im Arbeitsspeicher existiert, ist er nicht persistent und geht beim stoppen von FHEM verloren.
Mit diesem Parameter werden alle Cache-Ergebnisse in eine Textdatei geschrieben (z.B. /usr/share/fhem/telefonbuch.txt)
und beim nächsten Start von FHEM wieder in den Cache geladen und genutzt.
- reverse-search-phonebook-file <Dateipfad>
Mit diesem Attribut kann man optional den Pfad zu einer Datei angeben, welche ein Telefonbuch im FritzBox-Format (XML-Struktur) enthält.
Dadurch ist es möglich ein FritzBox-Telefonbuch zu verwenden, ohne das FHEM auf einer FritzBox laufen muss.
Sofern FHEM auf einer FritzBox läuft (und nichts abweichendes angegeben wurde), wird das interne File /var/flash/phonebook verwendet. Alternativ kann man das Telefonbuch in der FritzBox-Weboberfläche exportieren und dieses verwenden
Standardwert ist /var/flash/phonebook (entspricht dem Pfad auf einer FritzBox)
- remove-leading-zero
Wenn dieses Attribut aktiviert ist, wird die führende Null aus der externen Rufnummer (bei eingehenden & abgehenden Anrufen) entfernt. Dies ist z.B. notwendig bei Telefonanlagen.
Mögliche Werte: 0 => deaktiviert , 1 => aktiviert
Standardwert ist 0 (deaktiviert)
- unique-call-ids
Wenn dieses Attribut aktiviert ist, wird für jedes Gespräch eine eineindeutige Identifizierungsnummer verwendet. Dadurch lassen sich auch bereits beendete Gespräche voneinander unterscheiden. Dies ist z.B. notwendig bei der Verarbeitung der Events durch eine Datenbank.
Mögliche Werte: 0 => deaktiviert , 1 => aktiviert
Standardwert ist 0 (deaktiviert)
- local-area-code
Verwendet die gesetze Vorwahlnummer bei Rückwärtssuchen von Ortsgesprächen (z.B. 0228 für Bonn)
- fritzbox-remote-phonebook
Wenn dieses Attribut aktiviert ist, wird das FritzBox Telefonbuch via Telnet-Verbindung von der FritzBox gelesen. Dazu ist das FritzBox Passwort und je nach FritzBox Konfiguration auch ein Username notwendig, der in den entsprechenden Attributen konfiguriert sein muss.
- fritzbox-user
Der Username für das Telnet-Interface, sofern das Telefonbuch über Telnet geladen werden soll (Attribut: fritzbox-remote-phonebook). Dieses Attribut ist nur notwendig, wenn mehrere Benutzer auf der FritzBox konfiguriert sind.
Generierte Events:
- event (call|ring|connect|disconnect) - Welches Event wurde genau ausgelöst. ("call" => ausgehender Rufversuch, "ring" => eingehender Rufversuch, "connect" => Gespräch ist zustande gekommen, "disconnect" => es wurde aufgelegt)
- direction (incoming|outgoing) - Die Anruf-Richtung ("incoming" => eingehender Anruf, "outgoing" => ausgehender Anruf)
- external_number - Die Rufnummer des Gegenübers, welcher anruft (event: ring) oder angerufen wird (event: call)
- external_name - Das Ergebniss der Rückwärtssuche (sofern aktiviert). Im Fehlerfall kann diese Reading auch den Inhalt "unknown" (keinen Eintrag gefunden) oder "timeout" (Zeitüberschreitung bei der Abfrage) enthalten. Im Falle einer Zeitüberschreitung und aktiviertem Caching, wird die Rufnummer beim nächsten Mal erneut gesucht.
- internal_number - Die interne Rufnummer (Festnetz, VoIP-Nummer, ...) auf welcher man angerufen wird (event: ring) oder die man gerade nutzt um jemanden anzurufen (event: call)
- internal_connection - Der interne Anschluss an der Fritz!Box welcher genutzt wird um das Gespräch durchzuführen (FON1, FON2, ISDN, DECT, ...)
- external_connection - Der externe Anschluss welcher genutzt wird um das Gespräch durchzuführen (Festnetz, VoIP Nummer, ...)
- call_duration - Die Gesprächsdauer in Sekunden. Dieser Wert wird nur bei einem disconnect-Event erzeugt. Ist der Wert 0, so wurde das Gespräch von niemandem angenommen.
- call_id - Die Identifizierungsnummer eines einzelnen Gesprächs. Dient der Zuordnung bei zwei oder mehr parallelen Gesprächen, damit alle Events eindeutig einem Gespräch zugeordnet werden können
- missed_call - Dieses Event wird nur generiert, wenn ein eingehender Anruf nicht beantwortet wird. Sofern der Name dazu bekannt ist, wird dieser ebenfalls mit angezeigt.
- missed_call_line - Analog zu "missed_call" wird dieses Event nur generiert, wenn ein eingehender Anruf nicht beantwortet wird. Es zeigt die Rufnummer an über, den dieser unbeantwortete Anruf eingegangen ist.
=end html_DE
=cut
| |