Twilio Connector - Mule 4

サポートカテゴリ: 選択

Twilio Connector v3.0

Twilio 用 Anypoint Connector (Twilio Connector) は、クラウド通信 IaaS (Infrastructure as a Service) です。

Twilio プラットフォームは、テキストメッセージング、VoIP、および音声通話を行うための API として機能します。Twilio Connector は、Twilio テキストメッセージング API との接続を可能にします。

このコネクタは、テキストメッセージの送受信用の API を提供します。Twilio を使い始めるには、下記の手順に従って、SMS テキストメッセージを送信するための無料の Sandbox サービスにアクセスしてください。Anypoint Studio では、自分の API ログイン情報を使用して Twilio Connector を設定できます。

リリースノート: Twilio Connector リリースノート
Exchange: Twilio Connector

前提条件

この情報を使用するには、Twilio、Mule Runtime Engine (Mule)、Anypoint Connector、Anypoint Studio、Mule の概念、Mule フローの要素、グローバル要素に精通している必要があります。

対象リソースへの接続をテストするには、ログイン情報が必要です。

ソフトウェアの要件および互換性情報については、「コネクタリリースノート」を参照してください。

Twilio Connector を使用するには、アクティブな Twilio.com アカウント (トライアル版または有料版) が必要です。Twilio アカウントを作成するには、Try Twilio (Twilio を試す) の Web サイト (​https://www.twilio.com/try-twilio​) にアクセスします。

POM ファイルの連動関係の追加

Apache Maven ​pom.xml​ ファイルは Anypoint Studio によって生成され、Mule アプリケーションの連動関係が含まれます。Mule アプリケーションを手動でコーディングする場合、次の XML スニペットを ​pom.xml​ ファイルに含めてこのコネクタにアクセスできるようにします:

<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-twilio-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>

x.x.x​ を使用しているコネクタに対応するバージョンに置き換えます。

最新の ​pom.xml​ ファイル情報を取得する手順は、次のとおりです。

  1. Anypoint Exchange​ に移動します。

  2. Exchange で、​[Login (ログイン)]​ をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。

  3. Exchange で、「​twilio​」を検索します。

  4. コネクタを選択します。

  5. 画面の右上付近にある ​[Dependency Snippets (連動関係スニペット)]​ をクリックします。

新しい Twilio アカウントの作成

  1. Try Twilio (Twilio を試す) の Web サイト (​https://www.twilio.com/try-twilio​) にアクセスします。

  2. サインアップして [Start your free trial (無料トライアルを開始)] をクリックします。

    無料の開発者アカウントでは、テキストメッセージを送信するための SMS に対応したスマートフォンでの確認が必要です。

  3. スマートフォンの電話番号を入力するにように促されたら、入力します。指示に従って電話番号を確認します。自動テキストメッセージと認証コードが送られて来ます。

  4. 認証コードを入力すると、Twilio のメイン画面が表示されます。

  5. [Account SID (アカウント SID)] と [Auth Token (認証トークン)] の値 ([Show (表示)] をクリックすると表示されます) をメモし、ログイン情報を後で Anypoint Studio の Twilio Connector 設定メニューで使用するためにコピーしておきます。

    ヒント: Twilio の Web サイトから Anypoint Studio Connector 設定に項目をコピーする際には、前後にある余計な文字やスペースも一緒にコピーしてしまわないように注意してください。コピーして貼り付ける際に、前後の文字が含まれていないことを目で確認するのがよいでしょう。

  6. 左上にある [B] をクリックし、[Phone Numbers (電話番号)] > [Manage Numbers (番号の管理)] をクリックします。

  7. [Get Started (使用開始)] をクリックします。

  8. [Get your first Twilio phone number (最初の Twilio 電話番号を取得)] をクリックします。Twilio が選択した電話番号が表示されます。この番号は後で使用しますので、コピーしておきます。

Design Center での接続

  1. Design Center で [Create (作成)] をクリックして [Mule Application (Mule アプリケーション)] を選択します。

  2. HTTP リスナーやスケジューラートリガーなどのトリガーをクリックします。

    トリガーオプション
  3. コネクタの HTTP グローバル要素を作成するには、次の項目を設定します。

    HTTP リスナーの設定
    項目 説明

    Protocol (プロトコル)

    HTTP Connector のプロトコル。HTTP または HTTPS (セキュア) を選択できます。

    Host (ホスト)

    Mule アプリケーションが要求をリスンする IP アドレス。

    Port (ポート)

    Mule アプリケーションが要求をリスンするポートアドレス。

    Base Path (ベースパス)

    Mule アプリケーションが要求をリスンするパス。

  4. プラス記号を選択して、コンポーネントを追加します。

    コネクタの追加
  5. Twilio Connector をコンポーネントとして選択します。

  6. 操作を選択します。

    操作コネクタ
  7. コネクタのグローバル要素を設定します。

    コネクタの設定
    項目 説明

    Protocol (プロトコル)

    HTTP Connector のプロトコル。HTTP または HTTPS (セキュア) を選択できます。

    Host (ホスト)

    Mule アプリケーションが要求をリスンする IP アドレス。

    Port (ポート)

    Mule アプリケーションが要求をリスンするポートアドレス。

    Base Path (ベースパス)

    Mule アプリケーションが要求をリスンするパス。

    Username (ユーザー名)

    Twilio API にアクセスするためのユーザー名 (アカウント SID)。

    Password (パスワード)

    Twilio API にアクセスするためのパスワード (認証トークン)。

Studio プロジェクトへのコネクタの追加

Anypoint Studio には、Studio プロジェクトにコネクタを追加する 2 つの方法があります。Studio タスクバーの Exchange ボタンから追加するか、[Mule Palette (Mule パレット)] ビューから追加します。

Exchange を使用してコネクタを追加する

  1. Studio で Mule プロジェクトを作成します。

  2. Studio タスクバーの左上にある Exchange アイコン ​(X)​ をクリックします。

  3. Exchange で、​[Login (ログイン)]​ をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。

  4. Exchange で、「twilio」を検索します。

  5. コネクタを選択して ​[Add to project (プロジェクトに追加)]​ をクリックします。

  6. 画面の指示に従ってコネクタをインストールします。

Studio でコネクタに追加する

  1. Studio で Mule プロジェクトを作成します。

  2. [Mule Palette (Mule パレット)] ビューで、​[(X) Search in Exchange ((X) Exchange 内を検索)]​ をクリックします。

  3. [Add Modules to Project (モジュールをプロジェクトに追加)]​ で、検索項目に「twilio」と入力します。

  4. [Available modules (使用可能なモジュール)]​ で、このコネクタの名前をクリックします。

  5. [Add (追加)]​ をクリックします。

  6. [Finish (完了)]​ をクリックします。

Studio で設定する

  1. コネクタを Studio キャンバスにドラッグします。

  2. Configure the global element for the connector.

    項目 説明

    Protocol (プロトコル)

    HTTP Connector のプロトコル。HTTP または HTTPS (セキュア) を選択できます。

    Host (ホスト)

    Mule アプリケーションが要求をリスンする IP アドレス。

    Port (ポート)

    Mule アプリケーションが要求をリスンするポートアドレス。

    Base Path (ベースパス)

    Mule アプリケーションが要求をリスンするパス。

    Username (ユーザー名)

    Twilio API にアクセスするためのユーザー名 (アカウント SID)。

    Password (パスワード)

    Twilio API にアクセスするためのパスワード (認証トークン)。

  3. 操作を選択します。

    • Delete Media

    • Delete Message

    • Get Media

    • Get Media List

    • Get Message

    • Get Message List

    • Redact Message

    • Send Message

これらの項目では操作を指定できます。

項目 説明

Account Sid (アカウント SID)

このメッセージを送信したアカウントの一意の ID

Date Created (作成日付)

リソースが作成された日付

Media Sid (メディア SID)

メディアの一意の ID

Message Sid (メッセージ SID)

メッセージの送信後に生成されたメッセージの一意の ID

Date Sent (送信日付)

メッセージが Twilio から送信された日付 (RFC 2822 形式)

From (送信元)

メッセージを送信した電話番号または送信者 ID (E.164 形式)

To (宛先)

メッセージを受信した電話番号 (E.164 形式)

各形式についての詳細は、このドキュメントの最後にある「関連情報」セクションを参照してください。

次の例では、Mule アプリケーションから特定の電話番号にメッセージを送信してから編集しています。この例では、Twilio ログイン情報と、SMS が送信される電話番号の代わりに変数を使用しています。

事前手順

次の手順に従って、項目値のプロパティプレースホルダーを使用します。

  1. Studio で新しい Mule プロジェクトを作成します。

  2. 次のプロパティを YAML または XML ファイルに追加します。

    config.accountSid=<Your account SID>
    config.authToken=<Your authentication token>
    config.fromNumber=<The phone number from which the SMS is sent, as configured inside the Twilio instance>
  3. プロジェクトの ​src/main/resources​ フォルダーにファイルを置きます。

  4. 「プロパティ値のプロパティプレースホルダーの使用」​の説明に従って、コネクタ設定でこのファイルを参照します。

Mule アプリケーションを設定する

次の手順に従って、この例の Mule アプリケーションを設定します。

  1. [HTTP Listener]​ 操作を Studio キャンバスにドラッグし、そのパスを ​/send/{toNumber}​ に設定します。

  2. Transform Message​ コンポーネントを ​[Listener]​ の右にドラッグして、DataWeave を使用して Twilio Connector 用の入力を準備します。

    %dw 2.0
    output application/java
    ---
    {
        Body: "You are now subscribed!",
        From: p('fromNumber'),
        To: "+" ++ attributes.uriParams.toNumber as String default "my default value"
    }
  3. Twilio の ​[Send Message]​ 操作を ​Transform Message​ コンポーネントの右にドラッグして、​[Account Sid (アカウント SID)]​ 項目を ​${accountSid}​ に設定します。

  4. Set Variable​ コンポーネントを ​Transform Message​ コンポーネントの右にドラッグして、次の項目を設定します。

    • [Name (名前)]​ 項目を ​messageSid​ に設定します。

    • [Value (値)]​ 項目を `#[payload.sid] に設定します。

  5. Transform Message​ コンポーネントを ​Set Variable​ の右にドラッグして、​Redact Message​ 操作用の入力を作成します。

    %dw 2.0
    output application/java
    ---
    {
        Body: "",
        From: payload.from,
        To: payload.'to'
    }
  6. Twilio の ​[Redact Message]​ 操作を ​Transform Message​ コンポーネントの右にドラッグして、次の項目を設定します。

    • [Account Sid (アカウント SID)]​ 項目を ​${accountSid}​ に設定します。

    • [Message Sid (メッセージ SID)]​ 項目を ​#[messageSid]​ (ステップ 5 で保存した変数) に設定します。

  7. Transform Message​ コンポーネントを ​[Redact Message]​ の右にドラッグして、出力を ​application/json​ に設定します。

    %dw 2.0
    output application/json
    ---
    payload
  8. アプリケーションを実行し、ブラウザーで ​http://localhost:8081/send/{toNumber}​ を開きます (​toNumber​ は Twilio から取得した電話番号に置き換えてください)。