Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emrekeskinmac/service-sms-twilio
A MESG Core service to send sms by using Twillo
https://github.com/emrekeskinmac/service-sms-twilio
Last synced: 21 days ago
JSON representation
A MESG Core service to send sms by using Twillo
- Host: GitHub
- URL: https://github.com/emrekeskinmac/service-sms-twilio
- Owner: emrekeskinmac
- Created: 2019-01-20T14:07:09.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T22:43:08.000Z (about 2 years ago)
- Last Synced: 2024-11-18T00:37:16.369Z (about 1 month ago)
- Language: JavaScript
- Homepage: http://mesg.com
- Size: 239 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome - Sms Twilio - Send Sms through Twilio's API (Notification)
README
# Twilio SMS Service
Send SMS with Twilio
# Contents
- [Installation](#Installation)
- [Definitions](#Definitions)
- [Tasks](#Tasks)
- [sendSms](#sendsms)
# Installation
## MESG Core
This service requires [MESG Core](https://github.com/mesg-foundation/core) to be installed first.
You can install MESG Core by running the following command or [follow the installation guide](https://docs.mesg.com/guide/start-here/installation.html).
```bash
bash <(curl -fsSL https://mesg.com/install)
```
## Service
Download the source code of this service, and then in the service's folder, run the following command:
```bash
mesg-core service deploy
```
# Definitions
# Tasks
## sendSms
Task key: `sendSms`
Send email with Twilio
### Inputs
| **Name** | **Key** | **Type** | **Description** |
| --- | --- | --- | --- |
| **Twilio Account SID** | `accountSid` | `String` | The Twilio Account SID that you can create here https://www.twilio.com/console |
| **Twilio Account Auth Token** | `authToken` | `String` | The Twilio Account Auth Token that you can create here https://www.twilio.com/console |
| **Body** | `body` | `String` | The body of the sms |
| **From** | `from` | `String` | The account to send the sms from |
| **To** | `to` | `String` | The recipient of the sms |
### Outputs
#### Failure
Output key: `failure`
when an error occurs when trying to send the sms (this can be any kind of error, wrong phone number, Twilio API down...)
| **Name** | **Key** | **Type** | **Description** |
| --- | --- | --- | --- |
| **Message** | `message` | `String` | Error message |
#### Success
Output key: `success`
When the sms is successfully sent
| **Name** | **Key** | **Type** | **Description** |
| --- | --- | --- | --- |
| **Status** | `status` | `String` | Status returned by the Twilio API |