---
title: "テンプレートリストの照会"
slug: "sens-brandmessage-template-list"
updated: 2026-09-17T09:57:20Z
published: 2026-09-17T09:57:20Z
canonical: "api.ncloud-docs.com/sens-brandmessage-template-list"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# テンプレートリストの照会

Classic/VPC環境で利用できます。

ブランドメッセージのテンプレート情報を照会します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET | /brandmessage/v2/services/{serviceId}/templates |

### リクエストヘッダ

Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、[Simple & Easy Notification Serviceのリクエストヘッダ](/docs/ja/sens-overview#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `serviceId` | String | Required | Biz Messageサービス ID - [プロジェクトリストの照会](/docs/ja/sens-project-list)を参照 |

### リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `plusFriendId` | String | Required | チャンネル ID - [チャンネルの照会](/docs/ja/sens-alimtalk-kakao-channel-get)を参照 |
| `templateCode` | String | Optional | テンプレートコード |
| `templateName` | String | Optional | テンプレート名 - 完全一致または一部一致する値を絞り込む |
| `messageType` | String | Optional | メッセージタイプ - `TEXT` \| `IMAGE` \| `WIDE_IMAGE` \| `WIDE_ITEM_LIST` \| `COMMERCE` \| `CAROUSEL_COMMERCE` \| `CAROUSEL_FEED` \| `PREMIUM_VIDEO` - `TEXT`: テキスト - `IMAGE`: 画像型 - `WIDE_IMAGE`: ワイド画像型 - `WIDE_ITEM_LIST`: ワイドリスト型 - `COMMERCE`: コマース型 - `CAROUSEL_COMMERCE`: カルーセルコマース型 - `CAROUSEL_FEED`: カルーセルフィード型 - `PREMIUM_VIDEO`: プレミアム動画型 |
| `pageSize` | Integer | Optional | ページごとの項目数 - 1~100 (デフォルト: 100) |
| `pageIndex` | Integer | Optional | ページインデックス - 0~N (デフォルト: 0) |

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location --request GET 'https://sens.apigw.ntruss.com/brandmessage/v2/services/ncp:kkobizmsg:kr:16******8:sens/templates?plusFriendId=%40********' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## レスポンス

レスポンス形式を説明します。

### レスポンスボディ

レスポンスボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `items` | Array | - | 画像リスト: [items](/docs/ja/sens-brandmessage-template-list#items) |
| `pageIndex` | Integer | - | ページインデックス |
| `pageSize` | Integer | - | ページごとの項目数 |
| `itemCount` | Integer | - | レスポンス結果数 |
| `hasPrevious` | Boolean | - | 以前のページは存在するかどうか - `true` \| `false` - `true`: 存在する - `false`: 存在しない |
| `hasNext` | Boolean | - | 次のページは存在するか - `true` \| `false` - `true`: 存在する - `false`: 存在しない |
| `totalCount` | Integer | - | 総項目数 |

#### `items`

`items`の説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `createTime` | String | - | テンプレートの作成日時 - YYYY-MM-DDTHH:mm:ss.sss形式 |
| `updateTime` | String | - | テンプレートの更新日時 - YYYY-MM-DDTHH:mm:ss.sss形式 |
| `plusFriendId` | String | - | チャンネル ID |
| `templateCode` | String | - | テンプレートコード |
| `templateName` | String | - | テンプレート名 |
| `templateStatus` | String | - | テンプレートの状態 - `ACTIVE`: 正常 |
| `messageType` | String | - | メッセージタイプ - `TEXT` \| `IMAGE` \| `WIDE_IMAGE` \| `WIDE_ITEM_LIST` \| `COMMERCE` \| `CAROUSEL_COMMERCE` \| `CAROUSEL_FEED` \| `PREMIUM_VIDEO` - `TEXT`: テキスト - `IMAGE`: 画像型 - `WIDE_IMAGE`: ワイド画像型 - `WIDE_ITEM_LIST`: ワイドリスト型 - `COMMERCE`: コマース型 - `CAROUSEL_COMMERCE`: カルーセルコマース型 - `CAROUSEL_FEED`: カルーセルフィード型 - `PREMIUM_VIDEO`: プレミアム動画型 |
| `isAdult` | Boolean | - | 成人向けコンテンツフラグ |
| `headerContent` | String | - | ヘッダの内容 |
| `content` | String | - | テンプレートの内容 |
| `additionalContent` | String | - | 追加の内容 |
| `buttons` | Array | - | ボタン情報 |
| `item` | Object | - | アイテムリスト情報 |
| `image` | Object | - | 画像情報 |
| `carousel` | Object | - | カルーセル情報 |
| `commerce` | Object | - | コマース情報 |
| `video` | Object | - | 動画情報 |
| `coupon` | Object | - | クーポン情報 |

### レスポンスステータスコード

Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、[Simple & Easy Notification Serviceのレスポンスステータスコード](/docs/ja/sens-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
{
  "items": [
    {
      "plusFriendId": "@********",
      "templateCode": "99fd4b93b256ef*********************",
      "templateName": "無料クーポン発行",
      "templateStatus": "ACTIVE",
      "messageType": "TEXT",
      "isAdult": false,
      "createTime": "2025-11-19T22:57:19.949",
      "updateTime": "2025-11-25T15:01:36.265",
      "content": "#{content}",
      "buttons": [
        {
          "type": "WL",
          "name": "サイトへ",
          "linkMobile": "https://www.****.com"
        }
      ],
      "coupon": {
        "title": "NAVERクラウド無料クーポン",
        "description": "無料クーポン",
        "linkMobile": "https://www.****.com"
      }
    }
  ],
  "pageIndex": 0,
  "pageSize": 100,
  "itemCount": 1,
  "hasPrevious": false,
  "hasNext": false,
  "totalCount": 1
}
```