メニュー

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Programmable Voice クイックスタート for Ruby

Twilio Programmable Voiceを使用すればたった数行のコードで、Rubyアプリケーションで通話の発着信ができるようになります。

このクイックスタートでは、開発を容易にするためにTwilioのREST APITwilio Rubyヘルパーライブラリー、そしてRubyのSinatraフレームワークを使用してこれを行う方法をお教えします。

このクイックスタートでは、下記のことを学習します:

1. Twilioにサインアップして音声通話対応の最初のTwilio電話番号を入手する
2. 通話の発着信を行うための開発環境をセットアップする
3. MP3ファイルを再生する通話を発信する
4. 着信通話に対してテキストtoスピーチを使用して発信者にメッセージを読み上げる応答を行う

ビデオを見ながらの入門がお好みですか? Rubyで通話の発着信を行う方法 YouTubeビデオ (英語) をご覧ください。

Show me how it's done!

すでにTwilioアカウントと音声通話機能を持ったTwilio電話番号をお持ちなら、すでに準備万端です!ログインして次のステップまで読み飛ばしてください。

Rubyで通話を発信できるようになる前に、Twilioアカウントが必要になります。 こちらでサインアップして無料のトライアルアカウントを取得するか、すでにアカウントをお持ちの場合はログインしてください。


The next thing you'll need is a voice-capable Twilio phone number. If you don't currently own a Twilio phone number with voice call functionality, you'll need to purchase one. After navigating to the Buy a Number page, check the "Voice" box and click "Search."

音声通話機能対応の電話番号を検索する

すると、利用可能な電話番号と、その機能の一覧が表示されます。 お好みに合った番号が見つかったら「購入」をクリックすると、それがアカウントに追加されます。

Twilioから音声通話機能付きの電話番号を購入する

これでTwilioアカウントとプログラマブルな電話番号が手に入ったので、通話の発信に必要な基本ツールが揃ったことになります。

TwilioのHTTP APIを使用して通話を発信できますが、Twilioの公式Rubyヘルパーライブラリーを使用してこれをより容易にします。 次はこれをインストールしましょう。

セットアップ方法を教えてください。

すでに他のRubyクイックスタートを終えていて、RubyおよびTwilio Rubyヘルパーライブラリーがインストールされている場合は、このステップを読み飛ばしてすぐに最初の通話発信を行うことができます。

最初の通話を発信するには、RubyおよびTwilio Rubyヘルパーライブラリーがインストールされている必要があります。

Rubyをインストールする

あなたがMacやLinuxマシン上にある場合、あなたはおそらくすでにRubyがインストールされています。 ターミナルを開いて下記のコマンドを入力することでこれを確認できます:

ruby --version

下記のように表示されます:

$ ruby --version
ruby 2.4

Windowsユーザーは、RubyInstallerをRubyのインストールに使用できます。

TwilioのRuby SDKはRubyのバージョン2.0.0から2.4.0まででテストおよびサポートされています。 (旧バージョンをお使いですか? PVMまたはHomebrewを使用してサポートされている最小限のバージョンにアップグレード可能です。

Twilio Ruby ヘルパーライブラリー

twilio-rubyをインストールするもっとも簡単な手段はRubyGemを使用することです。

gem install twilio-ruby


手動インストールまた、twilio-rubyのソースコードをクローンし、そこからライブラリーをインストールできます。

「Permission Denied」
コマンドラインがPermission Denied (権限がありません) といったような文言を含んだ長いエラーメッセージを出力する場合は、sudo gem install twilio-ruby といったように上記のコマンドをsudoを伴い実行してみてください: sudo gem install twilio-ruby。

All set! Let's make that phone call.

Rubyで通話を発信する

Rubyとtwilio-rubyのインストールが済んだので、つい先ほど購入したTwilio電話番号から1回のAPIリクエストで通話を発信できます。 twilio-ruby という名前の新規ファイルを作成し、下記のコードサンプルを入力またはペーストします。

        
        
        
        

        このコードは引数として渡された2つの電話番号間の通話を開始します。 「from」番号は皆さんのTwilio番号で、「to」番号は通話の発信先です。

        URLの引数は、着信側が電話に応答した際にTwilioが次に何を行うべきかを指示するTwiML (=Twilio Markup Language, Twilioマークアップ言語) を指します。 このTwiMLはTwilioに対してテキストToスピーチを使用してメッセージを読み上げ、それからMP3ファイルを再生するよう支持します。

        しかしコードが動作するようになる前に、皆さんのTwilioアカウントで機能するように少々編集が必要です。

        プレースホルダーのクレデンシャル値を置き換える

        account_sidおよびauth_tokenに対応するプレースホルダー値を、お使いのTwilioの認証情報に置き換えます。

        https://jp.twilio.com/console にアクセスしてログインします。 このページ上で、今回のようなTwilio Client経由でメッセージを送信する際に常に必要になる一意のアカウントSIDおよび認証トークンが見つかります。認証トークンは、目玉アイコンをクリックすると表示されます:

        認証トークンを表示する

        make_call.rbを開き、account_sidおよびauth_tokenに対応する値をご使用のアカウントの一意な値に置き換えます。

        ご注意ください: 初めのうちは認証情報をハードコーディングしても構いませんが、本番環境にデプロイするにあたっては、環境変数を使用してこれらが漏洩しないようにしてください。 追加情報については、環境変数の設定方法を参照してください。

        toおよびfrom電話番号を置き換える

        数分前に購入した、音声通話機能対応の電話番号を覚えていますか? どうぞ、既存のfrom番号をご自身の番号に置き換えてください。 また、E.164形式が使用されていることも確認します。

        [+][country code][phone number including area code]

        to電話番号を、ご自身の携帯電話番号に置き換えます。通話の着信が行える電話番号であればどれでも使用できますが、ご自身の電話機を使用すれば魔法のような出来事を目の当たりにできる点で良いアイディアです。上記同様、この値にはE.164形式を使用してください。

        変更を保存し、ターミナルからこのスクリプトを実行します:

        ruby make_call.rb


        これにて以上です! Twilio番号からの通話が着信し、短いメッセージが読み上げられます。😉

        トライアルアカウントをご使用の場合、Twilioで検証済みの電話番号に発信先が制限されます。 電話番号はTwilioコンソール内の検証済み発信者番号にて検証できます。 その他のトライアルアカウントの制限については、無料のTwilioトライアルアカウントの仕組みについてのガイドを参照してください。

        続いて、Twilio電話番号にかかってきた通話に応答する方法を学習しましょう。 まずはSinatraサーバーを用意して起動しておく必要があります。

        やってみましょう!

        Sinatraをインストールし開発環境をセットアップする

        SMSメッセージを受信、またそれに返信するには、受信リクエストを受け入れ可能な軽量のWebアプリケーションを作成する必要があります。 クイックスタートではSinatraを使用しますが、Railsの使用をご希望の場合は、こちらのブログ記事 (英語) で手順がご覧いただけます。。

        まず、下記の内容を含むGemfileが必要になります。

        # Gemfile
        source 'https://rubygems.org'

        gem 'sinatra'
        gem 'twilio-ruby'

        RubyはBundlerを使用して依存関係を管理します。 開発環境にSinatraとTwilio SDKを組み込むために必要なコマンドは bundle install です。 (すでにお使いのコンピューターにBundlerがインストールされていない場合は、 gem install bundler をまず実行することが必要です。)

        $ bundle install
        ...
        Use `bundle show [gemname]` to see where a bundled gem is installed.

        簡単なSinatraアプリケーションを作成する

        簡単なSinatraアプリケーションを作成することで、開発環境が正しく構成されているか確認できます。 Sinatraのドキュメントからサンプルを取得し、これを「quickstart.rb」という名前の新規ファイルにペーストします。

        require 'sinatra'
        require 'twilio-ruby'

        get '/' do
        content_type 'text/xml'

        Twilio::TwiML::VoiceResponse.new do | response |
        response.say('Hello World')
        end.to_s
        end

        続いてruby quickstart.rbコマンドで、新規Sinatra Webアプリケーションの実行を試します。 そしてブラウザーから http://localhost:4567 にアクセスすれば、<?xml version="1.0" encoding="UTF-8"?><Response><Say>Hello World</Say></Response>レスポンスが確認できるはずです。

        準備OK! Twilioはどのように新しいアプリケーションと通信するのでしょうか?

        TwilioからSinatraアプリケーションに通信できるようにする

        ここまでで、メッセージを受信する小規模なSinatraアプリケーションを構築しました。 これが動作するには、アプリケーションがTwilioからアクセスできるようにしておくことが必要です。

        ほとんどのTwilioのサービスはWebhookを使用して皆さんのアプリケーションと通信を行います。 たとえばTwilioに通話が着信すると、通話の処理方法の指示を得ようと、皆さんのアプリケーションのURLにアクセスを行います。

        ご自身の開発環境でSinatraアプリケーションに取り組む際、アプリケーションは同一のコンピューター上の他のプログラム以外からアクセスできないため、Twilioと通信することができません。 アプリケーションをインターネット経由でアクセスできるようにして、この問題を解決することが必要です。

        アプリケーションをHerokuやAWSにデプロイするなど、これを行うには多くの方法がありますが、おそらく皆さんはTwilioアプリケーションのテストにはもっと手間のかからない方法をお探しでしょう。 アプリケーションをインターネット上からアクセスできるようにする軽量な方法として、ngrok. .と呼ばれるツールを推奨しています。 起動すると、ngrok.ioドメインに一意のURLが提供され、着信リクエストがローカルの開発環境に転送されます。

        仕組みは以下のとおりです:

        Twilioがローカルサーバーにアクセスできるようにするために、ngrokがどのように役に立つのか

        まだNgrokを使用していない場合はダウンロードページにアクセスし、お使いのオペレーティングシステム用の適切なバイナリーをダウンロードしてください。 ダウンロードが済んだらパッケージを展開します。 MacまたはLinuxをお使いの場合は、以上で作業はおしまいです。 Windowsをお使いの場合は、Windows上でngrokをインストールおよび構成するガイドに従ってください。 いくつかの素晴らしいヒントや裏技を含むngrokの追加情報については、こちらの詳しいブログ投稿(英語)をご参照ください。

        ngrokのセットアップが済んだら、先に作成したSinatraアプリケーションを起動します:

        ruby quickstart.rb

        お使いのアプリケーションを ローカルで実行してください。 そうしなければngrokが正常に動作しません。

        続いて新規のターミナルタブまたはウィンドウを開いて、下記のコマンドでngrokを実行します:

        ./ngrok http 4567

        4567はSinatraアプリケーションの既定のポート番号です。 ローカルサーバーが異なるポート番号で実行されている場合は、4567を正しいポート番号に置き換えてください。

        下記のような出力がご覧いただけるでしょう。

        ngrokサーバーのターミナル出力

        この出力から公開URLをコピーしブラウザーにペーストします。 問題がなければ、Sinatraアプリケーションの<?xml version="1.0" encoding="UTF-8"?><Response><Say>Hello World</Say></Response> メッセージが表示されるはずです。

        サーバーは外部からアクセスできるようになりました。 通話の着信方法を教えてください!

        Twilioで着信通話に応答する

        Twilio番号に通話の着信があると、TwilioはHTTPリクエストを皆さんのサーバーに送信して次に行うべきことについての指示を問い合わせます。 皆さんのサーバーでリクエストが受信されたら、Twilioに通話への応答方法を指示します。

        このクイックスタートでは、Sinatraアプリケーションに通話に応答させ、発信者に対して短いメッセージを読み上げさせます。 再度quickstart.rbを開いて、下記のコードサンプルのようにコードを更新します:

              
              
              
              
              Twilioからの着信リクエストに、通話の処理方法についての指示を伴って応答する

              着信通話に短いメッセージで応答する

              Twilioからの着信リクエストに、通話の処理方法についての指示を伴って応答する

              Twilioからの着信リクエストに、通話の処理方法についての指示を伴って応答する

              このファイルを保存し、アプリケーションを下記のコマンドで再起動します

              ruby quickstart.rb

              Webブラウザーで http://localhost:4567/answer にアクセスできます。 ページのソース コードを見ると、次のテキストになっているはずです。

              <?xml version="1.0" encoding="UTF-8"?>
              <Response>
              <Say">Thank you for calling! Have a great day.</Say>
              </Response>

              このソースコードはTwilioヘルパーライブラリーの助けを借りた皆さんのコードによって生成されたTwiML XMLです。

              先と同じポートのlocalhostでngrokがまだ実行されていることを再確認します。 これで、Twilioからアプリケーションを見つけられるようになりました。 アプリケーションに電話をかけられるようになる前に、最後にもうひとつだけ必要なことがあります: Twilioにリクエストの送信さきを指示することです。

              WebhookのURLを設定するTwilioにどこを参照して良いか知らせるため、通話の着信時にTwilio電話番号にWebhook URLを呼び出すよう構成することが必要です。

              1. jp.twilio.comにログインし、Consoleの電話番号ページに移動します。
              2. 音声通話機能対応の電話番号をクリックします。
              3. 音声およびFaxセクションを見つけます。「構成内容 (CONFIGURE WITH) 」は既定のまま、すなわち「Webhook/TwiML Bins (など) 」で問題ありません。
              4. 「通話着信時受信時 (A CALL COMES IN) 」を「Webhook」に、それから使用したいURLをペーストします (/answer エンドポイントをお忘れなく!)

              音声通話用の電話番号でWebhookを構成する

              変更点を保存すれば、準備万端です!

              アプリケーションをテストする

              さぁ、お楽しみタイムです。 新しいSinatraアプリケーションをテストしましょう! localhostとNgrokサーバーが起動し実行されている必要があります。 携帯電話からTwilio電話番号に通話を発信しましょう。 ngrokコンソールでHTTPリクエストが確認できるはずです。 皆さんのSinatraアプリケーションは着信リクエストを処理し、TwiMLでレスポンスを返します。 その後通話が接続されると、メッセージが聞こえてきます。

              It worked! All done - what's next?

              関連トピック

              これで、Rubyによる通話の発信と着信通話への応答についての基本が理解できました。

              ここでのSinatraアプリケーションでは、テキストToスピーチを使用して発信者にメッセージを読み上げるTwiML動詞の<Say>のみを使用しましたが、<Record><Gather>、および<Conference>といった他のTwiML動詞を使用してもっと多くのことを行うことができます。以下のページをご覧いただき、さらに理解を深めてください:


              皆さまが何を開発されるのか、目にするのが待ちきれません!

              ヘルプが必要ですか?

              We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.