# Webhookの配信完了イベント
本ドキュメントに記載の機能は、所定の申請等を行った法人ユーザーのみがご利用いただけます。自社のLINE公式アカウントでご利用になりたいお客様は、担当営業までご連絡いただくか、弊社パートナー (opens new window)にお問い合わせください。
# Webhookの配信完了イベントの概要
LINE通知メッセージAPIをリクエストし、ユーザーに対してLINE通知メッセージの配信が完了した際に、専用のWebhookイベント(配信完了イベント)がLINEプラットフォームからボットサーバーのWebhook URLに送信されます。
# Webhookの配信完了イベントの仕様
プロパティ名 | タイプ | 説明 |
---|---|---|
type | String | delivery |
mode | Object | 「共通プロパティ」を参照してください。 |
source | Object | 「共通プロパティ」を参照してください。 |
timestamp | Number | 「共通プロパティ」を参照してください。 |
webhookEventId | String | 「共通プロパティ」を参照してください。 |
deliveryContext | Object | 「共通プロパティ」を参照してください。 |
delivery | Object | ハッシュ化した電話番号の文字列もしくは、X-Line-Delivery-Tag で指定した文字列を含むデリバリーオブジェクト。 |
delivery.data | String | ハッシュ化した電話番号の文字列もしくは、X-Line-Delivery-Tag で指定した文字列。 |
Webhookイベントの例
Webhookの配信完了イベントは、LINE通知メッセージがユーザーに配信され、メッセージを確認できる状態になったことを示すものです。以下を示すものではありません。
- LINE通知メッセージAPIのリクエスト成功
- LINE通知メッセージの受信への同意を求めるメッセージの受信
- LINE通知メッセージの受信への同意
- SMS認証を求めるメッセージの受信
- SMS認証の実施
- ユーザーによるLINE通知メッセージの開封(既読)
配信完了イベント受信時の署名の検証についてはチャネルシークレットを用いて行ってください。なお、LINEチャットPlusを利用しているチャネルにおいては、Switcher Secretを用いて署名の検証を行ってください。
# Webhookの配信完了イベントに関する補足事項
LINE通知メッセージAPIをリクエストし、HTTPステータスコード200
でレスポンスが行われた場合でも、ユーザーのLINE通知メッセージの受信設定やSMS認証の状況によっては、LINE通知メッセージがユーザーに配信されなかったり、LINE通知メッセージの送信が保留されたりする場合があります。
LINE通知メッセージAPIをリクエストし、HTTPステータスコード200
でレスポンスが行われてから24時間以内にWebhookの配信完了イベントを受信しなかった場合は、以下のいずれかの理由により、LINE通知メッセージがユーザーに配信されなかったことを意味します。
# ユーザーがLINE公式アカウントをブロックしている
ユーザーがLINE通知メッセージ送信元のLINE公式アカウントをブロックしている場合でも、LINE通知メッセージAPIのリクエストは、HTTPステータスコード200
でレスポンスされます。
# ユーザーが必要な同意や認証を行わなかった
LINE通知メッセージの受信設定が未設定であったり、SMS認証が必要な状況であるが、それらの設定や操作を行わなかった可能性があります。詳しくはLINE通知メッセージAPIのリクエストが成功したがメッセージが配信されない場合についてを参照してください。