https://github.com/seven-io/civicrm
Send and receive SMS within CiviCRM
https://github.com/seven-io/civicrm
civicrm civicrm-extension seven-plugin sms
Last synced: about 1 month ago
JSON representation
Send and receive SMS within CiviCRM
- Host: GitHub
- URL: https://github.com/seven-io/civicrm
- Owner: seven-io
- License: other
- Created: 2021-09-23T09:51:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2026-04-28T12:11:20.000Z (about 2 months ago)
- Last Synced: 2026-04-28T14:22:46.197Z (about 2 months ago)
- Topics: civicrm, civicrm-extension, seven-plugin, sms
- Language: PHP
- Homepage: https://www.seven.io/en/docs/third-party-solutions/civicrm/
- Size: 344 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
seven SMS for CiviCRM
Two-way SMS provider for CiviCRM - send Outbound SMS activities and receive inbound messages via webhook.
---
## Features
- **Outbound SMS Provider** - Available in **Contact > Outbound SMS** activities
- **Inbound SMS via Webhook** - `SmsProvider.receive` API endpoint creates activities for incoming messages
- **Activity Log Integration** - Sent SMS land in the regular CiviCRM activity log
- **Custom Sender ID** - Set per-provider via the *API Parameters* field
## Prerequisites
- [CiviCRM](https://civicrm.org/) 5.x
- 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
```bash
cd /path/to/civicrm/ext
git clone https://github.com/seven-io/CiviCRM io.seven.sms
```
In the CiviCRM admin go to **Administer > System Settings > Extensions**, find *seven SMS provider* and click **Install**.
## Configuration
Add the seven SMS provider:
1. Go to **Administer > System Settings > SMS Providers**.
2. Click **Add SMS Provider**.
| Field | Value |
|-------|-------|
| Name | `seven` (defaults will load) |
| Title | Any label you like |
| Username | Any non-empty placeholder (field is unused but required) |
| Password | Your seven API key |
| API Type | `http` |
| API Url | `https://gateway.seven.io` |
| API Parameters | `from=CiviCRM` (or `from=` to omit) |
## Inbound SMS
Register a webhook in your seven [dashboard](https://app.seven.io/) (under *Developer > Webhooks*) pointing at the CiviCRM endpoint:
```
https:///civicrm/ajax/api3/SmsProvider/receive
```
> **Important:** The webhook event type must be set to **SMS_MO** in the seven dashboard.
You can also call the API manually:
```bash
cv api SmsProvider.receive sequential=1 from_number="01234" content="hello world"
```
## Usage
Send SMS via the standard CiviCRM workflow: **Contact > Outbound SMS** activity, or programmatically via the CiviCRM API.
Sent messages are recorded as regular activities in the contact's activity log.
## Support
Need help? Feel free to [contact us](https://www.seven.io/en/company/contact/) or [open an issue](https://github.com/seven-io/CiviCRM/issues).
## License
[MIT](LICENSE.txt)