LINE通知メッセージAPIリファレンス

# LINE通知メッセージAPIリファレンス

オプション機能を利用するには手続きが必要です

本ドキュメントに記載の機能は、所定の申請等を行った法人ユーザーのみがご利用いただけます。自社のLINE公式アカウントでご利用になりたいお客様は、担当営業までご連絡いただくか、弊社パートナー (opens new window)にお問い合わせください。

# 共通仕様

# ステータスコード

『Messaging APIリファレンス』の「ステータスコード」を参照してください。

# レスポンスヘッダー

LINE通知メッセージAPIのレスポンスには、以下のHTTPヘッダーが含まれます。

レスポンスヘッダー 説明
x-line-request-id リクエストID。各リクエストごとに発行されるIDです。

# LINE通知メッセージ（テンプレート）

# LINE通知メッセージ（テンプレート）を送る

ユーザーの電話番号を指定してLINE通知メッセージ（テンプレート）を送るAPIです。

詳しくは、『LINE通知メッセージドキュメント』の「LINE通知メッセージ（テンプレート）」を参照してください。

リクエスト元IPアドレスの制限について

LINE通知メッセージを送る場合、Messaging APIチャネルの［セキュリティ設定］タブで、LINEプラットフォームのAPIを呼び出せるサーバーのIPアドレスを登録しないでください。リクエスト元のIPアドレスを制限した状態でLINE通知メッセージを送ると、送信に失敗することがあります。設定方法について詳しくは、「長期のチャネルアクセストークン利用時にAPIの呼び出し元を制限する（任意）」を参照してください。

リクエストの例

# HTTPリクエスト

POST https://api.line.me/v2/bot/message/pnp/templated/push

# レート制限

2,000リクエスト/秒

# リクエストヘッダー

サポートしていない機能

LINE通知メッセージAPIでは、リトライキー（X-Line-Retry-Key）を使ったAPIリクエストの再試行はできません。

Content-Type

必須

application/json

Authorization

必須

Bearer {channel access token}

X-Line-Delivery-Tag

任意

Webhookを介して、配信完了イベントのdelivery.dataプロパティで返される文字列。詳しくは、「メッセージの送信通知を受信する」を参照してください。
最小文字数：16
最大文字数：100

X-Line-Delivery-Tagの例

# リクエストボディ

to

String

必須

メッセージの送信先。E.164形式に正規化しSHA256でハッシュ化した電話番号を指定してください。

メッセージの送信条件について詳しくは、「LINE通知メッセージが送信される条件」を参照してください。

注意

templateKey

String

必須

使用するテンプレートのKeyを指定します。

使用できるKeyは、「テンプレート」を参照してください。

body

Object

必須

送信するテンプレートのボディオブジェクト。3つのオブジェクトでメッセージに含める内容を指定します。1つのメッセージ内で、同じアイテムを重複して指定することはできません。

body.emphasizedItem

Object

任意

メッセージで強調するアイテムを指定します。
最大オブジェクト数：1

body.items

Array of objects

任意

メッセージに含めるアイテムの配列を指定します。
最小オブジェクト数：0
最大オブジェクト数：15

body.buttons

Array of objects

任意

メッセージに含めるボタンの配列を指定します。
最小オブジェクト数：0
最大オブジェクト数：2

# アイテム

itemKey

String

必須

使用するアイテムのKeyを指定します。

使用できるKeyは、「アイテム」を参照してください。

content

String

必須

アイテムの値として表示する文字列を指定します。
最大文字数：body.emphasizedItemの場合は15、body.itemsの場合は300

アイテムの例

# ボタン

buttonKey

String

必須

使用するボタンのKeyを指定します。

使用できるKeyは、「ボタン」を参照してください。

url

String

必須

ボタンを押すと遷移するURLを指定します。
最大文字数：1000

ボタンの例

# レスポンス

ステータスコード202と空のJSONオブジェクトを返します。

レスポンスの例

# エラーレスポンス

以下のHTTPステータスコードと、エラーレスポンスを返します。

コード 説明
400 リクエストに問題があります。次のような理由が考えられます。
  • メッセージの送信先が無効です。
  • 無効なメッセージオブジェクトが指定されています。
  • このLINE公式アカウントでは指定したテンプレートは使用できません。
403 このエンドポイントを使う権限がありません。
422 LINE通知メッセージ（テンプレート）の送信に失敗しました。以下のような理由が考えられます。

詳しくは、『Messaging APIリファレンス』の「ステータスコード」および「エラーレスポンス」を参照してください。

エラーレスポンスの例

# 送信済みのLINE通知メッセージ（テンプレート）の数を取得する

「LINE通知メッセージ（テンプレート）を送る」エンドポイントを使って送信された、LINE通知メッセージ（テンプレート）の数を取得します。

詳しくは、『LINE通知メッセージドキュメント』の「送信済みLINE通知メッセージの数を取得する」を参照してください。

リクエストの例

# HTTPリクエスト

GET https://api.line.me/v2/bot/message/delivery/pnp/templated

# レート制限

2,000リクエスト/秒

# リクエストヘッダー

Authorization

必須

Bearer {channel access token}

# クエリパラメータ

date

必須

メッセージが送信された日付

  • フォーマット：yyyyMMdd（例：20240916）
  • タイムゾーン：UTC+9

# レスポンス

ステータスコード200と以下の情報を含むJSONオブジェクトを返します。

status

String

集計処理の状態。以下のいずれかの値です。

  • ready：メッセージ数を取得できます。
  • unready：dateに指定した日付のメッセージ数の集計がまだ完了していません。しばらくしてからリクエストを再実行してください。通常、集計処理は翌日中に完了します。
  • out_of_service：dateに指定した日付が、集計システムの稼働開始日（2018年3月31日）より前です。

success

Number

含まれないことがあります

dateに指定した日付に、LINE通知メッセージAPIを使って送信されたメッセージの数。statusの値がreadyの場合にのみ、レスポンスに含まれます。

レスポンスの例

# エラーレスポンス

以下のHTTPステータスコードと、エラーレスポンスを返します。

コード 説明
400 リクエストに問題があります。次のような理由が考えられます。
  • 無効な日付が指定されています。
  • 日付が指定されていません。

詳しくは、『Messaging APIリファレンス』の「ステータスコード」および「エラーレスポンス」を参照してください。

エラーレスポンスの例

# LINE通知メッセージ（フレキシブル）

# LINE通知メッセージ（フレキシブル）を送る

ユーザーの電話番号を指定してLINE通知メッセージ（フレキシブル）を送るAPIです。

従来の「LINE通知メッセージ」は、名称が「LINE通知メッセージ（フレキシブル）」に変更されました

LINE通知メッセージに、用意されたテンプレートやアイテムを組み合わせて簡単にメッセージを作成できる「LINE通知メッセージ（テンプレート）」が新たに加わりました。

これに伴い、UX審査を要する従来の「LINE通知メッセージ」は、名称が「LINE通知メッセージ（フレキシブル）」に変更されました。

詳しくは、2025年6月2日の『法人ユーザー向けお知らせ』、「LINE通知メッセージ（テンプレート）の提供を開始しました」を参照してください。

リクエスト元IPアドレスの制限について

LINE通知メッセージを送る場合、Messaging APIチャネルの［セキュリティ設定］タブで、LINEプラットフォームのAPIを呼び出せるサーバーのIPアドレスを登録しないでください。リクエスト元のIPアドレスを制限した状態でLINE通知メッセージを送ると、送信に失敗することがあります。設定方法について詳しくは、「長期のチャネルアクセストークン利用時にAPIの呼び出し元を制限する（任意）」を参照してください。

リクエストの例

# HTTPリクエスト

POST https://api.line.me/bot/pnp/push

# レート制限

2,000リクエスト/秒

# リクエストヘッダー

サポートしていない機能

LINE通知メッセージAPIでは、リトライキー（X-Line-Retry-Key）を使ったAPIリクエストの再試行はできません。

Content-Type

必須

application/json

Authorization

必須

Bearer {channel access token}

X-Line-Delivery-Tag

任意

Webhookを介して、配信完了イベントのdelivery.dataプロパティで返される文字列。詳しくは、「メッセージの送信通知を受信する」を参照してください。
最小文字数：16
最大文字数：100

X-Line-Delivery-Tagの例

# リクエストボディ

to

String

必須

メッセージの送信先。E.164形式に正規化しSHA256でハッシュ化した電話番号を指定してください。

メッセージの送信条件について詳しくは、「LINE通知メッセージが送信される条件」を参照してください。

注意

messages

必須

送信するメッセージ。最大件数：5

詳しくは、「LINE通知メッセージAPIで送信可能なメッセージタイプ」を参照してください。

# レスポンス

ステータスコード200と空のJSONオブジェクトを返します。

レスポンスの例

# エラーレスポンス

以下のHTTPステータスコードと、エラーレスポンスを返します。

コード 説明
400 リクエストに問題があります。次のような理由が考えられます。
  • メッセージの送信先が無効です。
  • 無効なメッセージオブジェクトが指定されています。
422 LINE通知メッセージの送信に失敗しました。以下のような理由が考えられます。

詳しくは、『Messaging APIリファレンス』の「ステータスコード」および「エラーレスポンス」を参照してください。

エラーレスポンスの例

# 送信済みのLINE通知メッセージ（フレキシブル）の数を取得する

「LINE通知メッセージ（フレキシブル）を送る」エンドポイントを使って送信された、LINE通知メッセージ（フレキシブル）の数を取得します。

詳しくは、『LINE通知メッセージドキュメント』の「送信済みLINE通知メッセージの数を取得する」を参照してください。

リクエストの例

# HTTPリクエスト

GET https://api.line.me/v2/bot/message/delivery/pnp

# レート制限

2,000リクエスト/秒

# リクエストヘッダー

Authorization

必須

Bearer {channel access token}

# クエリパラメータ

date

必須

メッセージが送信された日付

  • フォーマット：yyyyMMdd（例：20211231）
  • タイムゾーン：UTC+9

# レスポンス

ステータスコード200と以下の情報を含むJSONオブジェクトを返します。

status

String

集計処理の状態。以下のいずれかの値です。

  • ready：メッセージ数を取得できます。
  • unready：dateに指定した日付のメッセージ数の集計がまだ完了していません。しばらくしてからリクエストを再実行してください。通常、集計処理は翌日中に完了します。
  • out_of_service：dateに指定した日付が、集計システムの稼働開始日（2018年3月31日）より前です。

success

Number

含まれないことがあります

dateに指定した日付に、LINE通知メッセージAPIを使って送信されたメッセージの数。statusの値がreadyの場合にのみ、レスポンスに含まれます。

レスポンスの例

# エラーレスポンス

以下のHTTPステータスコードと、エラーレスポンスを返します。

コード 説明
400 リクエストに問題があります。次のような理由が考えられます。
  • 無効な日付が指定されています。
  • 日付が指定されていません。

詳しくは、『Messaging APIリファレンス』の「ステータスコード」および「エラーレスポンス」を参照してください。

エラーレスポンスの例