はじめに
Python + Flask 環境で作成したLinebotで、友達追加時にメッセージを送信する方法が調べてもあまり出てこなかったので、簡単にメモしました。
環境
- python 3.7.12
- Flask 2.0.1
- line-bot-sdk 1.20.0
コード
全体的な流れは次のようになっています。
- Line（クライアント側）で友達追加することで、FollowEventが発生。
- Webhookで指定したURLにFollowEventが発生したことを、Line（クライアント側）からBotインスタンスにPOSTリクエストを送ることで通知。
- FollowEvent発生時の処理が行われる。
細かい処理はコメント文を見てみてください。
# linebot友達追加時のみメッセージを送信
from flask import Flask, request, abort
from linebot import (
LineBotApi, WebhookHandler
)
from linebot.exceptions import (
InvalidSignatureError
)
# linebot.modelsから処理したいイベントをimport
from linebot.models import (
FollowEvent, TextSendMessage # FollowEventをimportするのを忘れずに！
)
import os
# Flaskクラスのインスタンスを生成
## __name__: 自動的に定義される変数で、現在のファイルのモジュール名が入る。
## ファイルをスクリプトとして実行した場合、__name__ は __main__ となる。
app = Flask(__name__)
# 環境変数取得
YOUR_CHANNEL_ACCESS_TOKEN = os.environ["YOUR_CHANNEL_ACCESS_TOKEN"]
YOUR_CHANNEL_SECRET = os.environ["YOUR_CHANNEL_SECRET"]
# インスタンス生成
line_bot_api = LineBotApi(YOUR_CHANNEL_ACCESS_TOKEN)
handler = WebhookHandler(YOUR_CHANNEL_SECRET)
# app.route("/"): appに対して / というURLに対応するアクションを登録
@app.route("/callback", methods=['POST'])
def callback():
# get X-Line-Signature header value
## Lineから送られたメッセージかどうかを確認するための著名を取得 =
## X-Line-Signatureリクエストヘッダに含まれる著名を検証して、
## リクエストがLineプラットフォームから送信されたことを確認
signature = request.headers['X-Line-Signature']
# get request body as text
body = request.get_data(as_text=True)# postされたデータをそのまま取得（HTTPリクエストメッセージボディ）
app.logger.info("Request body: " + body)# ログ処理（記録）
# handle webhook body
try:
handler.handle(body, signature)
except InvalidSignatureError:# signatureエラー（Lineから送られたメッセージでない場合）
abort(400)# abort(): flaskの関数で、httpステータスとメッセージを指定可能
# ステータスコード400: Bad request. クライアント側のエラーにより、サーバ側がリクエストを処理できない時に使用。
return 'OK'
# handler.add(): 引数にlinebotのリクエストのイベントを指定
@handler.add(FollowEvent)# FollowEventをimportするのを忘れずに！
def follow_message(event):# event: LineMessagingAPIで定義されるリクエストボディ
# print(event)
if event.type == "follow":# フォロー時のみメッセージを送信
line_bot_api.reply_message(
event.reply_token,# イベントの応答に用いるトークン
TextSendMessage(text="フォローありがとうございます！"))
if __name__ == "__main__":
port = int(os.getenv("PORT", 5000))
# Flaskが持っている開発ようサーバーの起動
app.run(host="0.0.0.0", port=port)
まとめ
テキストメッセージを送るだけなどの簡単なメッセージを送りたい場合、LineDeveloperコンソールであいさつメッセージを設定する方が早いです。少し複雑な処理が入る場合は、上記のコードをベースに実装できると思います。
また、Webhook Eventは、FollowEvent以外にも色々あるので、参考のLineの公式ドキュメントを見てみてください。
何か、間違いがあれば、ご指摘お願いします。