/tellthat

Utility to call someone and tell them something

Primary LanguageTypeScriptMIT LicenseMIT

Tell That

NOTE This is a very early version, everything will change until version 1.0.0 is released

Command Line tool to call someone and tell them something, and (optionally) get a confirmation.

Requires a SignalWire account.

Shell exit code Meaning
0 Confirmed
1 Not confirmed
2 Timeout or error 
Usage: app [options]

Options:
  --csv [string]                  CSV file to read
  --concurrency [number]          How many calls to make at once (default: "1")
  --to [string]                   Phone number to dial
  --from [string]                 Caller ID (default: "+12068032583")
  --pauseBeforeGreeting [number]  Seconds to wait before greeting (default:
                                  "3")
  --greeting <string>             What to say when call is answered
  --tell <string>                 What you want to tell
  --confirm [boolean]             Confirm the message (default: "true")
  --loops [number]                Attempts at confirmation (default: "1")
  --thanks [string]               What to say when confirmed (default: "Thank
                                  you. Have a nice day!")
  --timeout [number]              Seconds to wait until call is answered
                                  (default: "30")
  --confirmStrings [string]       Comma-delimited list of strings that count as
                                  a confirmation (default:
                                  "yes,okay,sure,yeah,uh huh,yep")
  --verbose [boolean]             Verbose output (default: "true")
  -h, --help                      display help for command

Setting up your SignalWire account to use this utility

  1. Set up a SignalWire account
  2. Purchase a phone number - This will be used for your CallerID
  3. Create a new API token

Note: You must purchase a phone number to use as the "from" CallerID number.

Authentication:

  1. On the home / dashboard screen find the Project ID (looks like a UUID)
  2. Use the token you created in step (3) above
  3. Put the project ID and token into a new file ~/.tellthat.env:
SW_PROJECT_ID=xxxx
SW_TOKEN=xxxx