Skip to content

guevaraf/twilio-cli-plugin-sms

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@twilio/plugin-sms

Quick access to SMS API and bulk sending messages.

Setup

Short version

Prerequisites: NodeJS, Twilio CLI

  1. Clone this repo
  2. Install dependencies with:
$ npm i
  1. Go into the cloned repo and run:
$ twilio plugins:link .
  1. Now you can run the following command to get help
$ twilio help sms:send 
  1. To try sending a single test SMS
$ twilio sms:send -t=XXXXXXXXX -b="This is a test message"

Long version (explained)

Head over to the twilio-cli documentation.

Usage

$ twilio help sms:send
Send SMS single or in batch with a CSV file

USAGE
  $ twilio sms:send

OPTIONS
OPTIONAL FLAGS
  -b, --body=body                  [default: This is a test message] Body of the
                                   SMS message

  -f, --from=from                  [default: TWLO] Origin in E.164 format (can
                                   be alpha)

  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.

  -o=(columns|json|tsv|none)       [default: columns] Format of command output.

  -p, --pause=pause                Time in milliseconds between sends

  -p, --profile=profile            Shorthand identifier for your profile.

  -t, --to=to                      Destination in E.164 format

  -v, --verbose                    Produce verbose output

  --csv=csv                        Path to the CSV containing the SMS info
                                   (format: phone number to | body)

  --silent                         Suppress output and logs. This is a shorthand
                                   for "-l none -o none".
...

Commands

twilio sms:send

Used to send single or multiple test messages using Twilio's SMS API. If it is a single message the to and from parameters will be required. For multiple you will need to run a batch using a CSV file. That file has the format:

Phone Number Body
XXXXXXX This is a test message

where XXXXXXX is the destination number in E.164 format

See code: src/commands/sms/send.js

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published