テンプレートの照会

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

通知トークのテンプレート情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

フィールド	タイプ	必須の有無	説明
`channelId`	String	Required	チャンネル ID チャンネルの照会を参照
`templateCode`	String	Optional	テンプレート入力時、テンプレートの詳細情報(検収内容、付加情報など)を返す
`templateName`	String	Optional	テンプレート名完全一致または一部一致する値を絞り込む
`pageSize`	Integer	Optional	ページごとの項目数 1~100 (デフォルト: 100)
`pageIndex`	Integer	Optional	ページインデックス 0~N (デフォルト: 0)

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`createTime`	String	-	テンプレートの作成日時 YYYY-MM-DDTHH:mm:ss.sss形式
`updateTime`	String	-	テンプレートの更新日時 YYYY-MM-DDTHH:mm:ss.sss形式
`channelId`	String	-	チャンネル ID
`templateCode`	String	-	テンプレートコード
`templateName`	String	-	テンプレート名
`categoryCode`	String	-	テンプレートカテゴリコード
`categoryName`	String	-	テンプレートカテゴリ
`messageType`	String	-	メッセージタイプ `BA` \| `EX` \| `AD` \| `MI` `BA`: 基本型 `EX`: 付加情報型 `AD`: チャンネル追加型 `MI`: 複合型
`emphasizeType`	String	-	強調タイプ `NONE` \| `TEXT` \| `IMAGE` \| `ITEM_LIST` `NONE`: 基本型 `TEXT`: 強調表記型 `IMAGE`: 画像型 `ITEM_LIST`: アイテムリスト型
`content`	String	-	テンプレートの内容
`adContent`	String	-	広告内容広告内容が存在する場合に表示
`extraContent`	String	-	付加情報の内容付加情報がある場合に表示
`title`	String	-	強調情報のタイトル
`additionalTitle`	String	-	強調情報のサブタイトル
`comments`	Array	-	検収情報: comments テンプレート詳細照会時に表示
`templateInspectionStatus`	String	-	検収状態 `ACCEPT` \| `REGISTER` \| `INSPECT` \| `COMPLETE` \| `REJECT` `ACCEPT`: 受付 `REGISTER`: 待機中 `INSPECT`: 処理中 `COMPLETE`: 完了 `REJECT`: 却下
`templateStatus`	String	-	テンプレートの状態 `ACTIVE` \| `READY` \| `NOT_REGISTER` \| `STOP` `ACTIVE`: 正常 `READY`: 登録完了 `NOT_REGISTER`: 登録待ち `STOP`: 停止
`buttons`	Array	-	ボタンリスト: buttons 最大5個
`securityFlag`	Boolean	-	セキュリティを設定するか `true` \| `false` `true`: 設定 `false`: 設定しない
`isBlock`	Boolean	-	ブロックされているか `true` \| `false` `true`: ブロック `false`: ブロックされていない
`isDormant`	Boolean	-	休眠状態か `true` \| `false` `true`: 休眠状態 `false`: 休眠状態ではない
`useImage`	Boolean	-	画像を使用するか `true` \| `false` `true`: 使用 `false`: 使用しない
`imageName`	String	-	画像ファイル名
`imageUrl`	String	-	画像 URL
`useHeaderContent`	Boolean	-	ヘッダを使用するか `true` \| `false` `true`: 使用 `false`: 使用しない
`headerContent`	String	-	ヘッダの内容
`useItemHighlight`	Boolean	-	アイテムハイライトを使用するか `true` \| `false` `true`: 使用 `false`: 使用しない
`useItemHighlightImage`	Boolean	-	アイテムハイライト画像を使用するか `true` \| `false` `true`: 使用 `false`: 使用しない
`itemHighlight`	Object	-	アイテムハイライト情報
`itemHighlight.title`	String	-	アイテムハイライトの件名
`itemHighlight.description`	String	-	アイテムハイライトの内容
`itemHighlight.imageUrl`	String	-	アイテムハイライトの画像 URL
`item`	Object	-	アイテムリスト情報
`item.list`	Array	-	アイテムリスト: list
`item.summary`	Object	-	アイテムサマリー情報
`item.summary.title`	String	-	アイテムサマリーのタイトル
`item.summary.description`	String	-	アイテムサマリーの説明

`comments`

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

フィールド	タイプ	必須の有無	説明
`commentId`	String	-	検収 ID
`content`	String	-	検収の内容
`status`	String	-	検収状況 `APR` \| `REJ` `APR`: 検収完了 `REJ`: 検収棄却
`createTime`	String	-	検収日時 YYYY-MM-DD HH:mm:ss形式
`attachment`	Array	-	検収の問い合わせ内容添付ファイル: attachment

`attachment`

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

フィールド	タイプ	必須の有無	説明
`fileName`	String	-	添付ファイル名
`fileUrl`	String	-	添付ファイルの URL

`buttons`

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

フィールド	タイプ	必須の有無	説明
`order`	Integer	-	ボタンの順番
`type`	String	-	ボタンタイプ `DS` \| `WL` \| `AL` \| `BK` \| `MD` \| `AC` `DS`: 配送状況追跡 `WL`: ウェブリンク `AL`: アプリリンク `BK`: ボットキーワード `MD`: メッセージ伝達 `AC`: チャンネル追加
`name`	String	-	ボタン名
`linkMobile`	String	-	モバイルウェブリンク
`linkPc`	String	-	PCウェブリンク
`schemeIos`	String	-	iOSアプリリンク
`schemeAndroid`	String	-	Androidアプリリンク

`list`

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

フィールド	タイプ	必須の有無	説明
`title`	String	-	アイテム名
`description`	String	-	アイテム内容

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

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

レスポンス例

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

リスト照会時

[
  {
    "createTime": "2025-11-25T10:38:52.604",
    "updateTime": "2025-11-25T10:41:21.538",
    "channelId": "@********",
    "templateCode": "templatecode1",
    "templateName": "t001"
  }
]

詳細照会時(templateCodeを含めて照会)

[
    {
        "createTime": "2025-11-25T10:38:52.604",
        "updateTime": "2025-11-25T10:41:21.538",
        "channelId": "@********",
        "templateCode": "templatecode1",
        "templateName": "t001",
        "categoryCode": "009001",
        "categoryName": "クーポンの発行",
        "messageType": "BA",
        "emphasizeType": "TEXT",
        "content": " 新規のお客様にウェルカムクーポン進呈!\n今すぐ会員登録して、その場ですぐに使える\n5,000ウォンクーポンをゲットしましょう。\n クーポンを受け取る: #{URL}",
        "title": "新規のお客様特典",
        "additionalTitle": "新規のお客様にウェルカムクーポン進呈",
        "comments": [],
        "templateInspectionStatus": "REGISTER",
        "templateStatus": "READY",
        "buttons": [],
        "securityFlag": false,
        "isBlock": false,
        "isDormant": false,
        "useImage": false,
        "useHeaderContent": false,
        "useItemHighlight": false
    }
]