Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/seven-io/civicrm

Send and receive SMS within CiviCRM
https://github.com/seven-io/civicrm

civicrm civicrm-extension sms

Last synced: 9 days ago
JSON representation

Send and receive SMS within CiviCRM

Awesome Lists containing this project

README

        

# io.seven.sms

This CiviCRM extension provides a [seven](https://www.seven.io) SMS provider for
sending/receiving SMS.

## Installation

- `cd /path/to/civicrm/ext`
- `git clone https://github.com/seven-io/CiviCRM io.seven.sms`
- Go to `Administer->System Settings->Extensions`
- Locate `seven SMS provider`and press the `Install` button

## Setup

- Navigate to `Administer->System Settings->SMS Providers`
- Click the button `Add SMS Provider`
- `Name`: Choose `seven` and wait for the default values to load
- `Title`: Use whatever label makes sense to you
- `Username`: Insert anything, the field is not used, but required
- `Password`: Use one of your seven API keys
- `API Type`: Set this to `http`
- `API Url`: Make sure it's set to `https://gateway.seven.io`
- `API Parameters`: Set a custom sender ID like `from=CiviCRM` or omit the value
e.g. `from=`

## Usage

To receive an SMS message use the SmsProvider.receive function:

```cv api SmsProvider.receive sequential=1 from_number="01234" content="hello world" ```

To send an SMS use the built-in CiviCRM functions (e.g. Contact->Outbound SMS activity).

Sent SMS messages will be added to the activity log.

**Important:** Make sure to use event *SMS_MO* when creating a seven webhook.

### Support

Need help? Feel free to [contact us](https://www.seven.io/en/company/contact/).

[![MIT](https://img.shields.io/badge/License-MIT-teal.svg)](LICENSE.txt)