https://github.com/seven-io/bolt
Send SMS from within BoltCMS
https://github.com/seven-io/bolt
bolt bolt-cms boltcms cms sms
Last synced: about 2 months ago
JSON representation
Send SMS from within BoltCMS
- Host: GitHub
- URL: https://github.com/seven-io/bolt
- Owner: seven-io
- License: mit
- Created: 2021-05-31T11:44:40.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T13:16:57.000Z (over 2 years ago)
- Last Synced: 2025-01-07T12:49:18.711Z (over 1 year ago)
- Topics: bolt, bolt-cms, boltcms, cms, sms
- Language: PHP
- Homepage: https://www.seven.io/en/docs/third-party-solutions/bolt-cms/
- Size: 772 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
seven SMS for BoltCMS
Send SMS and text-to-speech calls to your BoltCMS content types via the seven gateway.
---
## Features
- **Admin Widget** - Send messages from the Bolt dashboard with a single click
- **SMS & Voice** - Switch between text messages and text-to-speech voice calls
- **Field Placeholders** - Reference any content-type field with `{{fieldname}}` in the message body
- **Configurable Mappings** - Map each content type to its mobile-number field via YAML
## Prerequisites
- BoltCMS 4 or 5
- PHP 7.2+
- A [seven account](https://www.seven.io/) with API key ([How to get your API key](https://help.seven.io/en/developer/where-do-i-find-my-api-key))
## Installation
### 1. Install via Composer
```bash
composer require seven.io/bolt
```
### 2. Add a mobile-phone field to your content types
```yaml
people:
# ...
mobile:
type: text
variant: inline
# ...
```
### 3. Configure the extension
Open `/bolt/file-edit/config?file=/extensions/seven-bolt.yaml` (or **Maintenance > Extensions > Configuration** in the admin) and fill in:
| Field | Description |
|-------|-------------|
| `apiKey` | Your seven API key |
| `mappings` | Map each content type to its mobile-number field, e.g. `people: mobile` |
## Usage
### Send SMS
Pick a content type in the seven dashboard widget. Every record with a mobile-number field will receive the message.
### Make text-to-speech calls
Use the same widget but switch the message type to *Voice*. The recipient will receive an automated call reading out the text.
### Message placeholders
Any content-type field can be referenced inside the message body via `{{fieldname}}`:
```
Hi {{name}}, your order is on its way!
```
Make sure the value has a `__toString()` representation - there is no type-coercion magic.
## Support
Need help? Feel free to [contact us](https://www.seven.io/en/company/contact/) or [open an issue](https://github.com/seven-io/bolt/issues).
## License
[MIT](LICENSE)