サーバーAPI

LIFF SDKとはバージョン番号が異なります

サーバーAPIのバージョン番号は、LIFF SDKのバージョン番号とは異なります。現在公開されているLIFF SDKのバージョンはv2ですが、サーバーAPIのバージョンはv1です。

サーバーAPI

チャネルアクセストークンを準備する

LIFFのサーバーAPIは、LINEログインチャネル上のLIFFアプリを操作するためのAPIです。このため、サーバーAPIを利用するには、LINEログインチャネルのチャネルアクセストークンが必要です。利用できるチャネルアクセストークンの種類は、短期のチャネルアクセストークンまたはステートレスチャネルアクセストークンです。

LIFFアプリをチャネルに追加する

LIFFアプリをチャネルに追加します。チャネルごとに、最大30件のLIFFアプリを追加できます。

LINEミニアプリとしての作成を推奨します

今後、LIFFとLINEミニアプリは、ブランド統合を予定しています。この統合により、LIFFはLINEミニアプリに統合されます。そのため、LIFFアプリを新規作成する際は、LINEミニアプリとして作成することを推奨します。詳しくは、「2025年2月12日のニュース」を参照してください。

例

HTTPリクエスト

POST https://api.line.me/liff/v1/apps

リクエストヘッダー

Authorization

必須

Bearer {channel access token}
詳しくは、「チャネルアクセストークンを準備する」を参照してください。

Content-Type

必須

application/json

リクエストボディ

view.type

String

必須

LIFFアプリの画面サイズ。以下のいずれかの値を指定します。

  • full
  • tall
  • compact

詳しくは、「LIFFアプリの画面サイズ」を参照してください。

view.url

String

必須

エンドポイントURL。LIFFアプリを実装したウェブアプリのURLです（例：https://example.com）。LIFF URLを利用してLIFFアプリを起動した際に、このURLが利用されます。

URLスキームはhttpsである必要があります。なお、URLフラグメント（#URL-fragment）は指定できません。

view.moduleMode

Boolean

任意

LIFFアプリをモジュールモードで使用する場合は、true。モジュールモードの場合は、ヘッダーのアクションボタンが非表示になります。

description

String

任意

LIFFアプリの名前。

LIFFアプリ名には、「LINE」またはそれに類する文字列、不適切な文字列は含められません。

features.qrCode

Boolean

任意

LIFFアプリで二次元コードリーダーを使用する場合はtrueを指定します。使用しない場合はfalseを指定します。デフォルト値はfalseです。

permanentLinkPattern

String

任意

LIFF URLの追加情報の処理方法。concatを指定してください。

詳しくは、『LIFFドキュメント』の「LIFFアプリを開く」を参照してください。

scope

Array of strings

任意

LIFF SDKの一部のメソッドを使用するために必要なスコープの配列。

  • openid
  • email
  • profile
  • chat_message.write

デフォルト値は ["profile", "chat_message.write"]です。各スコープについて詳しくは、『LIFFドキュメント』の「LIFFアプリをチャネルに追加する」を参照してください。

botPrompt

String

任意

友だち追加オプションの設定を、以下のいずれかの値で指定します。

  • normal：チャネル同意画面に、LINE公式アカウントを友だち追加するオプションを表示する。
  • aggressive：チャネル同意画面の後に、LINE公式アカウントを友だち追加するかどうかを確認する画面を表示する。
  • none：LINE公式アカウントを友だち追加するオプションを表示しない。

デフォルト値はnoneです。

レスポンス

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

liffId

String

LIFFアプリID

例

エラーレスポンス

以下のいずれかのステータスコードを返します。

ステータスコード説明
400以下のどちらかです。
  • リクエストに無効な値が含まれています。
  • チャネルに追加できるLIFFアプリ数の上限に達しています。
401認証に失敗しました。

LIFFアプリの設定を更新する

LIFFアプリの設定を、部分的に更新します。

例

HTTPリクエスト

PUT https://api.line.me/liff/v1/apps/{liffId}

リクエストヘッダー

Authorization

必須

Bearer {channel access token}
詳しくは、「チャネルアクセストークンを準備する」を参照してください。

Content-Type

必須

application/json

パスパラメータ

liffId

必須

更新するLIFFアプリのID

リクエストボディ

view.type

String

任意

LIFFアプリの画面サイズ。以下のいずれかの値を指定します。

  • full
  • tall
  • compact

詳しくは、「LIFFアプリの画面サイズ」を参照してください。

view.url

String

任意

エンドポイントURL。LIFFアプリを実装したウェブアプリのURLです（例：https://example.com）。LIFF URLを利用してLIFFアプリを起動した際に、このURLが利用されます。

URLスキームはhttpsである必要があります。なお、URLフラグメント（#URL-fragment）は指定できません。

view.moduleMode

Boolean

任意

LIFFアプリをモジュールモードで使用する場合は、true。モジュールモードの場合は、ヘッダーのアクションボタンが非表示になります。

description

String

任意

LIFFアプリの名前。

LIFFアプリ名には、「LINE」またはそれに類する文字列、不適切な文字列は含められません。

features.qrCode

Boolean

任意

LIFFアプリで二次元コードリーダーを使用する場合はtrueを指定します。使用しない場合はfalseを指定します。

permanentLinkPattern

String

任意

LIFF URLの追加情報の処理方法。concatを指定してください。

詳しくは、『LIFFドキュメント』の「LIFFアプリを開く」を参照してください。

scope

Array of strings

任意

LIFF SDKの一部のメソッドを使用するために必要なスコープの配列。

  • openid
  • email
  • profile
  • chat_message.write

各スコープについて詳しくは、『LIFFドキュメント』の「LIFFアプリをチャネルに追加する」を参照してください。

botPrompt

String

任意

友だち追加オプションの設定を、以下のいずれかの値で指定します。

  • normal：チャネル同意画面に、LINE公式アカウントを友だち追加するオプションを表示する。
  • aggressive：チャネル同意画面の後に、LINE公式アカウントを友だち追加するかどうかを確認する画面を表示する。
  • none：LINE公式アカウントを友だち追加するオプションを表示しない。
注意

リクエストボディに指定しなかったプロパティは変更されません。

レスポンス

ステータスコード200を返します。

エラーレスポンス

以下のいずれかのステータスコードを返します。

ステータスコード説明
400リクエストに無効な値が含まれています。
401認証に失敗しました。
404以下のどちらかです。
  • 指定したLIFFアプリは存在しません。
  • 指定したLIFFアプリは別のチャネルに追加されています。

すべてのLIFFアプリを取得する

チャネルに追加されているすべてのLIFFアプリの情報を取得します。

例

HTTPリクエスト

GET https://api.line.me/liff/v1/apps

リクエストヘッダー

Authorization

必須

Bearer {channel access token}
詳しくは、「チャネルアクセストークンを準備する」を参照してください。

レスポンス

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

apps

Array of objects

LIFFアプリオブジェクトの配列

apps[].liffId

String

LIFFアプリID

apps.view.type

String

LIFFアプリの画面サイズ。以下のいずれかの値が含まれます。

  • full
  • tall
  • compact

詳しくは、「LIFFアプリの画面サイズ」を参照してください。

apps.view.url

String

エンドポイントURL。LIFFアプリを実装したウェブアプリのURLです（例：https://example.com）。LIFF URLを利用してLIFFアプリを起動した際に、このURLが利用されます。

apps.view.moduleMode

Boolean

LIFFアプリをモジュールモードで使用する場合は、true。モジュールモードの場合は、ヘッダーのアクションボタンが非表示になります。

apps[].description

String

LIFFアプリの名前

apps.features.ble

Boolean

LINE ThingsのためにBluetooth® Low Energyに対応している場合はtrue。対応しない場合はfalse。

apps.features.qrCode

Boolean

LIFFアプリで二次元コードリーダーを起動できる場合はtrue。起動できない場合はfalse。

apps[].permanentLinkPattern

String

LIFF URLの追加情報の処理方法。concatが返されます。

詳しくは、『LIFFドキュメント』の「LIFFアプリを開く」を参照してください。

apps[].scope

Array of strings

LIFFアプリのスコープ。

  • openid
  • email
  • profile
  • chat_message.write

各スコープについて詳しくは、『LIFFドキュメント』の「LIFFアプリをチャネルに追加する」を参照してください。

apps[].botPrompt

String

友だち追加オプションの設定。

  • normal：チャネル同意画面に、LINE公式アカウントを友だち追加するオプションを表示する。
  • aggressive：チャネル同意画面の後に、LINE公式アカウントを友だち追加するかどうかを確認する画面を表示する。
  • none：LINE公式アカウントを友だち追加するオプションを表示しない。

例

エラーレスポンス

以下のいずれかのステータスコードを返します。

ステータスコード説明
401認証に失敗しました。
404チャネルにLIFFアプリがありません。

LIFFアプリをチャネルから削除する

LIFFアプリをチャネルから削除します。

例

HTTPリクエスト

DELETE https://api.line.me/liff/v1/apps/{liffId}

リクエストヘッダー

Authorization

必須

Bearer {channel access token}
詳しくは、「チャネルアクセストークンを準備する」を参照してください。

パスパラメータ

liffId

必須

削除するLIFFアプリのID

レスポンス

ステータスコード200を返します。

エラーレスポンス

以下のいずれかのステータスコードを返します。

ステータスコード説明
401認証に失敗しました。
404以下のどちらかです。
  • 指定したLIFFアプリは存在しません。
  • 指定したLIFFアプリは別のチャネルに追加されています。