240 lines
11 KiB
HTML
240 lines
11 KiB
HTML
<!doctype html>
|
||
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
||
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
||
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
<title>Asterisk Voicemail - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate your existing Asterisk voicemail within Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/asterisk_mbox/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Asterisk Voicemail">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/asterisk_mbox/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate your existing Asterisk voicemail within Home Assistant.">
|
||
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
||
<meta name="twitter:card" content="summary_large_image">
|
||
<meta name="twitter:site" content="@home_assistant">
|
||
<meta name="twitter:title" content="Asterisk Voicemail">
|
||
<meta name="twitter:description" content="Instructions how to integrate your existing Asterisk voicemail within Home Assistant.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
|
||
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
||
<link rel='shortcut icon' href='/images/favicon.ico' />
|
||
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
||
</head>
|
||
<body >
|
||
<header class='site-header'>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
||
<a href="/" class="site-title">
|
||
<img width='40' src='/demo/favicon-192x192.png'>
|
||
<span>Home Assistant</span>
|
||
</a>
|
||
</div>
|
||
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
||
<nav>
|
||
<input type="checkbox" id="toggle">
|
||
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
||
<ul class="menu pull-right">
|
||
<li><a href="/getting-started/">Getting started</a></li>
|
||
<li><a href="/components/">Components</a></li>
|
||
<li><a href="/docs/">Docs</a></li>
|
||
<li><a href="/cookbook/">Examples</a></li>
|
||
<li><a href="/developers/">Developers</a></li>
|
||
<li><a href="/blog/">Blog</a></li>
|
||
<li><a href="/help/">Need help?</a></li>
|
||
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
||
</ul>
|
||
</nav>
|
||
<div class='search-container' style='display: none'>
|
||
<div class='search'>
|
||
<i class="icon-search"></i>
|
||
<input id='search' placeholder='Search the docs…'>
|
||
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="grid-wrapper">
|
||
<div class="grid grid-center">
|
||
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
||
<article class="page">
|
||
<header>
|
||
<h1 class="title indent">
|
||
Asterisk Voicemail
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The Asterisk Voicemail integration for Home Assistant allows you to view, listen to, and delete voicemails from an 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 indicates of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine.</p>
|
||
<p>To enable the component, a configuration is required in both Home Assistant as well as on the Asterisk server.</p>
|
||
<p>First follow the <a href="/docs/asterisk_mbox">Asterisk PBX configuration guide</a> to setup the necessary server on the Asterisk PBX server (this is needed even if Asterisk and Home Assistant are running on the same server)</p>
|
||
<p>Once that is complete, add the following entry <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">asterisk_mbox</span><span class="pi">:</span>
|
||
<span class="s">password</span><span class="pi">:</span> <span class="s">ASTERISK_PBX_PASSWORD</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">ASTERISK_PBX_SERVER_IP_ADDRESS</span>
|
||
<span class="s">port</span><span class="pi">:</span> <span class="s">ASTERISK_PBX_SERVER_PORT</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>This will add a new ‘Mailbox’ side-panel, as well as a sensor to indicate # of messages available.</p>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>password</strong> (<em>Required</em>): The password that was set during Asterisk PBX configuration</li>
|
||
<li><strong>host</strong> (<em>Required</em>): The ip-address of the server that is running the Asterisk PBX</li>
|
||
<li><strong>port</strong> (<em>Required</em>): The port on the Asterisk PBX server that was configured during Asterisk PBX configuration</li>
|
||
</ul>
|
||
<p class="note warning">
|
||
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 is contained within a local area network.
|
||
</p>
|
||
</article>
|
||
</div>
|
||
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
|
||
<div class="grid">
|
||
<section class="aside-module grid__item one-whole lap-one-half">
|
||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/asterisk_mbox.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
</div>
|
||
<div class='section'>
|
||
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Push
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class='title delta'>Related components</h1>
|
||
<ul class='divided'>
|
||
<li><a href='/components/mailbox.asterisk_mbox/'>
|
||
Asterisk Voicemail Mailbox
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Other</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/api/'>API</a>
|
||
</li>
|
||
<li>
|
||
Asterisk Voicemail
|
||
</li>
|
||
<li>
|
||
<a href='/components/configurator/'>Configurator</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/demo/'>Demo platforms</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/discovery/'>Discovery</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/dominos/'>Dominos Pizza</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/feedreader/'>Feedreader</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/frontend/'>Frontend</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/http/'>HTTP</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/introduction/'>Introduction</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/keyboard_remote/'>Keyboard Remote</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/mqtt_eventstream/'>MQTT Eventstream</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/mqtt_statestream/'>MQTT Statestream</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/map/'>Map</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/persistent_notification/'>Persistent notification</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/plant/'>Plant monitor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/system_log/'>System Log</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.upnp/'>UPNP Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/upnp/'>UPnP</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/updater/'>Updater</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/websocket_api/'>Websocket API</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/zeroconf/'>Zeroconf/Avahi/Bonjour</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</aside>
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item">
|
||
<div class="copyright">
|
||
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
||
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
||
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
||
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
||
<div class="credit">
|
||
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
|
||
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
||
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
||
</div>
|
||
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
<script>
|
||
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
||
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
||
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
||
s.parentNode.insertBefore(g,s)}(document,'script'));
|
||
</script>
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
||
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
||
<script type="text/javascript">
|
||
docsearch({
|
||
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
||
indexName: 'home-assistant',
|
||
inputSelector: '#search',
|
||
debug: false // Set debug to true if you want to inspect the dropdown
|
||
});
|
||
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'none';
|
||
});
|
||
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'block';
|
||
document.getElementById('toggle').checked = false;
|
||
document.querySelector('.search-container input').focus();
|
||
});
|
||
</script>
|
||
</body>
|
||
</html>
|