jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2017-03-18 17:12:07 UTC

Browse source
This commit is contained in:
Travis CI 2017-03-18 17:12:07 +00:00
parent 7573fcba68
commit 67179bf8fe
994 changed files with 1768 additions and 68252 deletions
Download patch file Download diff file Expand all files Collapse all files

57
components/telegram_webhooks/index.html
View file

@ -3,17 +3,14 @@
<!--[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>Telegram webhooks - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Telegram webhooks support">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/telegram_webhooks/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Telegram webhooks">
<meta property="og:site_name" content="Home Assistant">
@ -21,39 +18,31 @@
<meta property="og:type" content="article">
<meta property="og:description" content="Telegram webhooks support">
<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="Telegram webhooks">
<meta name="twitter:description" content="Telegram webhooks support">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" 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>
<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>
@ -64,45 +53,27 @@
</ul>
</nav>
</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">
Telegram Webhooks
</h1>
</header>
<hr class="divider">
<p>Telegram webhooks support as described in <a href="https://core.telegram.org/bots/webhooks">docs</a>.</p>
<p>With new component <code class="highlighter-rouge">telegram_webhooks</code> it is possible to send commands to Home Assistant via a Telegram bot. It works well with Telegram notification: webhooks receive commands from user and notify send messages to user.</p>
<p>Webhook responds only to:</p>
<ul>
<li>users listed in configuration, in telegram user_id format.</li>
<li>telegram servers (listed in webhooks <a href="https://core.telegram.org/bots/webhooks">docs</a>) specified in trusted_networks</li>
</ul>
<p>To integrate this into Home Assistant, add the following section to your <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">http</span><span class="pi">:</span>
<span class="s">base_url</span><span class="pi">:</span> <span class="s">&lt;public_url&gt;</span>
@ -112,17 +83,13 @@
<span class="s">user1</span><span class="pi">:</span> <span class="s">USER_ID</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>user_id</strong> (<em>Required</em>): A list of user in the <code class="highlighter-rouge">user_id</code> Telegram format enabled to interact to webhook</li>
<li><strong>api_key</strong> (<em>Optional</em>): The API token of your bot. If present, the webhook of bot is automatically registered to <code class="highlighter-rouge">public_url/api/telegram_webhooks</code>. If not present, manual registration is required.</li>
<li><strong>trusted_networks</strong> (<em>Optional</em>): Telegram server access ACL as list. Defaults to <code class="highlighter-rouge">149.154.167.197-233</code>.</li>
</ul>
<p>Full configuration sample:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">http</span><span class="pi">:</span>
<span class="s">base_url</span><span class="pi">:</span> <span class="s">&lt;public_url&gt;</span>
@ -141,11 +108,8 @@
<span class="s">user2</span><span class="pi">:</span> <span class="s">USER_ID</span>
</code></pre>
</div>
<h3><a class="title-link" name="configuration-samples" href="#configuration-samples"></a> Configuration samples</h3>
<p>Telegram webhooks raise an event <code class="highlighter-rouge">telegram.command</code> with a payload.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="err">'command':</span><span class="w"> </span><span class="err">'/thecommand'</span><span class="w">
</span><span class="err">'args':</span><span class="w"> </span><span class="err">'strings</span><span class="w"> </span><span class="err">after</span><span class="w"> </span><span class="err">command'</span><span class="w">
@ -153,9 +117,7 @@
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<p>Automation example that realize simple test to command/notify interaction.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">alias</span><span class="pi">:</span> <span class="s1">'</span><span class="s">telegram</span><span class="nv"> </span><span class="s">bot</span><span class="nv"> </span><span class="s">that</span><span class="nv"> </span><span class="s">reply</span><span class="nv"> </span><span class="s">pong</span><span class="nv"> </span><span class="s">to</span><span class="nv"> </span><span class="s">ping'</span>
<span class="s">hide_entity</span><span class="pi">:</span> <span class="s">true</span>
<span class="s">trigger</span><span class="pi">:</span>
@ -169,9 +131,7 @@
<span class="s">message</span><span class="pi">:</span> <span class="s1">'</span><span class="s">pong'</span>
</code></pre>
</div>
<p>Example that show keyboard interaction with <code class="highlighter-rouge">notify.telegram</code></p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">telegram.command</span>
@ -187,9 +147,7 @@
<span class="pi">-</span> <span class="s1">'</span><span class="s">/siren'</span>
</code></pre>
</div>
<p>and an automation to trigger a related command “/siren”.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">telegram.command</span>
@ -204,18 +162,10 @@
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.vision_zm1601eu5_battery_operated_siren_switch_9_0</span>
</code></pre>
</div>
</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/telegram_webhooks.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
@ -362,13 +312,10 @@
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
@ -378,7 +325,6 @@
<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>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
@ -390,7 +336,6 @@
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
@ -398,4 +343,4 @@
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>
</html>