go-cli

A command-line interface for Vumi Go's HTTP APIs


License
BSD-3-Clause
Install
pip install go-cli==0.1.1

Documentation

Vumi Go command line interface

A command line interface for Vumi Go HTTP APIs.

go-cli go-cli-cover

Installation

Install with:

$ pip install --user go-cli

Then run:

$ go-cli --help

and read the usage instructions.

Sending messages

Run:

$ go-cli send --help

to learn about the options available for sending.

Example message sending:

$ go-cli --account 1edfdd412f253e9fc4975eb93c2c1e8c \
         send \
         --conversation a3aa791fab164dc894328564e2be5f16 \
         --token secret-token-you-entered \
         --csv messages.csv

Where messages.csv looks something like:

to_addr,content
+12345678,"Hello first person"
+12345679,"Hello second person"

Exporting contacts

Run:

$ go-cli export-contacts --help

to learn about the options available for downloading contacts.

Example contact exporting:

$ go-cli --account 1edfdd412f253e9fc4975eb93c2c1e8c \
         export-contacts \
         --token secret-token-for-your-contacts-api \
         --csv contacts.csv

Where contacts.csv is the file you'd like to export the contacts to.

If contact exporting is interrupt by a network error, a message will be printed explaining how to use --resume to continue it.

Reporting issues

You can contact the Vumi development team in the following ways:

Issues can be filed in the GitHub issue tracker. Please don't use the issue tracker for general support queries.