Twilio Remote CLI

A remote control for your Twilio API

Prerequisites

The CLI has dependencies that require Node 6 or higher, together with NPM 3 or higher.

You will also need a Twilio account and phone number that can send SMS messages (you can sign up for a Twilio account for free here).

Table of Contents

• Twilio Remote CLI
  • Prerequisites
  • Table of Contents
  • Installation
    • Install Globally
    • Run from npm without installing
    • Install a specific version (Example: 0.0.1)
  • Usage
    • Options
      • --call, -c
      • --digits, -d
      • --sms, -s
      • --message, -m
  • Configuration
    • Sending SMS
    • Making calls
  • License

Installation

BEFORE YOU INSTALL: please read the prerequisites

Install Globally

npm install -g twilio-remote-cli

Run from npm without installing

npx twilio-remote-cli

Install a specific version (Example: 0.0.1)

npm install -g [email protected]

Usage

  $ twilio-remote --help

  Usage
    $ twilio-remote

  Options
    --call,    -c   Perform a call against a given number
    --digits   -d   Send some digits to the number when the call is answered
    --sms,     -s   Deliver an sms to a given number (to be used in combination of --message)
    --message, -m   The message to be delivered to the given number (requires the --sms flag)

  Example
    $ twilio-remote
    $ twilio-remote -c +1234567890
    $ twilio-remote -c +1234567890 -d 123
    $ twilio-remote -s +1234567890 -m Allo!

Then just follow the instructions on your terminal.

Options

--call, -c

Perform a call against a given number

$ twilio-remote -c +1234567890

--digits, -d

NOTE This flag must be used in combination with --call

Send some DTMF (Dual-Tone Multi-Frequency Tones) tones to the number when the call is answered. Have a look at Twilio Studio Flow. Learn more how to use the Gather Input On Call Twilio Widget from here

If a certain number requires to enter a code when the call is answered, you can use twilio-remote in this way:

$ twilio-remote -c +1234567890 -d 123

--sms, -s

Deliver an sms to a given number NOTE This flag must be used in combination with --message

$ twilio-remote -s +1234567890 -m Allo!

--message, -m

The message to be delivered to the given number NOTE This flag must be used in combination with --sms

$ twilio-remote -s +1234567890 -m Allo!

Configuration

Twilio Remote CLI make uses of the Twilio API by accessing you personal Twilio account. We need to configure the application with our Twilio credentials. Gather your Twilio Account Sid and Auth Token from the Twilio console along with a Twilio phone number that can send SMS messages.

Run the Twilio Remote CLI with

twilio-remote

Then select the Setup Twilio Account option and enter all the required information.

Sending SMS

Making calls

License

MIT

Created with 🦄 by andreasonny83