NHN Cloud Notification Hub Public API - Template Category 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	O	앱키
X-NHN-Authorization	Header	String	O	액세스 토큰
messageChannel	Path	Enum	O	메시지 채널
categoryId	Path	String	O	카테고리 아이디

요청 본문

이 API는 요청 본문을 요구하지 않습니다.

응답 본문

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

경로	타입	Not Null	설명
header	Object	O
header.isSuccessful	Boolean	O	요청이 성공했는지 여부를 나타냅니다. 기본값: true
header.resultCode	Integer	O	요청의 결과 코드입니다. 기본값: 0
header.resultMessage	String	O	요청의 결과 메시지입니다. 기본값: 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	O	앱키
X-NHN-Authorization	Header	String	O	액세스 토큰
messageChannel	Path	Enum	O	메시지 채널
categoryId	Path	String	O	카테고리 아이디

요청 본문

이 API는 요청 본문을 요구하지 않습니다.

응답 본문

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "category" : {
    "categoryId" : "A9z0A9z0",
    "categoryName" : "배송완료 안내 카테고리",
    "parentCategoryId" : "00000000",
    "messageChannel" : "SMS",
    "categoryIds" : [ "[1,2,3]" ],
    "templateIds" : [ "[11111111,22222222]" ]
  }
}

경로	타입	Not Null	설명
header	Object	O
header.isSuccessful	Boolean	O	요청이 성공했는지 여부를 나타냅니다. 기본값: true
header.resultCode	Integer	O	요청의 결과 코드입니다. 기본값: 0
header.resultMessage	String	O	요청의 결과 메시지입니다. 기본값: SUCCESS
category	Object	O
category.categoryId	String	O	카테고리 아이디
category.categoryName	String	O	카테고리 이름
category.parentCategoryId	String	X	상위 카테고리 아이디
category.messageChannel	String	O	메시지 채널 [SMS(SMS), ALIMTALK(알림톡), EMAIL(이메일), RCS(RCS), PUSH(푸시)]
category.categoryIds	Array	O	카테고리에 속한 카테고리 아이디 리스트
category.templateIds	Array	O	카테고리에 속한 템플릿 아이디 리스트

요청 예시

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	O	앱키
X-NHN-Authorization	Header	String	O	액세스 토큰
messageChannel	Path	Enum	O	메시지 채널
categoryId	Path	String	O	카테고리 아이디

요청 본문

{
  "name" : "배송완료 안내 카테고리",
  "parentCategoryId" : "00000000"
}

경로	타입	필수	설명
name	String	O	카테고리 이름
parentCategoryId	String	X	상위 카테고리 아이디

응답 본문

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

경로	타입	Not Null	설명
header	Object	O
header.isSuccessful	Boolean	O	요청이 성공했는지 여부를 나타냅니다. 기본값: true
header.resultCode	Integer	O	요청의 결과 코드입니다. 기본값: 0
header.resultMessage	String	O	요청의 결과 메시지입니다. 기본값: 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	O	앱키
X-NHN-Authorization	Header	String	O	액세스 토큰
messageChannel	Path	Enum	O	메시지 채널
categoryId	Path	String	O	카테고리 아이디

요청 본문

{
  "templateId" : "11111111"
}

경로	타입	필수	설명
templateId	String	X	템플릿 아이디

응답 본문

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

경로	타입	Not Null	설명
header	Object	O
header.isSuccessful	Boolean	O	요청이 성공했는지 여부를 나타냅니다. 기본값: true
header.resultCode	Integer	O	요청의 결과 코드입니다. 기본값: 0
header.resultMessage	String	O	요청의 결과 메시지입니다. 기본값: 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	O	앱키
X-NHN-Authorization	Header	String	O	액세스 토큰
messageChannel	Path	Enum	O	메시지 채널

요청 본문

이 API는 요청 본문을 요구하지 않습니다.

응답 본문

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "categories" : [ {
    "categoryId" : "A9z0A9z0",
    "categoryName" : "배송완료 안내 카테고리",
    "parentCategoryId" : "00000000",
    "messageChannel" : "SMS"
  } ]
}

경로	타입	Not Null	설명
header	Object	O
header.isSuccessful	Boolean	O	요청이 성공했는지 여부를 나타냅니다. 기본값: true
header.resultCode	Integer	O	요청의 결과 코드입니다. 기본값: 0
header.resultMessage	String	O	요청의 결과 메시지입니다. 기본값: SUCCESS
categories	Array	O
categories[].categoryId	String	O	카테고리 아이디
categories[].categoryName	String	O	카테고리 이름
categories[].parentCategoryId	String	X	상위 카테고리 아이디
categories[].messageChannel	String	O	메시지 채널 [SMS(SMS), ALIMTALK(알림톡), EMAIL(이메일), RCS(RCS), PUSH(푸시)]

요청 예시

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	O	앱키
X-NHN-Authorization	Header	String	O	액세스 토큰
messageChannel	Path	Enum	O	메시지 채널

요청 본문

{
  "parentCategoryId" : "00000000",
  "name" : "배송완료 안내 카테고리"
}

경로	타입	필수	설명
parentCategoryId	String	X	상위 카테고리 아이디
name	String	O	카테고리 이름

응답 본문

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

경로	타입	Not Null	설명
header	Object	O
header.isSuccessful	Boolean	O	요청이 성공했는지 여부를 나타냅니다. 기본값: true
header.resultCode	Integer	O	요청의 결과 코드입니다. 기본값: 0
header.resultMessage	String	O	요청의 결과 메시지입니다. 기본값: SUCCESS
categoryId	String	O	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	O	앱키
X-NHN-Authorization	Header	String	O	액세스 토큰
messageChannel	Path	Enum	O	메시지 채널
categoryTemplateName	Query	String	X	카테고리/템플릿 이름
senderProfileType	Query	Enum	X	발신 프로필 유형
senderKey	Query	String	X	발신 키
status	Query	String	X	템플릿 상태

요청 본문

이 API는 요청 본문을 요구하지 않습니다.

응답 본문

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "categories" : [ {
    "categoryId" : "A9z0A9z0",
    "categoryName" : "배송완료 안내 카테고리",
    "parentCategoryId" : "00000000",
    "messageChannel" : "SMS",
    "categories" : null,
    "templates" : [ {
      "templateId" : "11111111",
      "templateName" : "배송 완료 템플릿"
    } ]
  } ]
}

경로	타입	Not Null	설명
header	Object	O
header.isSuccessful	Boolean	O	요청이 성공했는지 여부를 나타냅니다. 기본값: true
header.resultCode	Integer	O	요청의 결과 코드입니다. 기본값: 0
header.resultMessage	String	O	요청의 결과 메시지입니다. 기본값: SUCCESS
categories	Array	O
categories[].categoryId	String	O	카테고리 아이디, 루트 카테고리(ROOT)
categories[].categoryName	String	O	카테고리 이름, 루트 카테고리(Root Category)
categories[].parentCategoryId	String	X	상위 카테고리 아이디
categories[].messageChannel	String	O	메시지 채널 [SMS(SMS), ALIMTALK(알림톡), EMAIL(이메일), RCS(RCS), PUSH(푸시)]
categories[].categories	Array	O	카테고리에 속한 카테고리 리스트
categories[].templates	Array	O	카테고리에 속한 템플릿 리스트
categories[].templates[].templateId	String	O	템플릿 아이디
categories[].templates[].templateName	String	O	템플릿 이름

요청 예시

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

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

템플릿 카테고리 삭제

템플릿 카테고리 단건 조회

템플릿 카테고리 수정

카테고리에 템플릿 추가

템플릿 카테고리 리스트 조회

템플릿 카테고리 등록

템플릿 카테고리 트리 리스트 조회

목차