LINE Messaging API触ってみる
himawarichan【目標】
公式アカウントからMessaging APIでメッセージを送る。できればFlexMessageを送ってみたい。
メッセージ以外にも面白そうな機能あったら寄り道するかも。
【環境】
Laravel 8.83.14 ※laradockで構築済み
mysql 8.0.28
himawarichanLINE Business IDを作って公式アカウント作成
himawarichan設定 > Messaging APIからDeveloperアカウント？作成する。
名前とメールアドレスを入力し、プロバイダーを作る。プロバイダーは後から変更できないとのこと。
完了するとChannel IDとChannel secretが発行された
himawarichan
チャネルを作成するとのことだが、プロバイダーを作った時点でプロバイダーと同じ名前のチャネルを作ってくれていたのでスキップ
himawarichanWebhookURLはSSL化が必須とのこと。
ドキュメントだとHerokuを使った例があるが、ngrokというツールを使ってローカル環境をSSL化し公開してみる。
himawarichanngrok導入手順
- 下記からサインアップ
https://ngrok.com/ - ログイン後setup手順に従ってセットアップする。winなのでexeダウンロードし、認証を行う
- コマンドプロンプトからexeが置いてある場所へ移動し、そこでngrokコマンドを実行
ローカル環境はvirtualhost設定してるので、--host-headerオプションを付けてこんな感じのコマンド実行した
ngrok http --host-header=rewrite hogehoge.local:80
参考：
ちょっと困ったのが、exeを直接実行したらコマンドプロンプトが立ち上がったのでそこでngrokコマンドを実行するものだと思い、実行したらエラー落ちしてしまった。
しかもこの時ngrokの起動はできていて、改めてコマンドプロンプトから実行するとエラーが起きる（無課金だと1セッションまでしか使えない）
本来、ngrokを終了する場合はctr+cで処理を終了する形なのだが、異常終了しているためそれもできない。
どうしようもなかったのでtaskkikllコマンドで強制終了させた。停止コマンドとかないのか…。
管理画面から終了しようにも無料だとダメだと怒られるし、公式ドキュメントにも検索機能ないから調べにくいし……便利なのか不便なのか……。
himawarichanメッセージを送ったらそのメッセージをおうむ返しするbotを作ってみる。
「メッセージを送るなどでWebhookイベントが発火→WebhookURLに設定したURL（API）へリクエスト 」の流れ
アクセストークンとチャネルシークレットは.envに記載し、config/service.php経由で呼び出す。
チャネルシークレットなどの作成は下記参考。
ルーティング設定
Route::prefix('line')->group(function () {
Route::post('webhook', [App\Http\Controllers\Line\WebhookController::class, 'webhook'])->name('api.line.webhook');
});
コントローラーに実装
use LINE\LINEBot\HTTPClient\CurlHTTPClient;
use LINE\LINEBot;
class WebhookController extends Controller
{
public function webhook(Request $request)
{
$httpClient = new CurlHTTPClient(config('services.line.access_token'));
$bot = new LINEBot($httpClient, ['channelSecret' => config('services.line.chanel_secret')]);
Log::debug($request->all());
$request->collect('events')->each(function ($event) use ($bot) {
$bot->replyText($event['replyToken'], $event['message']['text']);
});
return;
}
どういうリクエストが来るのかドキュメント読んでてもわからなかったので、ログに出した。
（トークンやID系は伏せとく）
[2022-06-13 16:39:55] local.DEBUG: array (
'destination' => '<destination>',
'events' =>
array (
0 =>
array (
'type' => 'message',
'message' =>
array (
'type' => 'text',
'id' => '<id>',
'text' => 'てすてす',
),
'webhookEventId' => '<webhookEventId>',
'deliveryContext' =>
array (
'isRedelivery' => false,
),
'timestamp' => 1655105989419,
'source' =>
array (
'type' => 'user',
'userId' => '<userId>,
),
'replyToken' => '<replyToken>',
'mode' => 'active',
),
),
)
webhookイベントにはこういうのがある。
ユーザーからメッセージが送られた時にメッセージを返したいのでその処理を追加。
またメッセージも画像などテキスト以外が送られた場合にはおうむ返しはしないよう修正。
他色々直したのがこれ。request取得時コレクションにしていたが、配列で扱うように変更してる（そっちの方が個人的に慣れているので）
public function webhook(Request $request)
{
//webhookのイベントの種類がmessage以外であれば何もしない
$request_params = $request->input('events.0');
if($request_params['type'] !== 'message'){
return;
}
$httpClient = new CurlHTTPClient(config('services.line.access_token'));
$bot = new LINEBot($httpClient, ['channelSecret' => config('services.line.chanel_secret')]);
//メッセージがテキストだったらおうむ返し
if($request_params['message']['type'] === 'text'){
$bot->replyText($request_params['replyToken'], $request_params['message']['text']);
}else{
$bot->replyText($request_params['replyToken'], 'テキストを送ってください。');
}
return;
}
今更だが、Messageing APIでメッセージを送るパターンは二つ
- 応答メッセージ
ここまでやったようにユーザーからメッセージが送られてきたなど、何かのアクションが発生した時にメッセージを送るパターン。 - プッシュメッセージ
ユーザーからのアクションの有無にかかわらず、任意のタイミングでメッセージを送る。
ここからはプッシュメッセージを実装してみようと思う。
※余談
プッシュメッセージは有料プランでないと送れない～みたいな記述を見かけたが、今はそんなことはないらしい。
ただ送る人数分月の通数にカウントされてしまうので注意。今回はテストアカウントで友達登録も1～2人なので大丈夫でしょう。