LINE Bot を Bot Framework Composer でローコード開発する : その 6 返信以外の Messaging API 呼び出し

前回はユーザーから画像が送られてきた場合の対応と、外部サービスとの連携について見ていきました。今回は外部サービスとして Messaging API を直接呼び出す場合について見ていきます。

返信以外の Messaging API

Messaging API の基本はユーザーからのメッセージに返信する事ですが、それ以外にも多くの事ができます。

• プッシュメッセージの送信
• ボットを追加したユーザーの数を取得
• ユーザーのプロフィール取得
• ユーザー単位のリッチメニュー操作、等

機能はどんどん追加されていくので、Messaging API リファレンス や ニュース で最新情報を確認してください。

プッシュメッセージの送信

メッセージを送ってきたユーザー以外にメッセージを送る場合、プッシュ通知を利用します。尚、プッシュ通知はプランによって制限があります。

今回は挨拶ダイアログのフローで、ユーザーが熱があった場合に管理者に通知するようにしてみます。

プッシュメッセージの仕様確認

プッシュメッセージを送る によると POST で https://api.line.me/v2/bot/message/push に対して以下内容を送信すると通知ができます。

{
    "to": "U4af4980629...",
    "messages":[
        {
            "type":"text",
            "text":"Hello, world1"
        },
        {
            "type":"text",
            "text":"Hello, world2"
        }
    ]
}

ヘッダーは Content-Type と Authorization であるため、Postman で確認してみます。

1. LINE の開発者コンソール よりチャネルトークンとユーザーの ID を確認。
Messaging API 設定より

チャネル基本設定より

2. Postman を起動。POST を選択し、URL とヘッダーを設定。

3. Body に送信するメッセージを設定。

4. 送信を実行して LINE クライアントで受け取れることを確認。

プッシュメッセージ機能の追加

プッシュメッセージの送り方は分かったので、フローの追加します。

1. HelloDialog の BegingDialog トリガーを開き、体調を聞いている個所を確認。

2. ユーザーからの回答の直後に If/Else ブランチを追加。条件で user.healthCondition == 'とても悪いです'　を指定。

3. True ブランチに HTTP 要求を追加。

4. Http メソッド、アドレスを指定。またボディは以下のように設定。

• settings は設定情報を取得する変数。line 以降の設定は後で追加

{
    "to": "${settings.line.adminUserId}",
    "messages":[
        {
            "type":"text",
            "text":"体調の悪いユーザーがいます"
        }
    ]
}

5. ヘッダーを以下のように設定。

• Content-Type: application/json
• Authorization: Bearer ${settings.line.accesstoken}

6. Settings メニューより「Show keys」をオンにして編集モードにする。

7. 以下の line 設定を既存の項目の下に追加。

テスト

ボットを再起動して、LINE クライアントからテスト。管理者と同じユーザーでテストしたため少し分かりずらいですが、最後のメッセージはプッシュメッセージで来たものです。

ユーザープロフィールの取得

今のままでは誰の調子が悪いか分からないため、ユーザープロフィールより名前をとってみます。

プロフィール取得の仕様確認

プロフィールの取得 を見ると、GET で https://api.line.me/v2/bot/profile/{userId} に送ることでデータを取得できそうです。

こちらも Postman で確認しておきます。

プロフィール取得機能の追加

プロフィールは更新される可能性はありますが、通常はボットを友達追加した時に取得しておくのが効率がいいです。よって今回も友達追加のタイミングでプロフィールを取ります。

1. メインダイアログより Greeting トリガーを開く。このトリガーはユーザーが友達追加をしたタイミングでトリガーされる。

2. 既定で会話に参加したのがユーザーかボットかを区別するロジックがあるため、if/else の True ブランチに HTTP 要求を追加。メソッドに GET を指定し、Url に https://api.line.me/v2/bot/profile/${dialog.foreach.value.id} を追加。

• dialog.foreach.value: Foreach でループされたアイテムが格納される

3. ヘッダーに認証情報を追加。また結果を dialog.response に格納。

• Authorization: Bearer ${settings.line.accesstoken}

4. 次に「Manage properties」より「Set a property」アクションを追加。

5. user.name プロパティに =dialog.response.content.displayName を設定。

• dialog.response.content にプロフィールの結果が入るため、それを user.name にコピー

6. 最後に応答の送信を追加して、挨拶を指定。

テスト

LINE クライアントより一旦ボットを削除し、再度友達追加することでテストできます。

プッシュメッセージの変更

名前が取れるようになったので、プッシュメッセージでも活用します。先ほど追加したプッシュメッセージの中身を変更します。

{
  "to": "${settings.line.adminUserId}",
  "messages": [
    {
      "type": "text",
      "text": "${user.name}さんの体調が悪いようです"
    }
  ]
}

LINE クライアントから確認します。ここでも管理者ユーザーで試したため分かりずらいですが、最後のメッセージはプッシュメッセージ送られてきたものです。他のユーザーで試した場合、管理者には最後の通知のみが届きます。

まとめ

今回は返信以外の機能の使い方を見ていきました。Messaging API には多くの機能があり連携すればするほど高度なボットが開発できます。色々試してください。