NHN Cloud Notification Hub Public API - Template Category v1.0

Notification > Notification Hub > API v1.0 使用ガイド > テンプレートカテゴリー

テンプレートカテゴリーの削除

テンプレートカテゴリーを削除します。

リクエスト

DELETE /template/v1.0/{messageChannel}/categories/{categoryId}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

リクエストパラメータ

名前	区分	タイプ	必須	説明
X-NC-APP-KEY	Header	String	Y	Appkey
X-NHN-Authorization	Header	String	Y	アクセストークン
messageChannel	Path	String	Y	メッセージチャネル [SMS, RCS, ALIMTALK, EMAIL, PUSH]
categoryId	Path	String	Y	カテゴリーID

リクエスト本文

このAPIはリクエスト本文を要求しません。

レスポンス本文

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  }
}

パス	タイプ	説明
header	Object
header.isSuccessful	Boolean	リクエストの成否を示します。デフォルト値：true
header.resultCode	Integer	リクエストの結果コードです。デフォルト値：0
header.resultMessage	String	リクエストの結果メッセージです。デフォルト値：SUCCESS

リクエスト例

IntelliJ HTTP

### テンプレートカテゴリーの削除

DELETE {{endpoint}}/template/v1.0/{{messageChannel}}/categories/{{categoryId}}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

cURL

curl -X DELETE "${endpoint}/template/v1.0/${messageChannel}/categories/${categoryId}" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"

テンプレートカテゴリー単件照会

テンプレートカテゴリーを単件照会します。

リクエスト

GET /template/v1.0/{messageChannel}/categories/{categoryId}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

リクエストパラメータ

名前	区分	タイプ	必須	説明
X-NC-APP-KEY	Header	String	Y	Appkey
X-NHN-Authorization	Header	String	Y	アクセストークン
messageChannel	Path	String	Y	メッセージチャネル [SMS, RCS, ALIMTALK, EMAIL, PUSH]
categoryId	Path	String	Y	カテゴリーID

リクエスト本文

このAPIはリクエスト本文を要求しません。

レスポンス本文

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "category" : {
    "categoryId" : "A9z0A9z0",
    "categoryName" : "配送完了案内カテゴリー",
    "parentCategoryId" : "00000000",
    "messageChannel" : "SMS",
    "categoryIds" : [ "[1,2,3]" ],
    "templateIds" : [ "[11111111,22222222]" ]
  }
}

パス	タイプ	説明
header	Object
header.isSuccessful	Boolean	リクエストの成否を示します。デフォルト値：true
header.resultCode	Integer	リクエストの結果コードです。デフォルト値：0
header.resultMessage	String	リクエストの結果メッセージです。デフォルト値：SUCCESS
category	Object
category.categoryId	String	カテゴリーID
category.categoryName	String	カテゴリー名
category.parentCategoryId	String	上位カテゴリーID
category.messageChannel	String	メッセージチャネル [SMS, ALIMTALK, EMAIL, RCS, PUSH]
category.categoryIds	Array	カテゴリーに属するカテゴリーIDリスト
category.templateIds	Array	カテゴリーに属するテンプレートIDリスト

リクエスト例

IntelliJ HTTP

### テンプレートカテゴリー単件照会

GET {{endpoint}}/template/v1.0/{{messageChannel}}/categories/{{categoryId}}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

cURL

curl -X GET "${endpoint}/template/v1.0/${messageChannel}/categories/${categoryId}" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"

テンプレートカテゴリーの修正

テンプレートカテゴリーを修正します。

リクエスト

PUT /template/v1.0/{messageChannel}/categories/{categoryId}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

リクエストパラメータ

名前	区分	タイプ	必須	説明
X-NC-APP-KEY	Header	String	Y	Appkey
X-NHN-Authorization	Header	String	Y	アクセストークン
messageChannel	Path	String	Y	メッセージチャネル [SMS, RCS, ALIMTALK, EMAIL, PUSH]
categoryId	Path	String	Y	カテゴリーID

リクエスト本文

{
  "name" : "配送完了案内カテゴリー",
  "parentCategoryId" : "00000000"
}

パス	タイプ	必須	説明
name	String	Y	カテゴリー名
parentCategoryId	String	N	上位カテゴリーID

レスポンス本文

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  }
}

パス	タイプ	説明
header	Object
header.isSuccessful	Boolean	リクエストの成否を示します。デフォルト値：true
header.resultCode	Integer	リクエストの結果コードです。デフォルト値：0
header.resultMessage	String	リクエストの結果メッセージです。デフォルト値：SUCCESS

リクエスト例

IntelliJ HTTP

### テンプレートカテゴリーの修正

PUT {{endpoint}}/template/v1.0/{{messageChannel}}/categories/{{categoryId}}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

{
  "name" : "配送完了案内カテゴリー",
  "parentCategoryId" : "00000000"
}

cURL

curl -X PUT "${endpoint}/template/v1.0/${messageChannel}/categories/${categoryId}" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"  \ 
-d '{
  "name" : "配送完了案内カテゴリー",
  "parentCategoryId" : "00000000"
}'

カテゴリーにテンプレートを追加

カテゴリーにテンプレートを追加します。

リクエスト

POST /template/v1.0/{messageChannel}/categories/{categoryId}/templates
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

リクエストパラメータ

名前	区分	タイプ	必須	説明
X-NC-APP-KEY	Header	String	Y	Appkey
X-NHN-Authorization	Header	String	Y	アクセストークン
messageChannel	Path	String	Y	メッセージチャネル [SMS, RCS, ALIMTALK, EMAIL, PUSH]
categoryId	Path	String	Y	カテゴリーID

リクエスト本文

{
  "templateId" : "11111111"
}

パス	タイプ	必須	説明
templateId	String	N	テンプレートID

レスポンス本文

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  }
}

パス	タイプ	説明
header	Object
header.isSuccessful	Boolean	リクエストの成否を示します。デフォルト値：true
header.resultCode	Integer	リクエストの結果コードです。デフォルト値：0
header.resultMessage	String	リクエストの結果メッセージです。デフォルト値：SUCCESS

リクエスト例

IntelliJ HTTP

### カテゴリーにテンプレートを追加

POST {{endpoint}}/template/v1.0/{{messageChannel}}/categories/{{categoryId}}/templates
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

{
  "templateId" : "11111111"
}

cURL

curl -X POST "${endpoint}/template/v1.0/${messageChannel}/categories/${categoryId}/templates" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"  \ 
-d '{
  "templateId" : "11111111"
}'

テンプレートカテゴリー一覧照会

テンプレートカテゴリー一覧を照会します。

リクエスト

GET /template/v1.0/{messageChannel}/categories
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

リクエストパラメータ

名前	区分	タイプ	必須	説明
X-NC-APP-KEY	Header	String	Y	Appkey
X-NHN-Authorization	Header	String	Y	アクセストークン
messageChannel	Path	String	Y	メッセージチャネル [SMS, RCS, ALIMTALK, EMAIL, PUSH]

リクエスト本文

このAPIはリクエスト本文を要求しません。

レスポンス本文

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "categories" : [ {
    "categoryId" : "A9z0A9z0",
    "categoryName" : "配送完了案内カテゴリー",
    "parentCategoryId" : "00000000",
    "messageChannel" : "SMS",
    "categoryIds" : [ "[1,2,3]" ],
    "templateIds" : [ "[11111111,22222222]" ]
  } ]
}

パス	タイプ	説明
header	Object
header.isSuccessful	Boolean	リクエストの成否を示します。デフォルト値：true
header.resultCode	Integer	リクエストの結果コードです。デフォルト値：0
header.resultMessage	String	リクエストの結果メッセージです。デフォルト値：SUCCESS
categories	Array
categories[].categoryId	String	カテゴリーID
categories[].categoryName	String	カテゴリー名
categories[].parentCategoryId	String	上位カテゴリーID
categories[].messageChannel	String	メッセージチャネル [SMS, ALIMTALK, EMAIL, RCS, PUSH]
categories[].categoryIds	Array	カテゴリーに属するカテゴリーIDリスト
categories[].templateIds	Array	カテゴリーに属するテンプレートIDリスト

リクエスト例

IntelliJ HTTP

### テンプレートカテゴリー一覧照会

GET {{endpoint}}/template/v1.0/{{messageChannel}}/categories
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

cURL

curl -X GET "${endpoint}/template/v1.0/${messageChannel}/categories" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"

テンプレートカテゴリーの登録

テンプレートカテゴリーを登録します。

リクエスト

POST /template/v1.0/{messageChannel}/categories
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

リクエストパラメータ

名前	区分	タイプ	必須	説明
X-NC-APP-KEY	Header	String	Y	Appkey
X-NHN-Authorization	Header	String	Y	アクセストークン
messageChannel	Path	String	Y	メッセージチャネル [SMS, RCS, ALIMTALK, EMAIL, PUSH]

リクエスト本文

{
  "parentCategoryId" : "00000000",
  "name" : "配送完了案内カテゴリー"
}

パス	タイプ	必須	説明
parentCategoryId	String	N	上位カテゴリーID
name	String	Y	カテゴリー名

レスポンス本文

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "categoryId" : "String - Default and Example is not provided."
}

パス	タイプ	説明
header	Object
header.isSuccessful	Boolean	リクエストの成否を示します。デフォルト値：true
header.resultCode	Integer	リクエストの結果コードです。デフォルト値：0
header.resultMessage	String	リクエストの結果メッセージです。デフォルト値：SUCCESS
categoryId	String	No description

リクエスト例

IntelliJ HTTP

### テンプレートカテゴリーの登録

POST {{endpoint}}/template/v1.0/{{messageChannel}}/categories
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

{
  "parentCategoryId" : "00000000",
  "name" : "配送完了案内カテゴリー"
}

cURL

curl -X POST "${endpoint}/template/v1.0/${messageChannel}/categories" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"  \ 
-d '{
  "parentCategoryId" : "00000000",
  "name" : "配送完了案内カテゴリー"
}'

テンプレートカテゴリーツリー一覧照会

テンプレートカテゴリーのツリー一覧を照会します。

リクエスト

GET /template/v1.0/{messageChannel}/category-trees
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

リクエストパラメータ

名前	区分	タイプ	必須	説明
X-NC-APP-KEY	Header	String	Y	Appkey
X-NHN-Authorization	Header	String	Y	アクセストークン
messageChannel	Path	String	Y	メッセージチャネル [SMS, RCS, ALIMTALK, EMAIL, PUSH]
categoryTemplateName	Query	String	N	カテゴリー/テンプレート名
senderProfileType	Query	String	N	送信元プロファイルタイプ [GROUP, NORMAL]
senderKey	Query	String	N	送信キー
status	Query	String	N	テンプレート状態

リクエスト本文

このAPIはリクエスト本文を要求しません。

レスポンス本文

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "categories" : [ {
    "categoryId" : "A9z0A9z0",
    "categoryName" : "配送完了案内カテゴリー",
    "parentCategoryId" : "00000000",
    "messageChannel" : "SMS",
    "categories" : null,
    "templates" : [ {
      "templateId" : "11111111",
      "templateName" : "配送完了テンプレート"
    } ]
  } ]
}

パス	タイプ	説明
header	Object
header.isSuccessful	Boolean	リクエストの成否を示します。デフォルト値：true
header.resultCode	Integer	リクエストの結果コードです。デフォルト値：0
header.resultMessage	String	リクエストの結果メッセージです。デフォルト値：SUCCESS
categories	Array
categories[].categoryId	String	カテゴリーID、ルートカテゴリー(ROOT)
categories[].categoryName	String	カテゴリー名、ルートカテゴリー(Root Category)
categories[].parentCategoryId	String	上位カテゴリーID
categories[].messageChannel	String	メッセージチャネル [SMS, ALIMTALK, EMAIL, RCS, PUSH]
categories[].categories	Array	カテゴリーに属するカテゴリーリスト
categories[].templates	Array	カテゴリーに属するテンプレートリスト

リクエスト例

IntelliJ HTTP

### テンプレートカテゴリーツリー一覧照会

GET {{endpoint}}/template/v1.0/{{messageChannel}}/category-trees
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

cURL

curl -X GET "${endpoint}/template/v1.0/${messageChannel}/category-trees" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"

テンプレートカテゴリーの削除
テンプレートカテゴリー単件照会
テンプレートカテゴリーの修正
カテゴリーにテンプレートを追加
テンプレートカテゴリー一覧照会
テンプレートカテゴリーの登録
テンプレートカテゴリーツリー一覧照会

TOP

NHN Cloud Notification Hub Public API - Template Category v1.0

テンプレートカテゴリーの削除

テンプレートカテゴリー単件照会

テンプレートカテゴリーの修正

カテゴリーにテンプレートを追加

テンプレートカテゴリー一覧照会

テンプレートカテゴリーの登録

テンプレートカテゴリーツリー一覧照会

目次