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

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

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

リクエスト

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

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

リクエストヘッダ

Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。

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

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

フィールド	タイプ	必須の有無	説明
`serviceId`	String	Required	Biz Messageサービス ID プロジェクトリストの照会を参照

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

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

フィールド	タイプ	必須の有無	説明
`plusFriendId`	String	Required	チャンネル ID チャンネルの照会を参照
`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	Required	画像リスト
`pageIndex`	Integer	Required	ページインデックス
`pageSize`	Integer	Required	ページごとの項目数
`itemCount`	Integer	Required	レスポンス結果数
`hasPrevious`	Boolean	Required	以前のページは存在するかどうか `true` \| `false` `true`: 存在する `false`: 存在しない
`hasNext`	Boolean	Required	次のページは存在するか `true` \| `false` `true`: 存在する `false`: 存在しない
`totalCount`	Integer	Required	総項目数

`items`

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

フィールド	タイプ	必須の有無	説明
`createTime`	String	Required	テンプレートの作成日時 YYYY-MM-DDTHH:mm:ss.sss形式
`updateTime`	String	Optional	テンプレートの更新日時 YYYY-MM-DDTHH:mm:ss.sss形式
`plusFriendId`	String	Required	チャンネル ID
`templateCode`	String	Required	テンプレートコード
`templateName`	String	Required	テンプレート名
`templateStatus`	String	Required	テンプレートの状態 `ACTIVE`: 正常
`messageType`	String	Required	メッセージタイプ `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	Required
`headerContent`	String	Optional	ヘッダの内容
`content`	String	Optional	テンプレートの内容
`additionalContent`	String	Optional	ヘッダの内容
`buttons`	Array	Optional	ボタン情報
`item`	Object	Optional	アイテムリスト情報
`image`	Object	Optional	画像情報
`carousel`	Object	Optional	カルーセル情報
`commerce`	Object	Optional	コマース情報
`video`	Object	Optional	動画情報
`coupon`	Object	Optional	クーポン情報

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

Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
  "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
}