On this page
Summary and project page for SMS Framework v1-3
The documentation herein is for the legacy/deprecated v1, v2, and v3 versions of SMS Framework.
Versions 4 and later have been re-architected. New documentation can be found in Communications Framework
This page shows a snapshot of the contents of the SMS Framework v3 project page, with minor alterations for tense/currency, before it was reworked for v4 and later.
The SMS Framework project is a set of modules enabling interaction between Drupal and mobile users via SMS. The included API allows developers to add support for third party gateways, and integrate gateway-agnostic SMS features in your projects.
The SMS Framework allows you to:
- Send SMS messages using any supported gateway
- Collect, confirm, and store mobile information for Drupal users
- Send batch messages to Drupal users
- Allow users to send nodes or portions of nodes to mobile phones
Support
- Instructions, how-to's, and developer documentation.
- Drupal Slack in #sms channel.
Gateways
The core SMS Framework does not bundle any gateways. Feel free to share your custom gateway modules in a separate project. A list of SMS gateway plugins can be found at Gateways for SMS Framework.
If you use another gateway with a simple HTTP API you may find the simple gateway module a possible option instead of writing your own gateway.
Installation
When downloading the project with Composer, use the sms project (not smsframework):
composer require drupal/smsYou may use the traditional module download procedure if you desire, as we do not have any non-drupal.org dependencies at this time. However, we recommend a Composer-based workflow:
Versions
| Major version | 2.3.x | 2.4.x | 3.0.x | 4.x |
|---|---|---|---|---|
| Drupal core | ^10.3 || ^11 | ^11 | ^11 | ^11 |
| PHP Compatibility | >=8.1 | >=8.3 | >=8.3 | >=8.3 |
| Stability | Stable | Stable | In Development | In Development |
| Support | Security only | Security only | New features and bug fixes | New features and bug fixes |
| Until PHP 8.1 security support ends or Drupal 10.3 EOL, whichever is earlier. | Until PHP 8.3 security support ends or Drupal 11.0 EOL, whichever is earlier. | Until PHP 8.3 security support ends or Drupal 11.0 EOL, whichever is earlier. | Until PHP 8.3 security support ends or Drupal 11.0 EOL, whichever is earlier. | |
| API and config | 2015, Legacy | 2025, New | ||
| 2025 API is a complete rewrite, no upgrade path Sites must uninstall if wanting to switch. |
||||
View support for previous versions.
Dependencies #
- Telephone — included with Drupal core.
- Dynamic Entity Reference
- Optional: Token — Token should be installed in order to use tokens on various parts of the admin UI.
SMS Framework recommends Telephone Validation as a solution to ensuring phone numbers are in correct format.
Help improve this page
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion
