Programmable SMS クイックスタート for Java

Ready to start sending and receiving text messages with Twilio Programmable SMS using Java?

This Programmable SMS Quickstart for Java will teach you how to do this using the Twilio Java helper library for our Communications REST API.

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

1. Twilioにサインアップして、SMS機能を持ったはじめてのTwilio電話番号を入手する
2. メッセージを送受信できるように開発環境をセットアップする
3. 最初のSMSを送信する
4. テキストメッセージを受信する
5. 受信メッセージに対してSMSで返信する

ビデオを見ながらの入門がお好みですか？ YouTube上のJava SMSクイックスタートビデオ（英語）をご覧ください。

Twilioにサインアップし電話番号を入手する

Before you can send an SMS from Java, you'll need to sign up for a Twilio account or sign into your existing account and purchase an SMS-capable phone number.

If you don't currently own a Twilio phone number with SMS functionality, you'll need to purchase one. After navigating to the Buy a Number page, check the "SMS" box and click "Search."

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

これでTwilioアカウントと、プログラム可能な電話番号の用意ができたので、コードを書き始める事ができます！ さらに物事を簡単にするため、Java環境をセットアップして、それからJavaアプリケーション用のTwilioの公式ヘルパーライブラリーをダウンロードします。

Java環境をセットアップする

To send your first SMS, you’ll need to have the Java Standard Edition (SE) Development Kit (JDK) installed - if you don't know if you have the JDK installed, run the following command to see what version you have:

javac -version

下記の出力のようになります:

javac 1.8.0_92

Twilio SDKにはSE 7以降が必要です。 これはバージョン番号「1.7」以上として、あるいは上記のコマンドを実行時に表示されます。

If you have an older version of Java or no JDK at all, you'll need to install the JDK before going any further. Follow the directions for installing the Java SE Development Kit for your platform (Windows, Mac, Linux) from the Java SE Download Page.

スタンドアローンのTwilio Javaヘルパーライブラリーをダウンロードする

Javaのセットアップがすべて完了して先に進む準備ができましたか？ お見事！

Next, download the standalone Twilio Java Helper Library. With that library, you'll have Java classes that help you call out to Twilio API's using Java, along with all the other dependencies you'll need to get going. We'll be using this "fat jar" file with all the dependencies in this SMS Quickstart. When you download the fat jar file, download the one with a name similar to twilio-7.x-jar-with-dependencies.jar.

Prefer to use Maven, Gradle, or another build tool? The Twilio Java Helper Library docs have information on how to install using a build automation tool.

JavaでSMSメッセージを送信する

これでJDKとTwilio Javaヘルパーライブラリーがインストールできたので、今しがた購入したTwilio電話番号から、1回のAPIリクエストでSMSを送信できます。 SmsSender.javaという名前の新規ファイルを作成して開き、下記のコードサンプルを打ち込むかペーストします。

メッセージの送信前に、このファイルを少々編集する必要があります:

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

Swap the placeholder values for ACCOUNT_SID and AUTH_TOKEN with your personal Twilio credentials. Go to https://www.twilio.com/console and log in. On this page, you’ll find your unique Account SID and Auth Token, which you’ll need any time you send messages through the Twilio Client like this. You can reveal your auth token by clicking on the eyeball icon:

SmsSender.javaを開き、ACCOUNT_SIDおよびAUTH_TOKENに対応する値をご使用のアカウントの一意な値に置き換えます。

「From」電話番号を置き換える

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

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

「To」電話番号を置き換える

Replace the to phone number with your mobile phone number. This can be any phone number that can receive text messages, but it’s a good idea to test with your own phone so you can see the magic happen! As above, you should use E.164 formatting for this value.

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

メッセージを受信、返信を行う

When your Twilio number receives an incoming message, Twilio will send an HTTP request to a server you control. This callback mechanism is known as a webhook. When Twilio sends your application a request, it expects a response in the TwiML XML format telling it how to respond to the message.

Spark Webアプリケーションフレームワークを使用して、Javaでこれをビルドする方法を見ていきましょう。 Sparkは軽量なWebアプリケーションフレームワークであり、ビッグデータソフトウェアのApache Sparkとは全く異なるものです。

Spark requires its own library, separate from the Twilio Java helper library, which you can install using the directions on the Download Spark Java page. You'll find directions for using Spark with Maven, Gradle, or as a standalone download. Spark does not come with a logging implementation, but it does work with the Simple Logging Facade 4 Java (SLF4J), which you can also include in your Java classpath.

上記でTwilioを使用しSMSを送信した時点で、ここの解説のようにコマンドライン上ですべての依存関係のセットアップが済んでいることでしょう。 しかしJavaの統合開発環境 (IDE=Integrated Development Environment) を使用するとセットアップ全過程が少しだけ、より簡単になります。 ここではJetBrainsからダウンロード可能な、IntelliJ IDEAの無料のCommunity Editionを使用します。 IntelliJ IDEAで直接JARファイルをダウンロード、使用できるほか、MavenやGradleのような依存関係マネージャーを使用することもできます。 今回のアプリケーションのビルドには、IntelliJ IDEAをGradleと組み合わせて使用することにします。

IntelliJ IDEAおよびGradleを使用してWebアプリケーションを作成する

IntelliJ IDEA Community Editionをまだダウンロード、インストールしていない場合は、どうぞ行なってください！ 初回にIDEAを実行すると、下記のような画面が表示されます:

Choose 'Create New Project,' and the new New Project wizard will start:

ダイアログボックスの左側で、 (Javaではなく) Gradleを選択すると、IntelliJ IDEAは依存関係の管理にGradleを使用するようプロジェクトをセットアップします。 ここでは代わりにMavenを選択することもできます。 手順はほぼ同じです。

Gradleの選択後、IntelliJ IDEAにプロジェクトSDK (Java 8以降、すなわちバージョン1.8以上が必要です) があることを確認し、Nextをクリックします。

ウィザードの次の画面では、group id、artifact id、そしてversion numberが尋ねられます。 group idには、com.yourcompany.sms といったようなリバースドメイン名が使用できます。 またartifact idには、sms-quickstart-app のようなプロジェクト名を使用してください。 version は 1.0-SNAPSHOTのままで構いません。 これらのフィールドの入力が済んだら、Nextをクリックします。

Gradle設定画面では、既定値のままでNextをクリックします。

最後に、クイックスタートWebアプリケーションに使用するプロジェクト名とプロジェクトディレクトリーを確認します。 こちらも同様に、既定値のままで問題ありません。 Finishをクリックすると、新規のIntelliJプロジェクトが表示されます。 IntelliJ IDEAをインストールしたばかりの場合は、IDEはGradleをダウンロードし、セットアップとインストールがいくつか行われます。

これでプロジェクト設定がすべて完了しました。 残る手順はあと少しです！ 依存関係としてTwilio JavaヘルパーライブラリーとSpark Java Webアプリケーションフレームワークが必要になります。 またSparkからのステータスメッセージを表示できるようにするためのログ記録の実装も必要です。 これらをGradleを使用して、IntelliJによって作成されたbuild.gradleに追加できます。 さぁ、サイドバーでbuild.gradleを探しクリックして開いてください。

build.gradleに依存関係を追加する

build.gradleファイルのdependenciesグループに下記の行を追加することが必要です:

compile group: "com.twilio.sdk", name: "twilio", version: "7.17.+"
compile group: "com.sparkjava", name: "spark-core", version: "2.7.1"
compile group: "org.slf4j", name: "slf4j-simple", version: "1.7.21"

With these three dependencies, Gradle will download the appropriate libraries for you and add them to the classpath for building and running your Java application.

これでひととおり作業が完了したので、これからコーディングを少し行いましょう！

受信テキストメッセージに返信する

We'll need to start by creating a Java class in our project. In IntelliJ IDEA, select the java folder under src and main. Next, open the File menu at the top of the screen. Choose the New submenu, and then Java Class.

小さいポップアップウィンドウが表示され、新規クラスを作成できます。 クラスに SmsApp という名前をつけます。 大文字と小文字の区別は重要です。 これらがコードサンプルと一致している必要があるためです。

SmsApp.javaソースコードファイルが確認できるはずです。 コードサンプルからこのソースコードファイルにコードサンプルからコードをコピー&ペーストを使用します。

このJavaコードは「/」への受信HTTP GETリクエストをリッスンし、また「/SMS」への受信HTTP POSTリクエストもリッスン、SMSメッセージに対するTwiMLマークアップでレスポンスを返します。

ngrokを使用してTwilioがJavaアプリケーションと通信できるようにする

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

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

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

While there are a lot of ways to do this, like deploying your application to Heroku or AWS, you'll probably want a less laborious way to test your Twilio application. For a lightweight way to make your app available on the internet, we recommend a tool called ngrok. Ngrok listens on the same port that your local web server is running on and provides a unique URL on the ngrok.io domain, forwarding incoming requests to your local development environment. It works something like this:

If you haven't already, install ngrok. Make sure it's the ngrok version that’s appropriate for your operating system and take care that the 'ngrok' command is on your system path. If you're working on a Mac or Linux, you're all set. If you're on Windows, follow our guide on how to install and configure ngrok on Windows. For more info on ngrok, including some great tips and tricks, check out this in-depth blog post.

これで、外部からアクセスできるURLを用意できました。

WebhookのURLを設定する

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

1. jp.twilio.comにログインし、Console上の電話番号ページに移動します
   
2. SMS機能対応の電話番号をクリックします。
3. メッセージの送受信セクションを見つけます。 「構成内容」は、既定である「Webhook/TwiML」のままでかまいません。
4. In the “A MESSAGE COMES IN” section, select "Webhook" and paste in your URL: in this quickstart step above, it would be: https://aaf29606.ngrok.io/sms - be sure to add '/sms' at the end.

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

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

Make sure you are running your 'ngrok' command on the command line, and running your web application from IntelliJ IDEA. If you restarted ngrok, you will have to update your webhook in the console to use the right url.

上記の両方のサーバーの実行により、いよいよお楽しみの準備が整いました。 新しいJava Webアプリケーションをテストしましょう！

Send an SMS from your mobile phone to your Twilio phone number that's configured with this webhook. You should see an HTTP request with a 200 OK in your ngrok console. Your Java web application will process the text message, and you’ll get your response back as an SMS.

関連トピック

Javaを使用したメッセージ送受信の基本について理解できたところで、下記の資料について調べてみるのも良いかもしれません。

• Messaging API documentation
• TwiMLリファレンス・ドキュメント
• Java用の完全なサンプルアプリケーションを含むチュートリアル
• 0 to 60 with Java – Sending an SMS in a Minute (英語)

楽しいプログラミングを！