home-assistant.io/source/_components/sensor.fritzbox_callmonitor.markdown

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_release	ha_iot_class
page	FRITZ!Box Call Monitor	Instructions on how to integrate a phone call monitor for AVM FRITZ!Box routers into Home Assistant.	2016-08-13 15:00	true	false	true	true	avm.png	System Monitor	0.27	Local Polling

The fritzbox_callmonitor sensor monitors the call monitor exposed by AVM Fritz!Box routers on TCP port 1012. It will assume the values idle, ringing, dialing, or talking with the phone numbers involved contained in the state attributes. It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes.

To activate the call monitor on your Fritz!Box, dial #96*5* from any phone connected to it.

To use the Fritz!Box call monitor in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: fritzbox_callmonitor

Configuration variables:

• host (Optional): The IP address of your router, eg. 192.168.1.1. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1.
• port (Optional): The TCP port of the call monitor. There is usually no reason to change this.
• username (Optional): Fritz!Box user's user name. This is required to use the phone book lookup feature. The user needs to have the "voice message, fax message, Fritz!App Fon and call list" permission.
• password (Optional): Fritz!Box user's user password. This is required to use the phone book lookup feature.
• phonebook (Optional): Numerical ID identifying the phonebook to be used. If there is just one phonebook, this is usually 0.
• prefixes (Optional): In case of a local call, the phone number seen by the router might differ from the one stored in the phone book by an area code, similarly for the international prefix. To remedy this, a list of prefixes, that can be appended to the phone number in case it is not found in the phone book, can be given.

{% linkable_title Examples %}

{% linkable_title Full configuration %}

The example below shows a full configuration for a call monitor with phone book support.

# Example configuration.yml entry
sensor:
  - platform: fritzbox_callmonitor
    name: Phone
    username: my_username
    password: my_password
    phonebook: 0
    prefixes:
      - '+49'
      - '+4989'
      - '089'

{% linkable_title Send notifications on state change %}

This example shows how to send notifications whenever the sensor's state changes. You will get notified both when you receive a call and also when a call is placed.

# Example configuration.yml entry.
automation:
  - alias: "Notify about phone state"
    trigger:
      - platform: state
        entity_id: sensor.phone
    action:
      - service: notify.notify
        data:
          title: "Phone"
          message: >-
            {% raw %}{% if is_state("sensor.phone", "idle") %}
              Phone is idle
            {% elif is_state("sensor.phone", "dialing") %}
              Calling {{ states.sensor.phone.attributes.to_name }} ({{ states.sensor.phone.attributes.to }})
            {% elif is_state("sensor.phone", "ringing") %}
              Incoming call from {{ states.sensor.phone.attributes.from_name }} ({{ states.sensor.phone.attributes.from }})
            {% else %}
              Talking to {{ states.sensor.phone.attributes.with_name }} ({{ states.sensor.phone.attributes.with }})
            {% endif %}{% endraw %}