jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/telegram_bot.webhooks/index.html
Travis CI 47a79144a1 Site updated at 2017-05-10 16:21:22 UTC
2017-05-10 16:21:22 +00:00

170 lines
9 KiB
HTML
Raw Blame History

<!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>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_bot.webhooks/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Telegram webhooks">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/telegram_bot.webhooks/">
<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>
<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>
</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 chatbot webhooks implementation as described in the Telegram <a href="https://core.telegram.org/bots/webhooks">documentation</a>.</p>
<p>This is one of two bot implementations supported by Telegram. Described by Telegram as the preferred implementation but requires your Home Assistant instance to be exposed to the internet.</p>
<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> <span class="c1"># the hass https url which is exposed to the internet.</span>
<span class="s">telegram_bot</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">webhooks</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">telegram api key</span>
<span class="s">allowed_chat_ids</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">12345</span>
<span class="pi">-</span> <span class="s">67890</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>allowed_chat_ids</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>Required</em>): The API token of your bot.</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>To get your <code class="highlighter-rouge">chat_id</code> and <code class="highlighter-rouge">api_key</code> follow the instructions <a href="/components.notify.telegram">here</a> .</p>
<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>
<span class="s">telegram_bot</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">webhooks</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">ABCDEFGHJKLMNOPQRSTUVXYZ</span>
<span class="s">trusted_networks</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">149.154.167.197/32</span>
<span class="pi">-</span> <span class="s">149.154.167.198/31</span>
<span class="pi">-</span> <span class="s">149.154.167.200/29</span>
<span class="pi">-</span> <span class="s">149.154.167.208/28</span>
<span class="pi">-</span> <span class="s">149.154.167.224/29</span>
<span class="pi">-</span> <span class="s">149.154.167.232/31</span>
<span class="s">allowed_chat_ids</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">12345</span>
<span class="pi">-</span> <span class="s">67890</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_bot.webhooks.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/telegram.png' />
</div>
<div class='section'>
Introduced in release: 0.42
</div>
<div class='section'>
This is a platform for
<a href='/components/telegram_bot/'>the Telegram chatbot component</a>.
</div>
<div class='section'>
<h1 class="title delta">Category Telegram chatbot</h1>
<ul class='divided'>
<li>
<a href='/components/telegram_bot.polling/'>Telegram polling</a>
</li>
<li>
Telegram webhooks
</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>
</body>
</html>
Reference in a new issue View git blame Copy permalink