/mailtext-send

Minimalistic module to send SMS using Mailtext Platform

Primary LanguageTypeScript

npm version Build Status

Mailtext-send

Minimalistic module to send bulk sms using Mailtext

Basically it's a wrapper to simplify its usage for Mailtext accounts even more.

If you have different needs regarding the functionality, please add a feature request.

Install

npm install --save mailtext-send

Prerequisites

Preparation step - Configure your Mailtext account

In order to send sms using MailText you need your account to be configured properly.

  1. Visit https://partner.mailtext.co/ and create an account.
  2. Login into your account at https://app.mailtext.co/login. Click on Recharge Wallet Menu to load your wallet.

Quick Start

  1. Initialization: require the module and set defaults
 const {mailText} = require('mailtext-send')
 mailText(account).send(message, (res, err) => { console.log(res) })
  • account - mandatory - an object with the following basic authentication properties

    • email - mandatory
    • password - mandatory
  • message - mandatory - an object with properties for sending bulk sms

    • numbers - mandatory - array of string phonenumbers. ['8989898932','908989394']
    • sms_id - mandatory
    • message - mandatory
    • type - mandatory - type of sms. You can set default to bulk

Credits

Philip

Troubleshooting

  1. If you an exception with message "** Error: An error occurred while getting token. Visit https://partner.mailtext.co for more details. Error: Not Found **". You should check your account credentials / Sign up for an account on https://partner.mailtext.co

  2. If you an exception with message "** Error: An error occurred while sending SMS. Visit https://partner.mailtext.co for more details. Error message: Payment Required **". You should top up your wallet.

Links to package pages:

github.com   npmjs.com   travis-ci.org   coveralls.io   inch-ci.org

License

ISC