Dockwilio - Twilioを制御するDockerコンテナ(実験バージョン ) = コンテナ仕様編 =

更新：ver.2015.12.12リリースに伴い一部変更しました。

Dockwilioは、Twilioを使って簡単に架電＆音声合成メッセージ再生をすることができるDockerのコンテナです。

仕様を説明します。

仕組みについては概要編を、実行例については簡単手順編を参照してください。

Dockwilioは次の2つの機能を持っています。

• TwilioのREST APIにに対し架電を要求する。
• 上記要求によるTwilioからのHTTPアクセスに対し、音声メッセージのTwiMLを返す。

実験バージョンでは<Say>動詞１回実行のみサポートします。

コンテナはcentos6がベースで、内部で2つのnginxプロセスが稼働します。

1. 設定ファイル

Twilioの認証情報や発信元電話番号等を設定します。

ファイル名：dwilio.conf

 dwilio.conf はYAMLで記述します。

設定する内容については 4.パラメータ で説明します。

2. Dockwilioコンテナの起動

• -d を指定し、detachedします。
• -p 443:443 を指定し、TwilioからのTwiML要求をコンテナにフォワードします。
• -v {設定ファイルのディレクトリ}:/etc/dockwilio:ro を指定し、設定ファイルのあるディレクトリをマウントします。
• イメージは emerry/dockwilio です。

        起動例：

docker run -d -p 443:443 -v /dockwilio_config_dir:/etc/dockwilio:ro -v /etc/localtime:/etc/localtime:ro --name dwilio emerry/dockwilio

3. 架電＆音声メッセージ要求

架電先電話番号、再生する音声メッセージ等を指定します。

ホスト内からDockwilioのTCP 80番ポートに対し、YAMLまたはJSON形式でHTTP POSTします。

指定する内容は 4.パラメータ で説明します。

4. パラメータ

1.設定ファイル、3.架電＆音声メッセージ要求 で設定/指定できるパラメータは下記の通りです。

パラメータ	機能	設定ファイル	架電要求時	備考
account_sid	Account SID	○	○
auth_token	Auth Token	○	○
from	発信元電話番号	○	○	E.164形式
twiml_url_base	ホストのURL	必須	N/A	https:で始まりファイルパスは含まない
basic_user	BASIC認証のユーザ名	○	N/A	指定しない場合はBASIC認証を行わない
basic_password	BASIC認証のパスワード	○	N/A	指定しない場合はBASIC認証を行わない
call_timeout	呼び出し待ち時間(秒)	○	○	デフォルトは60秒
language	<Say>動詞の言語指定	○	○	デフォルトは ja-JP
voice	<Say>動詞の音声指定	○	○	デフォルトは alice
syslog_facility	syslogのfacility	必須	○
twiml_ssl_crt	TwiMLアクセス用SSL CERTIFICATEファイル名	必須	N/A	設定ファイルと同じディレクトリに配置
twiml_ssl_key	TwiMLアクセス用SSL KEYファイル名	必須	N/A	設定ファイルと同じディレクトリに配置
debug	デバッグ出力フラグ(true/false)	○	N/A	デフォルトはfalse
to	架電先電話番号	○	○	E.164形式
say	音声合成するメッセージ	○	○

5. 戻り値

架電処理終了後の戻り値は、架電要求と同じ書式です。

code	status	message	備考
0	completed		正常終了
1	busy		話中
	no-answer		無応答
-1	canceled		キャンセルされた(システムの問題)
	failed		失敗した(システムの問題)
(なし)		Service_Twilio_RestException	ライブラリのエラー(システムまたはプログラムの問題)
その他			エラーと警告の辞書参照

Dockwilio - Twilioを制御するDockerコンテナ(実験バージョン ) = 簡単手順編 =

更新：ver.2015.12.12リリースに伴い一部変更。

Dockwilioは、Twilioを使って簡単に架電＆音声合成メッセージ再生をすることができるDockerのコンテナです。

概要編に続き、実行するための簡単手順を説明します。

前提：

• Dockerエンジンがホストにインストールされている。
• Twilioにアカウントがあり、発信用電話番号を購入してある(Account SID, Auth Token、電話番号の情報が必要)。
• TwiMLアクセスのためのSSLサーバ証明書を用意してある。
• Dockwilioへの架電要求はホスト内から行う。

なお、Dockwilioイメージはcentos6がベースとなっており、内部で2つのnginxプロセスが稼働します。

1. 準備

TwilioからTwiMLを取得するためのHTTPSアクセスを許可します。

# iptables -A INPUT -p tcp -m tcp -dport 443 -j ACCEPT 

Dockwilioの設定ファイルを作成します。

ファイル名は「dwilio.conf」でYAML形式で記述します。

account_sid: ACxxxxxxxxxxxx
auth_token: xxxxxxxxxxxxx
from: +8150xxxxxxxx
twiml_url_base: https://hostname.example/
syslog_facility: local0
twiml_ssl_crt: fullchain.pem
twiml_ssl_key: privkey.pem

twiml_url_base の hostname.example にはDockwilioが稼働するホストのFQDNを指定します。

 2. Dockwilioコンテナの起動

docker run -d -p 443:443 -v /dockwilio_config_dir:/etc/dockwilio:ro -v /etc/localtime:/etc/localtime:ro --name dwilio emerry/dockwilio

 ここで、/dockwilio_config_dir は設定ファイル(dwilio.conf)およびSSL証明書のあるディレクトリです。

コンテナを起動すると、コンテナのIPアドレスがsyslog(local0)に出力されます。

Nov 22 11:32:20 4acb42090932 logger: IP address of Dockwilio: inet 172.17.0.51/16 scope global eth0

 3. 架電と音声メッセージ再生の実行

 ホスト内からDockwilioコンテナに対しHTTP POSTすることで(YAMLまたはJSON形式のいずれか)、架電の要求をします。

URLは「http://DockwilioコンテナのIPアドレス/say.{yaml,json}」で、架電の終了後に結果とともに戻ります。

下記はcurlコマンドを使用した例ですが、Content-length を指定する必要があるためlsコマンドで予めサイズを調べています。

YAMLの例：

$ ls -l post_data.yaml
-rw-r--r-- 1 user users 49 Nov 21 12:59 2015 post_data.yaml

$ cat post_data.yaml
to: +8180xxxxxxxx
say: Hello. How are you doing?

$ curl -XPOST http://172.17.0.51/say.yaml -H 'Content-length: 49' --data-binary @post_data.yaml
code: 0
status: completed
message: 

JSONの例：

$ ls -l post_data.json
-rw-r--r-- 1 user users 62 Nov 21 13:06 post_data.json

$ cat post_data.json
{
"to": "+818046684833",
"say": "Hello. How are you doing?"
}

$ curl -XPOST http://172.17.0.51/say.json -H 'Content-length: 62' --data-binary @post_data.json
{“code”:”0”,”status”:”completed”,”message”:””}

 仕様についてはコンテナ仕様編を参照してください。

Dockwilio - Twilioを制御するDockerコンテナ(実験バージョン ) = 概要編 =

Twilioは、電話サービスを使ったアプリケーションを作って提供するためのCloudサービスです。

しかし、Twilioを使うためにはWebサーバを用意し、そこにアプリケーション(TwiMLと呼ばれるXML)を配置しなければならないというのが、初学者にはわかりづらくハードルを高くしていると思われます。

例えば、電話をかけて音声メッセージを伝えるだけの場合、もしTwilioに相手の電話番号とメッセージ内容をAPIに伝えるだけでできれば簡単なのですが、実際にはメッセージ内容をWebサーバに配置し、それからREST APIに架電要求しなければなりません。

このような単純なアプリケーションを実現するためにだけにWebサーバを構築し、TwiMLの管理(生成、削除)をしなければならないのは、ちょっと面倒ですね。

そこで作ったのがTwilioを制御するためのDockerコンテナであるDockwilioです。

Dockwilioへの１回の要求で、架電と音声メッセージの再生を行えるものです。

具体的には、設定ファイルにTwilioの認証情報等を記述してDockwilioを起動しておき、HTTP POST により相手の電話番号やメッセージ内容等を伝えると、Twilioを制御して架電し、音声合成によるメッセージを再生します。

Dockwilioは常駐するコンテナで、HTTP POSTにより何度でも架電することも可能です(同時架電も可能)。

また、TwiMLの生成と削除はDockwilio内部で行われ、ユーザが意識する必要もありません。

Dockwilioは、Dockerのコンテナにより構築されるサービスにおいて、架電＆音声メッセージによる通知が必要なときにパーツとして組み合わせるのに適しています。

使い方については簡単手順編 を、仕様についてはコンテナ仕様編を参照してください。

気象特別警報・警報・注意報のTwitter bot

気象庁が実証実験として行っている、気象庁防災情報XMLのPubSubHubbubによるPuSH通知を受信して、各地の気象特別警報・警報・注意報をTwitterに投稿するbotを作成しました(対象地域は少ないですけど、、、)。

仕様

ユーザが必要な情報のみ通知を受けられるように、市区町村毎の特別警報・警報・注意報別にアカウントを作成しました。

ユーザは、知りたい地域・気象情報種別のアカウントをフォローし、即時に知りたいものについては通知設定をすると便利です。

2015年8月現在、以下のアカウントが稼働しています。

地域	注意報	警報	特別警報
東京都新宿区	@shinjuku_wa	@shinjuku_ww	@shinjuku_wew
東京都品川区	@shinagawa_wa	@shinagawa_ww	@shinagawa_wew
東京都葛飾区	@katsushika_wa	@katsushika_ww	@katsushika_wew
神奈川県横浜市	@yokohama_wa	@yokohama_ww	@yokohama_wew
Minato City, Tokyo (English)	@minato_ewa	@minato_eww	@minato_ewew

今のところ、気象庁による防災情報の発表から投稿までは、2〜3分程度の遅延が発生しています。

なお、当botがTwitterに投稿する情報の範囲は次の通りです。

注意報

大雨注意報、大雪注意報、風雪注意報、雷注意報、強風注意報、波浪注意報、融雪注意報、洪水注意報、高潮注意報、濃霧注意報、乾燥注意報、なだれ注意報、低温注意報、霜注意報、着氷注意報、着雪注意報

警報

暴風雪警報、大雨警報、洪水警報、暴風警報、大雪警報、波浪警報、高潮警報

特別警報

暴風雪特別警報、大雨特別警報、暴風特別警報、大雪特別警報、波浪特別警報、高潮特別警報

※ 河川洪水、土砂災害、地震、津波、噴火等の情報は対象外です。

気象庁防災情報XML配信の仕組み

XML形式の防災情報を、push方式のPubSubHubbubプロトコルにより、少ない遅延で配信しています。

PubSubHubbubはGoogleのエンジニアが考案した、publisher-hub-subscriberモデルのデータ配信のプロトコルです。情報提供者(publisher)がhubにデータを送信するとすぐに購読者(subscriber)に伝える仕組みで、最近はブログの更新情報を検索サイトに速やかに伝えるため等に使われています。

気象庁防災情報XML(実証実験)においては、次のような構成となっています。

• publisher - 気象庁
• hub - Google Alert Hub (いくつかの国の気象情報等を配信している)
• subscriber - 登録された受信者(含、当システム)

  

システムの構成

さくらのVPS(CentOS6)の上で稼働する、次の2つのdockerコンテナにより構成されています。

1. PuSH受信(PubSubHubbubのsubscriber)、詳細情報XMLを取得
2. Twitter投稿

2つのコンテナのイメージは同一で、CentOS6にnginx, Perl-FastCGI をインストールしたものです。

各コンテナ上で起動されるperl cgiによりそれぞれの異なる機能が提供されています。

今回プログラムを作成するにあたってPubSubHubbubの情報を検索をましたが、 publisherの情報ばかりヒットし、必要とするsubscriberの情報は少なく、その中でもperl cgiを使ったものにはなかなか出会えませんでした。

その数少ない perl cgi による subscriber についての記事の中の下記を、参考にしました。(・◇・)ほっほ さんありがとうございます。

気象庁の防災情報XMLを受信するぞ - (｡･ω･｡)ノ･☆':*;':*

日本語投稿テスト

1年前は、Safari on Mac からはてなブログに日本語記事を投稿できなかったのだけど、どうだろう。

Happy New Year!

Happy New Year 2012!

Japanese message makes some trouble on Safari, Mac OS X.

So, I will test with English message first.