Skip to content

Commit eaed54a

Browse files
davlloydballoob
authored andcommitted
Added markdown and image files for notify clickatell SMS message plat… (home-assistant#3569)
* Added markdown and image files for notify clickatell SMS message platform * Update notify.clickatell.markdown
1 parent 843a97d commit eaed54a

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
layout: page
3+
title: "Clikatell SMS"
4+
description: "Instructions on how to add Clickatell notifications to Home Assistant."
5+
date: 2017-10-09 00:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: clickatell.png
11+
ha_category: Notifications
12+
ha_release: 0.56
13+
---
14+
15+
16+
The `clickatell` platform uses [Clickatell](https://clickatell.com) to deliver SMS notifications from Home Assistant.
17+
18+
### Get your Clickatell API Credentials
19+
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:
20+
21+
1. Give the new Integration an identification name
22+
2. ensure it is set for 'production' use
23+
3. select 'HTTP' as your API type
24+
4. Ensure that the you select for the messaging type to be 'one way messaging'
25+
5. Be aware of the international number format option as this impacts the structure of the phone numbers you provide
26+
6. Once you have completed entering your details an API key is generated. Copy the API key
27+
28+
### Configuration
29+
To add Clickatell to your installation, add the following to your Home Assistant `configuration.yaml` file:
30+
31+
```yaml
32+
notify:
33+
- platform: clickatell
34+
name: USER_DEFINED_NAME
35+
api_key: CLICKATELL_API_KEY
36+
recipient: PHONE_NO
37+
```
38+
39+
Configuration variables:
40+
41+
* **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.
42+
* **api_key** (Required): Your `API Key`.
43+
* **recipient** (Required): Your phone no. This is where you want to send your notification SMS messages. eg: `61444333444`
44+
45+
46+
To use notifications, please see the [getting started with automation page](https://home-assistant.io/getting-started/automation/).
22 KB
Loading

0 commit comments

Comments
 (0)