メッセージ（Webhook）を受信する

# メッセージ（Webhook）を受信する

ユーザーが、LINE公式アカウントを友だち追加したり、LINE公式アカウントにメッセージを送ったりすると、LINE Developersコンソールの「Webhook URL」に指定したURL（ボットサーバー）に対して、LINEプラットフォームからWebhookイベントオブジェクトを含むHTTP POSTリクエストが送られます。

ボットサーバーがWebhookイベントオブジェクトを適切に処理していることを確認してください。なお、ボットサーバーがWebhookの受信に長期間失敗している場合、LINEプラットフォームからボットサーバーへのWebhookの送信を停止する可能性があります。

セキュリティ上の警告

ボットサーバーが受信したHTTP POSTリクエストは、LINEプラットフォームから送信されていない危険なリクエストの可能性があります。必ず署名を検証してから、Webhookイベントオブジェクトを処理してください。

イベントは非同期で処理することを推奨します

現在のリクエストが処理されるまで後続のリクエストが待たされるのを防ぐため、Webhookイベントは非同期で処理することを推奨します。

# 署名を検証する

ボットサーバーがリクエストを受信したら、リクエストの送信者を確認します。LINEプラットフォームからのリクエストであることを確認するには、ボットサーバーでリクエストヘッダーのx-line-signatureに含まれる署名を検証します。

リクエストボディのダイジェストを計算します。チャネルシークレットを秘密鍵としてHMAC-SHA256アルゴリズムを使用します。
ダイジェストをBase64エンコードし、リクエストヘッダーのx-line-signatureに含まれる署名と一致するかどうかを確認します。

Python®で署名の検証する例は以下のとおりです。

import base64
import hashlib
import hmac

channel_secret = '...' # Channel secret string
body = '...' # Request body string
hash = hmac.new(channel_secret.encode('utf-8'),
    body.encode('utf-8'), hashlib.sha256).digest()
signature = base64.b64encode(hash)
# Compare x-line-signature request header and the signature

詳細とコードサンプルについては、『Messaging APIリファレンス』の「署名を検証する」を参照してください。

# Webhookイベントのタイプ

Webhookイベントオブジェクトに含まれるデータに基づいて、ボットがどのように反応するかを制御できます。また、ボットに何かアクションを起こさせたり、ユーザーに応答させることもできます。トーク、LINE Things、ビーコン、アカウント連携のWebhookイベントを取得できます。詳しくは、『Messaging APIリファレンス』の「Webhookイベントオブジェクト」を参照してください。

# トークでのWebhookイベント

1対1のトーク、およびグループトークと複数人トークにおいて、ボットサーバーが受信するWebhookイベントは以下のとおりです。

Webhookイベント	受信するタイミング	1対1のトーク	グループトークと複数人トーク
メッセージイベント	ユーザーがメッセージを送信した時。このイベントには応答できます。	✅	✅
送信取消イベント	ユーザーがメッセージの送信を取り消した時。このイベントの処理について詳しくは、送信取消イベント受信時の処理を参照してください。	✅	✅
フォローイベント	LINE公式アカウントが友だち追加またはブロック解除された時。このイベントには応答できます。	✅	❌
フォロー解除イベント	LINE公式アカウントがブロックされた時	✅	❌
参加イベント	LINE公式アカウントがグループトークまたは複数人トークに参加した時。このイベントには応答できます。	❌	✅
退出イベント	ユーザーがグループトークからLINE公式アカウントを削除したか、LINE公式アカウントがグループトークまたは複数人トークから退出した時	❌	✅
メンバー参加イベント	LINE公式アカウントがメンバーになっているグループトークまたは複数人トークに、ユーザーが参加した時。このイベントには応答できます。	❌	✅
メンバー退出イベント	LINE公式アカウントがメンバーになっているグループトークまたは複数人トークから、ユーザーが退出した時	❌	✅
ポストバックイベント	ユーザーが、ポストバックアクションを実行した時。このイベントには応答できます。	✅	✅
動画視聴完了イベント	ユーザーが、LINE公式アカウントから送信された`trackingId`が指定された動画メッセージの視聴が完了した時。このイベントには応答できます。	✅	❌

✅ ボットサーバーはイベントを受信する ❌ ボットサーバーはイベントを受信しない

# ユーザーからテンプレートメッセージやFlex Messageが送信されたときのWebhook

ユーザー自身はテンプレートメッセージやFlex Messageを送ることができませんが、liff.sendMessages()を利用することで、ユーザーの代わりに、LIFFアプリが開かれているトーク画面にメッセージを送信できます。

liff.sendMessages()によってユーザーからテンプレートメッセージやFlex Messageが送信された場合、Webhookで届くメッセージオブジェクトはテキストになります。テンプレートメッセージやFlex MessageのaltTextで指定した文字列は、テキストメッセージオブジェクトのtextに入ります。

"message": {
  "type": "text",
  "id": "468789577898262530",
  "quotedMessageId": "468789532432007169",
  "quoteToken": "q3Plxr4AgKd...",
  "text": "this is a flex message" // Flex Messageで指定したaltText
}

# ユーザーが送った引用メッセージをWebhookで受け取る

ユーザーが過去のメッセージを引用してメッセージを送った場合、Webhookのmessageプロパティに含まれるquotedMessageIdで引用対象となったメッセージのIDを確認できます。このとき、引用対象となったメッセージのIDは確認できますが、メッセージの内容（テキストやスタンプなど）は再取得できません。

以下は、ユーザーが過去のメッセージを引用したメッセージを送った際に、ボットサーバーに届くWebhookの例です。

{
  "destination": "xxxxxxxxxx",
  "events": [
    {
      "type": "message",
      "message": {
        "type": "text",
        "id": "468789577898262530", // 送られてきたメッセージのID
        "quotedMessageId": "468789532432007169", // 引用対象となったメッセージのID
        "quoteToken": "q3Plxr4AgKd...",
        "text": "Chicken, please." // 送られてきたメッセージのテキスト
      },
      "webhookEventId": "01H810YECXQQZ37VAXPF6H9E6T",
      "deliveryContext": {
        "isRedelivery": false
      },
      "timestamp": 1692251666727,
      "source": {
        "type": "group",
        "groupId": "Ca56f94637c...",
        "userId": "U4af4980629..."
      },
      "replyToken": "38ef843bde154d9b91c21320ffd17a0f",
      "mode": "active"
    }
  ]
}

quotedMessageIdプロパティについて詳しくは、『Messaging APIリファレンス』の「メッセージイベント」の「テキスト」および「スタンプ」を参照してください。

ユーザーが引用メッセージを送る方法について詳しくは、『LINEみんなの使い方ガイド』の「トークのリプライ機能を利用する (opens new window)」を参照してください。

# LINE ThingsでのWebhookイベント

LINE Things特有のWebhookイベントは以下のとおりです。

Webhookイベント	受信するタイミング
デバイス連携イベント	ユーザーがデバイスとLINEを連携した時
デバイス連携解除イベント	ユーザーがデバイスとLINEの連携を解除した時
LINE Thingsシナリオ実行イベント	自動通信のシナリオが実行された時

# その他のWebhookイベント

Webhookイベントは、以下のようにビーコンやアカウント連携にも利用できます。

Webhookイベント	受信するタイミング
ビーコンイベント	ビーコンの電波の受信圏にユーザーが入った時。このイベントには応答できます。詳しくは、「LINEでビーコンを使う」を参照してください。
アカウント連携イベント	ユーザーがLINEアカウントとプロバイダーが提供するサービスのアカウントを連携した時。このイベントには応答できます。詳しくは、「ユーザーアカウントの連携」を参照してください。

# 送信取消イベント受信時の処理

ユーザーは、送信後24時間以内であれば、自分が送ったメッセージの送信を取り消すことができます。

ユーザーがメッセージの送信を取り消すと、ボットサーバーに送信取消イベントが届きます。送信取消イベントを受け取った場合、サービス提供者はユーザーがメッセージの送信を取り消した意図を尊重し、以降は対象のメッセージを見たり利用したりできないよう、最大限の配慮を持って対象のメッセージを適切に扱うことを推奨します。

たとえば、送信が取り消されたメッセージを以下のように取り扱ってください。

独自の管理画面などで表示している対象のメッセージの表示を取り消す
データベースなどに保存している対象のメッセージを削除する

LINEアプリでのメッセージの送信取消について詳しくは、『LINEみんなの使い方ガイド』の「トークの送信取消機能を利用する (opens new window)」を参照してください。

# 受け取りに失敗したWebhookを再送する

Messaging APIでは、ボットサーバー側が受け取りに失敗したWebhookを再送する機能を提供しています。ボットサーバーが一時的なアクセス過多などの理由でWebhookに対して正常に応答できなかった場合でも、一定の期間、LINEプラットフォームから再送されるため、ボットサーバーの復旧後にWebhookを受け取ることができます。

Webhookの再送は、すべてのMessaging APIチャネルで利用可能です。

Webhookの再送を有効にする前に確認してください

ネットワーク経路上の問題等により、同じWebhookイベントが重複して送信される可能性があります。これが問題になる場合は、WebhookイベントオブジェクトのwebhookEventIdを利用し、重複の検出を行ってください。
Webhookが再送されることにより、Webhookを受信する順序がイベントの発生順序と異なる可能性があります。これが問題になる場合は、Webhookイベントオブジェクトのtimestampを確認することによって、前後関係を確認してください。

# 再送されるWebhook

再送されるWebhookイベントオブジェクトの内容は、deliveryContext.isRedeliveryの値を除き、元のWebhookイベントオブジェクトと同じになります。WebhookイベントIDや応答トークンなどの値は変更されません。

なお、再送されるWebhookイベントオブジェクトに含まれる応答トークンは、特定の場合を除き使用できます。応答トークンについて詳しくは、『Messaging APIリファレンス』の「応答トークン」を参照してください。

# Webhookの再送を有効にする

Webhookの再送は、デフォルトでは無効になっています。Webhookの再送を有効にするには、次の手順を行います。

LINE Developersコンソールからチャネルの設定画面を開く。
［Messaging API設定］タブをクリックする。
［Webhookの利用］を有効にする。
［Webhookの再送］を有効にする。

［Webhookの再送］を有効にする際、Webhook再送の利用に際する注意事項が表示されます。注意事項を確認し、理解した上でWebhook再送を有効にしてください。

# Webhookが再送される条件

LINEプラットフォームから送信されたWebhookは、次の2つの条件を満たすときに、一定の期間内に、一定の時間を空けて再送されます。

Webhookの再送を有効にしている。
Webhookに対して、ボットサーバーがステータスコード200番台を返さなかった。

Webhookを再送できない場合があります

Webhookの再送は、Webhookの確実な再送を保証するものではありません。また、Webhook再送の件数が急激に増加し、LINEプラットフォームの動作に影響を与えると判断された場合、Webhookの再送設定が強制的に無効になる可能性があります。

# Webhookの送信におけるエラーの統計情報を確認する

こちらに記載されていた内容は、「エラーが発生した原因を確認する」に移動しました。

# ユーザーが送ったコンテンツを取得する

Webhookで受信したメッセージIDを使って、ユーザーが送信した画像、動画、音声、およびファイルを取得できます。

リクエストの例

curl -v -X GET https://api-data.line.me/v2/bot/message/{messageId}/content \
-H 'Authorization: Bearer {channel access token}'

詳しくは、『Messaging APIリファレンス』の「コンテンツを取得する」を参照してください。

注意

ユーザーが送ったコンテンツは一定期間後、自動的に削除されます。
ユーザーが送ったテキストは、Webhookのテキストメッセージオブジェクトで受信できます。Webhookを受信した後で、あらためてテキストを取得するためのAPIはありません。

# ユーザープロフィール情報を取得する

Webhookに含まれるユーザーIDを使って、ユーザーのLINEプロフィール情報（ユーザーの表示名、ユーザーID、プロフィール画像のURL、ステータスメッセージなど）を取得できます。

リクエストの例

curl -v -X GET https://api.line.me/v2/bot/profile/{userId} \
-H 'Authorization: Bearer {channel access token}'

成功した場合、JSONオブジェクトが返されます。

{
  "displayName": "LINE Botto",
  "userId": "U4af4980629...",
  "pictureUrl": "https://profile.line-scdn.net/ch/v2/p/uf9da5ee2b...",
  "statusMessage": "Hello world!"
}

詳しくは、『Messaging APIリファレンス』の「プロフィールを取得する」を参照してください。

署名を検証する

Webhookイベントのタイプ

トークでのWebhookイベント LINE ThingsでのWebhookイベントその他のWebhookイベント

送信取消イベント受信時の処理

受け取りに失敗したWebhookを再送する

再送されるWebhook Webhookの再送を有効にする Webhookが再送される条件

Webhookの送信におけるエラーの統計情報を確認する

ユーザーが送ったコンテンツを取得する

ユーザープロフィール情報を取得する