# サーバーAPI

<!-- tip start -->

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

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

<!-- tip end -->

## サーバーAPI 

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

LIFFのサーバーAPIは、LINEログインチャネル上のLIFFアプリを操作するためのAPIです。このため、サーバーAPIを利用するには、LINEログインチャネルのチャネルアクセストークンが必要です。利用できるチャネルアクセストークンの種類は、[短期のチャネルアクセストークン](https://developers.line.biz/ja/reference/messaging-api/#issue-shortlived-channel-access-token)または[ステートレスチャネルアクセストークン](https://developers.line.biz/ja/reference/messaging-api/#issue-stateless-channel-access-token)です。

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

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

<!-- tip start -->

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

今後、LIFFとLINEミニアプリは、ブランド統合を予定しています。この統合により、LIFFはLINEミニアプリに統合されます。そのため、LIFFアプリを新規作成する際は、LINEミニアプリとして作成することを推奨します。詳しくは、「[2025年2月12日のニュース](https://developers.line.biz/ja/news/2025/02/12/line-mini-app/)」を参照してください。

<!-- tip end -->

_例_

<code-tabs>

<!-- tab start `shell` -->

```sh
curl -X POST https://api.line.me/liff/v1/apps \
-H "Authorization: Bearer {channel access token}" \
-H "Content-Type: application/json" \
-d '{
    "view": {
        "type": "full",
        "url": "https://example.com/myservice"
    },
    "description": "Service Example",
    "features": {
        "qrCode": true
    },
    "permanentLinkPattern": "concat",
    "scope": ["profile", "chat_message.write"],
    "botPrompt": "none"
}'
```

<!-- tab end -->

</code-tabs>

#### HTTPリクエスト 

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

#### リクエストヘッダー 

<!-- parameter start (props: required) -->

Authorization

Bearer `{channel access token}`\
詳しくは、「[チャネルアクセストークンを準備する](https://developers.line.biz/ja/reference/liff-server/#preparing-channel-access-token)」を参照してください。

<!-- parameter end -->
<!-- parameter start (props: required) -->

Content-Type

application/json

<!-- parameter end -->

#### リクエストボディ 

<!-- parameter start (props: required) -->

view.type

String

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

- `full`
- `tall`
- `compact`

詳しくは、「[LIFFアプリの画面サイズ](https://developers.line.biz/ja/docs/liff/overview/#screen-size)」を参照してください。

<!-- parameter end -->
<!-- parameter start (props: required) -->

view.url

String

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

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

<!-- parameter end -->
<!-- parameter start (props: optional) -->

view.moduleMode

Boolean

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

<!-- parameter end -->
<!-- parameter start (props: optional) -->

description

String

LIFFアプリの名前。

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

<!-- parameter end -->
<!-- parameter start (props: optional) -->

features.qrCode

Boolean

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

<!-- parameter end -->
<!-- parameter start (props: optional) -->

permanentLinkPattern

String

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

詳しくは、『LIFFドキュメント』の「[LIFFアプリを開く](https://developers.line.biz/ja/docs/liff/opening-liff-app/)」を参照してください。

<!-- parameter end -->
<!-- parameter start (props: optional) -->

scope

Array of strings

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

- `openid`
- `email`
- `profile`
- `chat_message.write`

デフォルト値は `["profile", "chat_message.write"]`です。各スコープについて詳しくは、『LIFFドキュメント』の「[LIFFアプリをチャネルに追加する](https://developers.line.biz/ja/docs/liff/registering-liff-apps/#registering-liff-app)」を参照してください。

<!-- parameter end -->
<!-- parameter start (props: optional) -->

botPrompt

String

[友だち追加オプション](https://developers.line.biz/ja/docs/line-login/link-a-bot/)の設定を、以下のいずれかの値で指定します。

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

デフォルト値は`none`です。

<!-- parameter end -->

#### レスポンス 

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

<!-- parameter start -->

liffId

String

LIFFアプリID

<!-- parameter end -->

_例_

<code-tabs>

<!-- tab start `json` -->

```json
{
  "liffId": "{liffId}"
}
```

<!-- tab end -->

</code-tabs>

#### エラーレスポンス 

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

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

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

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

_例_

<code-tabs>

<!-- tab start `shell` -->

```sh
curl -X PUT https://api.line.me/liff/v1/apps/{liffId} \
-H "Authorization: Bearer {channel access token}" \
-H "Content-Type: application/json" \
-d '{
    "view": {
        "url": "https://new.example.com"
    }
}'
```

<!-- tab end -->

</code-tabs>

#### HTTPリクエスト 

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

#### リクエストヘッダー 

<!-- parameter start (props: required) -->

Authorization

Bearer `{channel access token}`\
詳しくは、「[チャネルアクセストークンを準備する](https://developers.line.biz/ja/reference/liff-server/#preparing-channel-access-token)」を参照してください。

<!-- parameter end -->
<!-- parameter start (props: required) -->

Content-Type

application/json

<!-- parameter end -->

#### パスパラメータ 

<!-- parameter start (props: required) -->

liffId

更新するLIFFアプリのID

<!-- parameter end -->

#### リクエストボディ 

<!-- parameter start (props: optional) -->

view.type

String

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

- `full`
- `tall`
- `compact`

詳しくは、「[LIFFアプリの画面サイズ](https://developers.line.biz/ja/docs/liff/overview/#screen-size)」を参照してください。

<!-- parameter end -->
<!-- parameter start (props: optional) -->

view.url

String

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

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

<!-- parameter end -->
<!-- parameter start (props: optional) -->

view.moduleMode

Boolean

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

<!-- parameter end -->
<!-- parameter start (props: optional) -->

description

String

LIFFアプリの名前。

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

<!-- parameter end -->
<!-- parameter start (props: optional) -->

features.qrCode

Boolean

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

<!-- parameter end -->
<!-- parameter start (props: optional) -->

permanentLinkPattern

String

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

詳しくは、『LIFFドキュメント』の「[LIFFアプリを開く](https://developers.line.biz/ja/docs/liff/opening-liff-app/)」を参照してください。

<!-- parameter end -->
<!-- parameter start (props: optional) -->

scope

Array of strings

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

- `openid`
- `email`
- `profile`
- `chat_message.write`

各スコープについて詳しくは、『LIFFドキュメント』の「[LIFFアプリをチャネルに追加する](https://developers.line.biz/ja/docs/liff/registering-liff-apps/#registering-liff-app)」を参照してください。

<!-- parameter end -->
<!-- parameter start (props: optional) -->

botPrompt

String

[友だち追加オプション](https://developers.line.biz/ja/docs/line-login/link-a-bot/)の設定を、以下のいずれかの値で指定します。

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

<!-- parameter end -->

<!-- note start -->

**注意**

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

<!-- note end -->

#### レスポンス 

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

#### エラーレスポンス 

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

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

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

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

_例_

<code-tabs>

<!-- tab start `shell` -->

```sh
curl -X GET https://api.line.me/liff/v1/apps \
-H "Authorization: Bearer {channel access token}"
```

<!-- tab end -->

</code-tabs>

#### HTTPリクエスト 

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

#### リクエストヘッダー 

<!-- parameter start (props: required) -->

Authorization

Bearer `{channel access token}`\
詳しくは、「[チャネルアクセストークンを準備する](https://developers.line.biz/ja/reference/liff-server/#preparing-channel-access-token)」を参照してください。

<!-- parameter end -->

#### レスポンス 

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

<!-- parameter start -->

apps

Array of objects

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

<!-- parameter end -->
<!-- parameter start -->

apps\[].liffId

String

LIFFアプリID

<!-- parameter end -->
<!-- parameter start -->

apps[].view.type

String

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

- `full`
- `tall`
- `compact`

詳しくは、「[LIFFアプリの画面サイズ](https://developers.line.biz/ja/docs/liff/overview/#screen-size)」を参照してください。

<!-- parameter end -->
<!-- parameter start -->

apps[].view.url

String

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

<!-- parameter end -->
<!-- parameter start -->

apps[].view.moduleMode

Boolean

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

<!-- parameter end -->
<!-- parameter start -->

apps\[].description

String

LIFFアプリの名前

<!-- parameter end -->
<!-- parameter start -->

apps[].features.ble

Boolean

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

<!-- parameter end -->
<!-- parameter start -->

apps[].features.qrCode

Boolean

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

<!-- parameter end -->
<!-- parameter start -->

apps\[].permanentLinkPattern

String

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

詳しくは、『LIFFドキュメント』の「[LIFFアプリを開く](https://developers.line.biz/ja/docs/liff/opening-liff-app/)」を参照してください。

<!-- parameter end -->
<!-- parameter start -->

apps\[].scope

Array of strings

LIFFアプリのスコープ。

- `openid`
- `email`
- `profile`
- `chat_message.write`

各スコープについて詳しくは、『LIFFドキュメント』の「[LIFFアプリをチャネルに追加する](https://developers.line.biz/ja/docs/liff/registering-liff-apps/#registering-liff-app)」を参照してください。

<!-- parameter end -->
<!-- parameter start -->

apps\[].botPrompt

String

[友だち追加オプション](https://developers.line.biz/ja/docs/line-login/link-a-bot/)の設定。

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

<!-- parameter end -->

_例_

<code-tabs>

<!-- tab start `json` -->

```json
{
  "apps": [
    {
      "liffId": "{liffId}",
      "view": {
        "type": "full",
        "url": "https://example.com/myservice"
      },
      "description": "Happy New York",
      "permanentLinkPattern": "concat"
    },
    {
      "liffId": "{liffId}",
      "view": {
        "type": "tall",
        "url": "https://example.com/myservice2"
      },
      "features": {
        "ble": true,
        "qrCode": true
      },
      "permanentLinkPattern": "concat",
      "scope": ["profile", "chat_message.write"],
      "botPrompt": "none"
    }
  ]
}
```

<!-- tab end -->

</code-tabs>

#### エラーレスポンス 

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

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

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

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

_例_

<code-tabs>

<!-- tab start `shell` -->

```sh
curl -X DELETE https://api.line.me/liff/v1/apps/{liffId} \
-H "Authorization: Bearer {channel access token}"
```

<!-- tab end -->

</code-tabs>

#### HTTPリクエスト 

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

#### リクエストヘッダー 

<!-- parameter start (props: required) -->

Authorization

Bearer `{channel access token}`\
詳しくは、「[チャネルアクセストークンを準備する](https://developers.line.biz/ja/reference/liff-server/#preparing-channel-access-token)」を参照してください。

<!-- parameter end -->

#### パスパラメータ 

<!-- parameter start (props: required) -->

liffId

削除するLIFFアプリのID

<!-- parameter end -->

#### レスポンス 

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

#### エラーレスポンス 

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

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