2024.12.5
Home ▸ Integrations ▸

Free Mobile

The free_mobile integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] 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.

Note

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.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

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

Configuration Variables

Looking for your configuration file?
name string (Optional, default: notify)

The optional parameter name allows multiple notifiers to be created. The notifier will bind to the notify.NOTIFIER_NAME action.

username string Required

This is the id given by FreeMobile to access your online account.

access_token string Required

You can get this token by activating the SMS API in your online account.

Related topics