jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Clickatell docs (#3823)

Browse Source 
* Update Clickatell docs

* Was milestoned for 0.56.3
This commit is contained in:
Fabian Affolter 2017-10-29 11:17:22 +01:00 committed by GitHub
parent 2e4ab991be
commit 0fb8f956ef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
source/_components/notify.clickatell.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "Clikatell SMS"
title: "Clickatell SMS"
description: "Instructions on how to add Clickatell notifications to Home Assistant."
date: 2017-10-09 00:00
sidebar: true
@ -18,17 +18,17 @@ The `clickatell` platform uses [Clickatell](https://clickatell.com) to deliver S
### Get your Clickatell API Credentials
Go to your [Clickatell SMS Platform Portal](https://portal.clickatell.com/#/) section and create a new SMS integration. There are three screens of information required to creater an integration. Please ensure the following:
1. Give the new Integration an identification name
2. ensure it is set for 'production' use
3. select 'HTTP' as your API type
4. Ensure that the you select for the messaging type to be 'one way messaging'
5. Be aware of the international number format option as this impacts the structure of the phone numbers you provide
6. Once you have completed entering your details an API key is generated. Copy the API key
1. Give the new Integration an identification name.
2. Ensure it is set for 'production' use.
3. Select 'HTTP' as your API type.
4. Ensure that the you select for the messaging type to be 'one way messaging'.
5. Be aware of the international number format option as this impacts the structure of the phone numbers you provide.
6. Once you have completed entering your details an API key is generated. Copy the API key.
### Configuration
To add Clickatell to your installation, add the following to your Home Assistant `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
notify:
- platform: clickatell
name: USER_DEFINED_NAME
@ -38,9 +38,9 @@ notify:
Configuration variables:
* **name** (Optional): Setting the optional parameter name allows multiple notifiers to be created. The default value is `Clickatell`. The notifier will bind to the service notify.NOTIFIER_NAME.
* **api_key** (Required): Your `API Key`.
* **recipient** (Required): Your phone no. This is where you want to send your notification SMS messages. eg: `61444333444`
* **name** (Optional): Setting the optional parameter name allows multiple notifiers to be created. The default value is `clickatell`. The notifier will bind to the service notify.NOTIFIER_NAME.
* **api_key** (Required): Your API key.
* **recipient** (Required): Your phone number. This is where you want to send your notification SMS messages. e.g. `61444333444`.
To use notifications, please see the [getting started with automation page](https://home-assistant.io/getting-started/automation/).

BIN
source/images/supported_brands/clickatell.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 16 KiB