Boundio is a Twilio-like service offered by Japanese mobile opperator KDDI. This describes the Ruby boundio API and binary.

Installation

Install the Ruby library and binary.

gem install boundio

Both are dependent on the following environment variables. It is easiest if you add them to something like your .bash_rc so they will always be available. You can find the appropriate values from the boundio dashboard.

export BOUNDIO_USER_SERIAL_ID=your_serial # ユーザーシリアルID from main page
export BOUNDIO_API_KEY=your_api_key # アプリケーションキー from main page
export BOUNDIO_USER_KEY= # ユーザー認証キー from アカウント管理

Usage

Once installed, you should have access to the boundio command. You can use boundio help to see a list of available commands and get detailed help information on each.

You can also use the Ruby API directly. The example below reads a csv file from with phone numbers and names from stdin, and calls each of those numbers, with the greeting 「こんにちは、○○さん。」. It then fetches and displays the call status until it has been completed.

Call

Call the specified number with the given "cast". The "cast" seems to be a boundio-specific language for describing calls. The resulting call id will be output. See the call API for more details.

Example

$ boundio call --tel-to=09012345678 --cast='file(000001)'
1234

Status

Look up the status of the specified call or calls within a range. If you use a range today's calls and unanswered calls do not seem to be included. See the status API for more details.

Example

$ boundio status --tel-id=1234
TelStatus (1234): 05058373992 -> 09012345678, 2012-03-10 14:42 - , 架電待機
$ boundio status --start=20120201 --end=20120311
TelStatus (2704): 05058373992 -> 09012345678, 2012-02-26 18:34 - 2012-02-26 18:34, 架電完了
TelStatus (2686): 05058373992 -> 09012345678, 2012-02-25 09:54 - 2012-02-25 09:54, 架電完了
TelStatus (2684): 05058373992 -> 09012345678, 2012-02-25 09:48 - 2012-02-25 09:48, 架電完了
TelStatus (2682): 05058373992 -> 09012345678, 2012-02-24 17:39 - 2012-02-24 17:39, 架電完了

File

Upload a file or text for text-to-speech. See the file API for details.

$ boundio file --convtext="ほげ"
$ boundio file --file=/usr/share/sounds/alsa/Front_Center.wav

Source Code

Build Status

Source code is available on GitHub. Please report any issues there. Contributors welcome.

Debugging

The boundio gem uses RestClient for handling http requests, so you can use the RESTCLIENT_LOG environment variable to help you with debugging. For example:

$ RESTCLIENT_LOG=stdout boundio call --tel-to=09012345678 --cast='file(000001)'