home-assistant.io/source/_components/asterisk_mbox.markdown
PhracturedBlue 6ccf851546 Documentation for asterisk_mbox component (#2908)
* Add asterisk_mbox documentation

* Bad filename

* Capitalization error

* Update documentation based on changes to the mailbox implementation

* Typos as per review

* Remove mailbox sensor, since the functionality is included in the mailbox component.  Added ha_version to each file since the code has now been merged.
2017-08-08 13:27:04 +02:00

2.1 KiB

layout, title, description, date, sidebar, comments, sharing, footer, ha_category, ha_version, ha_iot_class
layout title description date sidebar comments sharing footer ha_category ha_version ha_iot_class
page Asterisk Voicemail Instructions how to integrate your existing Asterisk voicemail within Home Assistant. 2017-06-30 18:30 true false true true Other 0.51 Local Push

The Asterisk Voicemail integration for Home Assistant allows you to view, listen-to, and delete voicemails from a Asterisk voicemail mailbox. The component includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google's API) of messages in addition to playback and message deletion. There is also an included sensor that provides an indication of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine.

To enable the component, configuration is required in both Home Assistant as well as on the Asterisk server.

First follow the Asterisk PBX configuration guide to setup the necessary server on the Asterisk PBX server (this is necessary even if Asterisk and Home Assistant are running on the same server)

Once that is complete, add the the following entry configuration.yaml file:

# Example configuration.yaml entry
asterisk_mbox:
    password: ASTERISK_PBX_PASSWORD
    host: ASTERISK_PBX_SERVER_IP_ADDRESS
    port: ASTERISK_PBX_SERVER_PORT

This will add a new 'Mailbox' side-panel, as well as a sensor to indicate # of messages available.

Configuration variables:

  • password (Required): The password that was set during Asterisk PBX confguration
  • host (Required): The ip-address of the server that is running the Asterisk PBX
  • port (Required): The port on the Asterisk PBX server that was configured during Asterisk PBX confguration

Communication between the Asterisk PBX server and the Home Assistant server is password-protected, but the data transmission is not encrypted. It is recommended to only use this component when communication will be contained within a local area network.