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

Site updated at 2017-10-29 11:24:55 UTC

Browse source
This commit is contained in:
Travis CI 2017-10-29 11:24:55 +00:00
parent 1a92f39f55
commit 4cc894257c
220 changed files with 283 additions and 274 deletions
Download patch file Download diff file Expand all files Collapse all files

32
components/notify.clickatell/index.html
View file

@ -6,13 +6,13 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Clikatell SMS - Home Assistant</title>
<title>Clickatell SMS - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions on how to add Clickatell notifications to Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/notify.clickatell/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Clikatell SMS">
<meta property="og:title" content="Clickatell SMS">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/notify.clickatell/">
<meta property="og:type" content="article">
@ -20,7 +20,7 @@
<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="Clikatell SMS">
<meta name="twitter:title" content="Clickatell SMS">
<meta name="twitter:description" content="Instructions on how to add Clickatell notifications to 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">
@ -70,7 +70,7 @@
<article class="page">
<header>
<h1 class="title indent">
Clikatell SMS
Clickatell SMS
</h1>
</header>
<hr class="divider">
@ -78,16 +78,16 @@
<h3>Get your Clickatell API Credentials</h3>
<p>Go to your <a href="https://portal.clickatell.com/#/">Clickatell SMS Platform Portal</a> section and create a new SMS integration. There are three screens of information required to creater an integration. Please ensure the following:</p>
<ol>
<li>Give the new Integration an identification name</li>
<li>ensure it is set for ‘production’ use</li>
<li>select ‘HTTP’ as your API type</li>
<li>Ensure that the you select for the messaging type to be ‘one way messaging’</li>
<li>Be aware of the international number format option as this impacts the structure of the phone numbers you provide</li>
<li>Once you have completed entering your details an API key is generated. Copy the API key</li>
<li>Give the new Integration an identification name.</li>
<li>Ensure it is set for ‘production’ use.</li>
<li>Select ‘HTTP’ as your API type.</li>
<li>Ensure that the you select for the messaging type to be ‘one way messaging’.</li>
<li>Be aware of the international number format option as this impacts the structure of the phone numbers you provide.</li>
<li>Once you have completed entering your details an API key is generated. Copy the API key.</li>
</ol>
<h3>Configuration</h3>
<p>To add Clickatell to your installation, add the following to your Home Assistant <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">notify</span><span class="pi">:</span>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">notify</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">clickatell</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">USER_DEFINED_NAME</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">CLICKATELL_API_KEY</span>
@ -96,9 +96,9 @@
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (Optional): Setting the optional parameter name allows multiple notifiers to be created. The default value is <code class="highlighter-rouge">Clickatell</code>. The notifier will bind to the service notify.NOTIFIER_NAME.</li>
<li><strong>api_key</strong> (Required): Your <code class="highlighter-rouge">API Key</code>.</li>
<li><strong>recipient</strong> (Required): Your phone no. This is where you want to send your notification SMS messages. eg: <code class="highlighter-rouge">61444333444</code></li>
<li><strong>name</strong> (Optional): Setting the optional parameter name allows multiple notifiers to be created. The default value is <code class="highlighter-rouge">clickatell</code>. The notifier will bind to the service notify.NOTIFIER_NAME.</li>
<li><strong>api_key</strong> (Required): Your API key.</li>
<li><strong>recipient</strong> (Required): Your phone number. This is where you want to send your notification SMS messages. e.g. <code class="highlighter-rouge">61444333444</code>.</li>
</ul>
<p>To use notifications, please see the <a href="https://home-assistant.io/getting-started/automation/">getting started with automation page</a>.</p>
</article>
@ -142,7 +142,7 @@
<a href='/components/notify.clicksend_tts/'>ClickSend text-to-speech</a>
</li>
<li>
Clikatell SMS
Clickatell SMS
</li>
<li>
<a href='/components/notify.command_line/'>Command line Notify</a>