home-assistant.io/source/_integrations/free_mobile.markdown
Stefan a17b38f0f3
Fix duplicate metadata (#24490)
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2022-10-10 15:07:51 +02:00

1.8 KiB

title, description, ha_category, ha_release, ha_iot_class, ha_domain, ha_platforms, ha_integration_type
title description ha_category ha_release ha_iot_class ha_domain ha_platforms ha_integration_type
Free Mobile Instructions on how to add Free Mobile SMS notifications to Home Assistant.
Notifications
0.11 Cloud Push free_mobile
notify
integration

The free_mobile platform uses the French mobile operator Free Mobile to send SMS to your own cell phone.

Prerequisites

Before doing anything, you have to activate the SMS API option in your Free Mobile account (In "Gérer mon compte -> Mes Options"). Activating this option will automatically generate a token which is required in your configuration.

This API only sends classic SMS messages and only to the cell phone of the account owner. So you only have to provide a text message in your payload.

If you disable and re-enable the SMS API option, please be sure to update your token in your configuration.

Configuration

To use this notification platform in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
notify:
  - name: NOTIFIER_NAME
    platform: free_mobile
    username: YOUR_ACCOUNT_ID
    access_token: TOKEN

{% configuration %} name: description: "The optional parameter name allows multiple notifiers to be created. The notifier will bind to the service notify.NOTIFIER_NAME." required: false type: string default: notify username: description: This is the id given by FreeMobile to access your online account. required: true type: string access_token: description: You can get this token by activating the SMS API in your online account. required: true type: string {% endconfiguration %}