mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-20 15:56:51 +00:00
add messagebird documentation
This commit is contained in:
parent
aecc3fda5f
commit
4e0a0f01e2
45
source/_components/notify.message_bird.markdown
Normal file
45
source/_components/notify.message_bird.markdown
Normal file
@ -0,0 +1,45 @@
|
|||||||
|
---
|
||||||
|
layout: page
|
||||||
|
title: "MessageBird"
|
||||||
|
description: "Instructions how to add user notifications to Home Assistant."
|
||||||
|
date: 2016-03-15 17:00
|
||||||
|
sidebar: true
|
||||||
|
comments: false
|
||||||
|
sharing: true
|
||||||
|
footer: true
|
||||||
|
logo: message_bird.svg
|
||||||
|
ha_category: Notifications
|
||||||
|
featured: true
|
||||||
|
---
|
||||||
|
|
||||||
|
The `MessageBird` notification platform sends notifications as SMS messages using [MessageBird](https://www.messagebird.com/) to your mobile phone.
|
||||||
|
|
||||||
|
To enable MessageBird notifications in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
notify:
|
||||||
|
platform: message_bird
|
||||||
|
api_key: YOUR_API_KEY
|
||||||
|
name: NOTIFIER_NAME
|
||||||
|
sender: SENDER_NAME
|
||||||
|
```
|
||||||
|
|
||||||
|
Configuration variables:
|
||||||
|
|
||||||
|
- **api_key** (*Required*): Enter the API key for MessageBird. Go to https://www.messagebird.com/ to retrieve your API key.
|
||||||
|
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||||
|
- **sender** (*Optional*): Setting the optional parameter `sender`. This will be the sender of the SMS. It may be either a telephone number (e.g. `+4915112345678`) or a text with a maximum length of 11 characters. Defaults to `HA`.
|
||||||
|
|
||||||
|
### {% linkable_title Usage %}
|
||||||
|
|
||||||
|
MessageBird is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will send a notification to the specified mobile phone number(s).
|
||||||
|
|
||||||
|
#### {% linkable_title Example service payload %}
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "A message for many people",
|
||||||
|
"target": [ "+49123456789", "+43123456789" ]
|
||||||
|
}
|
||||||
|
```
|
3
source/images/supported_brands/message_bird.svg
Normal file
3
source/images/supported_brands/message_bird.svg
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
<svg id="Layer_1" xmlns="http://www.w3.org/2000/svg" width="740" height="140" viewBox="0 0 740 140"><style><![CDATA[
|
||||||
|
.st0{fill:#FFFFFF;}
|
||||||
|
]]></style><path class="st0" d="M255.8 99.2V52.8h-.2l-14.2 46.4h-14.7l-14.2-46.4h-.2v46.4h-14.9V38.8h24.8L234 80h.2l11.7-41.3h24.8v60.4h-14.9zm68.8-23.7c0 1.5-.1 4.3-.1 4.3h-32c.3 4.7 4.1 7.9 10.2 7.9 6.2 0 10.4-2.4 13.3-4.7h.7l4.6 11.9c-2.9 2.3-9.5 5.3-18.3 5.3-14.2 0-24.4-9.1-24.4-24.9 0-15.6 10.2-25.5 23.5-25.5 13.5 0 22.5 10.4 22.5 25.7zm-31.6-6h18.5c-.4-3.8-3.8-7.5-9.2-7.5-5.5 0-8.7 3.6-9.3 7.5zm76.9-12.2l-5.1 11.3h-.7c-4.1-4.5-9.8-6.8-14.2-6.8-3.7 0-5.1 1.6-5.1 3.2 0 2.1.8 2.4 11.1 4.9 9.6 2.3 15.9 6 15.9 15.3 0 9.7-6.8 15-18.6 15-11.7 0-20.1-4.4-23.4-7.9l5.4-12.1h.7c4.2 3.5 9.4 6.9 16.8 6.9 4.4 0 5.2-1.2 5.2-2.8 0-1.6-.9-2.5-11.3-5.1-11.2-2.8-15.5-7.3-15.5-14.6 0-9.1 7.3-14.9 18.2-14.9 10.4.1 18.4 5 20.6 7.6zm46.3 0l-5.1 11.3h-.7c-4.1-4.5-9.8-6.8-14.2-6.8-3.7 0-5.1 1.6-5.1 3.2 0 2.1.8 2.4 11.1 4.9 9.6 2.3 15.9 6 15.9 15.3 0 9.7-6.8 15-18.6 15-11.7 0-20.1-4.4-23.4-7.9l5.4-12.1h.7c4.2 3.5 9.4 6.9 16.8 6.9 4.4 0 5.2-1.2 5.2-2.8 0-1.6-.9-2.5-11.3-5.1-11.2-2.8-15.5-7.3-15.5-14.6 0-9.1 7.3-14.9 18.2-14.9 10.5.1 18.5 5 20.6 7.6zm46.6 11.1v30.8h-11.3l-1.2-6.4h-.3c-2.3 4.1-7.1 7.4-13.9 7.4-9.3 0-14.1-6-14.1-13.9s3.6-12.9 14.9-15.1c11.3-2.2 12.1-3 12.1-5.4 0-2.3-2.2-3.6-6.7-3.6-4.9 0-10.4 3.5-13.4 8h-.7l-5.7-11.7c5.3-5.2 12.1-8.7 20.7-8.7 10.9 0 19.6 7.1 19.6 18.6zM449 77.8c-.8 1.3-2.3 2.2-7.4 3.4-4.9 1.2-5.6 2.6-5.6 4.5s1.6 2.8 4.1 2.8c4 0 9.1-2.6 9.1-6.5v-4.2h-.2zm54.1-20.6h.3l.8-6.4h11.2V93c0 14.9-8.4 23.1-23.7 23.1-8.7 0-15.4-2.9-19.5-5.9l4.3-12.3h.7c4.1 3.3 8.5 5.3 14 5.3 7.3 0 9.9-2.9 9.9-9.4v-4.4h-.3c-2.1 3.1-6.2 5.7-12.4 5.7-11.5 0-19.5-9-19.5-21.8 0-14 9.5-23.6 20.7-23.6 6.8.1 11.5 4.1 13.5 7.5zm-19.5 15.7c0 5.9 3.7 9.6 9.3 9.6 5.4 0 9.1-3.4 9.1-9.7 0-6-3.2-10.3-9.1-10.3-6.1 0-9.3 4.5-9.3 10.4zm84.8 2.6c0 1.5-.1 4.3-.1 4.3h-32c.3 4.7 4.1 7.9 10.2 7.9 6.2 0 10.4-2.4 13.3-4.7h.7l4.5 12c-2.9 2.3-9.5 5.3-18.3 5.3-14.2 0-24.4-9.1-24.4-24.9 0-15.6 10.2-25.5 23.5-25.5 13.6-.1 22.6 10.3 22.6 25.6zm-31.6-6h18.5c-.4-3.8-3.8-7.5-9.2-7.5-5.4 0-8.7 3.6-9.3 7.5zm71.7-30.7c11.9 0 18.3 5.8 18.3 15.5 0 6.9-3.2 11.2-9.5 13.9v.2c5.7 2.2 9.5 6.9 9.5 14.7s-4.4 16.1-20.5 16.1h-30.2V38.8h32.4zm-17.1 24.6h14.4c3.6 0 5.6-2.1 5.6-5.2 0-3-1.6-5.4-6.1-5.4h-13.9v10.6zm0 21.8h14.4c3.6 0 5.6-2.1 5.6-5.3s-1.6-5.6-6.1-5.6h-13.9v10.9zm59-49.1c0 5.2-3.2 9-9 9s-9-3.8-9-9c0-5.3 3.2-8.8 9-8.8s9 3.5 9 8.8zm-16.2 63.1V50.8h14.2v48.3h-14.2zm56.2-45.4l-2.1 13h-.7c-1.4-1.5-3.5-2.9-6.6-2.9-5.7 0-9 5.2-9 13.9v21.4h-14.2V50.8h11.7l.8 6.4h.3c2.6-5.2 6.6-7.4 11-7.4 3.4 0 7 1.3 8.8 4zm38.3 45.4l-1.2-6.4h-.3c-2.8 4.4-7 7.4-14.7 7.4-13 0-21.2-10.4-21.2-24.5 0-14.5 8.6-25.9 21.6-25.9 5.7 0 10.4 2.2 13.1 6h.2V35.1H740v64.1h-11.3zm-23.2-24.1c0 7.3 4.2 11.9 10.5 11.9s10.6-4.1 10.6-12c0-7.3-4.2-12.5-10.4-12.5s-10.7 5.3-10.7 12.6zM147.6 24.7c-6.6 0-12.5 3.3-16.1 8.3l-24.3 34c-.9 1.3-2.4 2.1-4 2.1-2.7 0-4.9-2.2-4.9-4.9 0-1 .3-2 .8-2.7l20.5-30.7c2.1-3.1 3.3-6.9 3.3-11 0-10.9-8.8-19.7-19.7-19.7H0v19.7h88.4c0 5.4-4.4 9.9-9.9 9.9H0c0 7 1.5 13.7 4.1 19.7h64.5c0 5.4-4.4 9.9-9.9 9.9H9.9c9 12 23.3 19.7 39.5 19.7h24.3c2.7 0 4.9 2.2 4.9 4.9s-2.2 4.9-4.9 4.9H49.3l-33 49.3H76c27.3 0 50.5-17.8 58.6-42.4L145.7 62c3.6-10.9 10.2-20.5 18.8-27.8-3.4-5.7-9.7-9.5-16.9-9.5zm0 13.5c-2 0-3.7-1.7-3.7-3.7s1.7-3.7 3.7-3.7 3.7 1.7 3.7 3.7c0 2.1-1.7 3.7-3.7 3.7z"/></svg>
|
After Width: | Height: | Size: 3.3 KiB |
Loading…
x
Reference in New Issue
Block a user