템플릿등록
API 정보 |
• 템플릿을 신규 등록합니다. 사전에 발신프로필 또는 발신 프로필 그룹이 등록 되어있어야 합니다. • POST /v3/kakao/template/add • Content-Type: application/json; charset=utf-8 |
||||
요청 파라미터 | |||||
키 | - | - | 타입 | 필수 |
설명 |
bizId | String | O | BIZPPURIO ID | ||
apiKey | String | O | API 발급 키 | ||
senderKey | String | O | 발신 프로필 키(senderKeyType이 G인 경우 프로필 그룹키) | ||
senderKeyType | String | X | 발신 프로필 키 타입 (S:일반(default), G:그룹) | ||
templateCode | String | X | 템플릿 코드 (영문, 숫자, 언더바(_), 하이픈(-)만 입력 가능, 최대 30자, 빈 값일 경우 자동 생성) | ||
templateName | String | O | 템플릿 이름 | ||
templateMessageType | String | O |
템플릿 메시지 유형 (BA:기본형, EX:부가정보형, AD:채널추가형, MI:복합형) - EX, MI : templateExtra 필드 필수 - AD, MI : buttons(AC) 자동 삽입 |
||
templateEmphasizeType | String | O |
템플릿 강조 유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, ITEM_LIST: 아이템리스트형) - TEXT : templateTitle, templateSubtitle 필수 - ITEM_LIST: templateItem.list 필드 필수, templateImage(Name,Url), templateHeader, templateItemHighlight 필드 중 1개 이상 필수, templateItem.summary 필드 사용 가능 - IMAGE: templateImageName, templateImageUrl 필드 필수 |
||
templateContent | String | O | 템플릿 내용 | ||
templateExtra | String | X |
부가정보 - templateMessageType “EX”, “MI” 선택 시 필수 |
||
templateImageName | String | X |
템플릿 이미지 파일명 - templateEmphasizeType “IMAGE” 선택 시 필수 |
||
templateImageUrl | String | X |
템플릿 이미지 링크 - templateEmphasizeType “IMAGE” 선택 시 필수 |
||
templateTitle | String | X |
템플릿 내용 중 강조 표기할 핵심 정보 - templateEmphasizeType “TEXT” 선택 시 필수 |
||
templateSubtitle | String | X |
강조 표기 보조 문구 - templateEmphasizeType “TEXT” 선택 시 필수 |
||
templateHeader | String | X | 헤더 (최대 16자까지 입력 가능) | ||
templateItemHighlight | Object | X | 아이템 하이라이트 | ||
title | String | O | 타이틀 (최대 30자까지 입력 가능, 썸네일 이미지가 있을 경우 21자까지 입력) | ||
description | String | O | 상세 설명 (최대 19자까지 입력 가능, 썸네일 이미지가 있을 경우 13자까지 입력) | ||
imageUrl | String | X | 썸네일 이미지 주소 (최대 500자까지 입력 가능) | ||
templateItem | Object | X | 아이템 정보 | ||
list | Array | O |
아이템 리스트 (최소 2개, 최대 10개) - templateEmphasizeType “ITEM_LIST” 선택 시 필수 |
||
title | String | O | 타이틀 (최대 6자까지 입력 가능) | ||
description | String | O | 디스크립션 (최대 23자까지 입력 가능) | ||
summary | Object | X | 아이템 요약 정보 | ||
title | String | O | 타이틀 (최대 6자까지 입력 가능) | ||
description | String | O | 디스크립션 (변수 및 화폐 단위, 숫자, 쉼표, 마침표만 사용 가능, 최대 14자까지 입력 가능) | ||
categoryCode | String | O | 템플릿 카테고리 코드 | ||
securityFlag | Boolean | X |
보안 템플릿 여부, OTP등 보안 메시지 일 경우 설정 발신 당시의 메인 디바이스를 제외한 모든 디바이스에 메시지 텍스트 미 노출 (true:설정, false:미설정) |
||
buttons | Array | X | 버튼 정보 (최대 5개 등록 가능, 바로 연결과 함께 사용 시 최대 2개로 제한) | ||
name | String | O |
버튼명 - linkType “AC” 선택 시 버튼명은 “채널추가” 로 고정 |
||
linkType | String | O |
버튼 링크타입 (DS:배송조회, WL:웹링크, AL:앱링크, BK:봇키워, MD: 메시지전달, AC: 채널추가, BC: 상담톡전환, BT: 봇전환, P1: 이미지 보안전송 플러그인, P2 : 개인정보이용 플러그인, P3: 원클릭 결제 플러그인) |
||
linkAnd | String | X |
Android 앱 링크 주소 (AL 사용시 필수) - linkIos, linkAnd, linkMo 중 2가지 필수 입력 |
||
linkIos | String | X | IOS 앱 링크 주소 (AL 사용시 필수) | ||
linkMo | String | X | 모바일 웹 링크 주소 (WL 사용시 필수) | ||
linkPc | String | X | PC 웹 링크 주소 (WL 사용시 선택) | ||
pluginId | String | X | 플러그인 ID (P1, P2, P3 사용시 필수) | ||
quickReplies | Array | X |
바로연결 정보 (최대 10개 등록 가능) - 상담톡 이용 채널에 한해 바로연결 기능 사용이 가능 |
||
name | String | O | 바로연결명 | ||
linkType | String | O |
바로연결 링크타입 (WL:웹링크, AL:앱링크, BK:봇키워드, MD: 메시지전달, BC : 상담톡전환, BT: 봇전환) |
||
linkAnd | String | X | Android 앱 링크 주소 (AL 사용시 필수) | ||
linkIos | String | X | IOS 앱 링크 주소 (AL 사용시 필수) | ||
linkMo | String | X | 모바일 웹 링크 주소 (WL 사용시 필수) | ||
linkPc | String | X | PC 웹 링크 주소 (WL 사용시 선택) | ||
반환 값 | |||||
키 | - | 타입 | 설명 | ||
code | String | 결과 코드 | |||
message | String | 실패 시 결과 메시지 | |||
data | Object | 성공 시 템플릿 정보 (3.5 템플릿 상세조회 반환 값 참조) |
※ 템플릿의 등록/확인은 아래의 예제를 참조
템플릿 등록 : https://kapi.ppurio.com/kakao/template/add
{
"senderKey": "05aa099bcbc5220a8c0b2XXXXXXXXXXXXX", "senderKeyType": "S",
"templateName": "봇키워드 버튼 템플릿", "templateContent": "봇키워드 테스트", "templateMessageType": "MI", "templateExtra": "부가정보입니다", "templateAd": "광고성메시지입니다",
"buttons": [ { "linkType": "BK", "name": "봇키워드 버튼" } ], "bizId": "kakaoapi",
"apiKey": "Q4jh8oXXXXXXXX"
}
실행결과
{
"data" : { "templateCode" : "test_2018041710484103734482096" }, "code" : "200",
"message" : ""
}
등록된 템플릿 확인 : https://kapi.ppurio.com/kakao/template/detail
{
"senderKey": "05aa099bcbc5220a8c0b2XXXXXXXXXXXXX", "bizId": "kakaoapi",
"apiKey": " Q4jh8oXXXXXXXX" , "templateCode":"test_2018041710484103734482096"
}
실행결과
{
"data" : {
"templateCode" : "test_2018041710484103734482096", "templateName" : "봇키워드 버튼 템플릿", "templateContent" : "봇키워드 테스트", "inspectionStatus" : "REG",
"createdAt" : "2018-04-17 10:48:42",
"buttonSize" : 1,
"commentSize" : 0, "buttons" : [ {
"linkType" : "BK",
"name" : "봇키워드 버튼",
"linkAnd" : "",
"linkIos" : "",
"linkPc" : "",
"linkMo" : ""
} ],
"comments" : [ ]
},
"code" : "200",
"message" : ""
}
템플릿 코드 유효성 검증
API 정보 |
• 발신프로필에 등록된 템플릿 목록을 조회합니다. • POST /v3/kakao/template/list • Content-Type: application/json; charset=utf-8 |
|||
요청 파라미터 | ||||
키 | - | 타입 | 필수 |
설명 |
bizId | String | O | BIZPPURIO ID | |
apiKey | String | O | API 발급 키 | |
senderKey | String | O | 발신 프로필 키 (senderKeyType이 G인 경우 프로필 그룹키) | |
senderKeyType | String | X | 발신 프로필 키 타입 (S:일반(default), G:그룹) | |
templateStatus | String | X |
템플릿 상태 (REG: 등록, REQ: 검수요청, REJ: 반려, STP: 차단, RDY: 발송전, ACT: 정상, DMT: 휴면, BLK: 차단) |
|
page | String | X | 요청 페이지 (default: 1) | |
count | String | X | 페이지 별 템플릿 개수 (default: 30) | |
keyword | String | X | 검색 키워드 (글자 수 2자 ~ 50자 제한) | |
startDate | String | X | 생성일자 기준 시작일자 (yyyyMMddHHmmss) | |
endDate | String | X | 생성일자 기준 종료일자 (yyyyMMddHHmmss) | |
categoryCodeList | Array | X | 검색 대상의 템플릿 카테고리 코드 목록 | |
String | O | 카테고리 코드 | ||
반환 값 | ||||
키 | - | - | 타입 | 설명 |
code | String | 결과 코드 | ||
message | String | 실패 시 결과 메시지 | ||
totalCount | Integer | 총 개수 | ||
totalPage | Integer | 총 페이지 수 | ||
currentPage | Integer | 현재 페이지 | ||
data | list | Array | 성공 시 템플릿 목록 | |
senderKey | String | 발신프로필 키 | ||
senderKeyType | String | 발신프로필 키 타입 | ||
templateCode | String | 템플릿 코드 | ||
templateName | String | 템플릿 이름 | ||
categoryCode | String | 템플릿 카테고리 코드 | ||
createdAt | String | 등록일 | ||
modifiedAt | String | 수정일 | ||
serviceStatus | String |
템플릿 상태 (REG: 등록, REQ: 검수요청, REJ: 반려, STP: 차단, RDY: 발송전, ACT: 정상, DMT: 휴면, BLK: 차단) |
템플릿 목록 조회
API 정보 |
• 발신프로필에 등록된 템플릿 목록을 조회합니다. • POST /v3/kakao/template/list • Content-Type: application/json; charset=utf-8 |
|||
요청 파라미터 | ||||
키 | - | 타입 | 필수 |
설명 |
bizId | String | O | BIZPPURIO ID | |
apiKey | String | O | API 발급 키 | |
senderKey | String | O | 발신 프로필 키 (senderKeyType이 G인 경우 프로필 그룹키) | |
senderKeyType | String | X | 발신 프로필 키 타입 (S:일반(default), G:그룹) | |
templateStatus | String | X |
템플릿 상태 (REG: 등록, REQ: 검수요청, REJ: 반려, STP: 차단, RDY: 발송전, ACT: 정상, DMT: 휴면, BLK: 차단) |
|
page | String | X | 요청 페이지 (default: 1) | |
count | String | X | 페이지 별 템플릿 개수 (default: 30) | |
keyword | String | X | 검색 키워드 (글자 수 2자 ~ 50자 제한) | |
startDate | String | X | 생성일자 기준 시작일자 (yyyyMMddHHmmss) | |
endDate | String | X | 생성일자 기준 종료일자 (yyyyMMddHHmmss) | |
categoryCodeList | Array | X | 검색 대상의 템플릿 카테고리 코드 목록 | |
String | O | 카테고리 코드 | ||
반환 값 | ||||
키 | - | 타입 | 설명 | |
code | String | 결과 코드 | ||
message | String | 실패 시 결과 메시지 | ||
totalCount | Integer | 총 개수 | ||
totalPage | Integer | 총 페이지 수 | ||
currentPage | Integer | 현재 페이지 | ||
data | list | Array | 성공 시 템플릿 목록 | |
senderKey | String | 발신프로필 키 | ||
senderKeyType | String | 발신프로필 키 타입 | ||
templateCode | String | 템플릿 코드 | ||
templateName | String | 템플릿 이름 | ||
categoryCode | String | 템플릿 카테고리 코드 | ||
createdAt | String | 등록일 | ||
modifiedAt | String | 수정일 | ||
serviceStatus | String |
템플릿 상태 (REG: 등록, REQ: 검수요청, REJ: 반려, STP: 차단, RDY: 발송전, ACT: 정상, DMT: 휴면, BLK: 차단) |
템플릿 상세 조회
API 정보 |
• 템플릿을 조회 합니다. • POST /v3/kakao/template/detail • Content-Type: application/json; charset=utf-8 |
||||
요청 파라미터 |
|||||
키 | - | 타입 | 필수 |
설명 |
|
bizId | String | O |
BIZPPURIO ID |
||
apiKey | String | O |
API 발급 키 |
||
senderKey | String | O |
발신 프로필 키(senderKeyType이 G인 경우 프로필 그룹키) |
||
senderKeyType | String | X |
발신 프로필 키 타입 (S:일반(default), G:그룹) |
||
templateCode | String | O |
템플릿 코드 |
||
반환 값 |
|||||
키 | - | 타입 | 설명 | ||
code | String | 결과 코드 | |||
message | String | 실패 시 결과 메시지 | |||
data | Object | 성공 시 템플릿 정보 | |||
templateCode | String | 템플릿 코드 | |||
templateName | String | 템플릿 이름 | |||
templateMessageType | String |
템플릿 메시지 유형 (BA:기본형(default), EX:부가정보형, AD:채널추가형, MI:복합형) |
|||
templateEmphasizeType | String |
템플릿 강조 유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, ITEM_LIST: 아이템리스트형) |
|||
templateContent | String | 템플릿 내용 | |||
templateExtra | String | 부가정보 | |||
templateImageName | String | 템플릿 이미지 파일명 | |||
templateImageUrl | String | 템플릿 이미지 링크 | |||
templateTitle | String | 템플릿 내용 중 강조 표기할 핵심 정보 | |||
templateSubtitle | String | 강조 표기 보조 문구 | |||
templateHeader | String | 헤더 | |||
templateItemHighlight | Object | 아이템 하이라이트 | |||
title | String | 타이틀 | |||
description | String | 상세 설명 | |||
imageUrl | String | 썸네일 이미지 주소 | |||
templateItem | Object | 아이템 정보 | |||
list | Array | 아이템 리스트 | |||
title | String | 타이틀 | |||
description | String | 디스크립션 | |||
summary | Object | 아이템 요약 정보 | |||
title | String | 타이틀 | |||
description | String | 디스크립션 | |||
categoryCode | String | 템플릿 카테고리 코드 | |||
securityFlag | Boolean | 보안 템플릿 여부 (true:설정, false:미설정) | |||
inspectionStatus | String | 검수 상태 (REG: 등록, REQ: 검수요청, REJ: 반려, APR : 승인) | |||
createdAt | String | 생성일 | |||
modifiedAt | String | 수정일 | |||
status |
String | 템플릿 상태(S:중지, A:정상, R:대기(발송전)) | |||
block | Boolean | 템플릿 차단 여부 (true:차단, false: 해제) | |||
dormant | Boolean | 템플릿 휴면 여부 (true:휴면, false: 해제) | |||
buttons | Array | 버튼 정보 | |||
name | String | 버튼명 | |||
linkType | String | 버튼 링크타입 (DS:배송조회, WL:웹링크, AL:앱링크, BK:봇키워, MD: 메시지전달, AC: 채널추가, BC: 상담톡전환, BT: 봇전환, P1: 이미지 보안전송 플러그인, P2 : 개인정보이용 플러그인, P3: 원클릭 결제 플러그인) |
|||
linkAnd | String | Android 앱 링크 주소 | |||
linkIos | String | IOS 앱 링크 주소 | |||
linkMo | String | 모바일 웹 링크 주소 | |||
linkPc | String | PC 웹 링크 주소 | |||
pluginId | String | 플러그인 ID | |||
quickReplies | Array | 바로연결 정보 | |||
name | String | 바로연결명 | |||
linkType | String |
바로연결 링크타입 (WL:웹링크, AL:앱링크, BK:봇키워드, MD: 메시지전달, BC : 상담톡전환, BT: 봇전환) |
|||
linkAnd | String | Android 앱 링크 주소 | |||
linkIos | String | IOS 앱 링크 주소 | |||
linkMo | String | 모바일 웹 링크 주소 | |||
linkPc | String | PC 웹 링크 주소 | |||
comments | Array | 댓글 목록 | |||
content | String | 댓글 본문 | |||
createdAt | String | 댓글 생성일 | |||
status | String |
댓글 상태 (REQ:등록, INQ:문의, APR:승인, REJ:반려, REP:답변) |
|||
userName | String | 댓글 작성자 | |||
attachment | Array | 첨부파일 | |||
originalFileName | String | 업로드한 파일 이름 | |||
filePath | String | 파일 다운로드 경로 |
템플릿 수정
API 정보 |
• 등록된 템플릿을 수정합니다. 템플릿 상태가 대기(R)이고 템플릿 검수상태가 등록(REG) 또는 반려(REJ)인 경우에만 수정 가능합니다. • POST /v3/kakao/template/update • Content-Type: application/json; charset=utf-8 |
|||||
요청 파라미터 |
||||||
키 | - | 타입 | 필수 |
설명 |
||
bizId | String | O | BIZPPURIO ID | |||
apiKey | String | O | API 발급 키 | |||
senderKey | String | O | 발신 프로필 키(senderKeyType이 G인 경우 프로필 그룹키) | |||
senderKeyType | String | X | 발신 프로필 키 타입 (S:일반(default), G:그룹) | |||
templateCode | String | O | 기존 템플릿 코드 | |||
newTemplateCode | String | X | 수정하려는 템플릿 코드 (영문, 숫자, 언더바(_), 하이픈(-)만 입력 가능, 최대 30자) | |||
templateName | String | O | 템플릿 이름 | |||
templateMessageType | String | O |
템플릿 메시지 유형 (BA:기본형, EX:부가정보형, AD:채널추가형, MI:복합형) - EX, MI : templateExtra 필드 필수 - AD, MI : buttons(AC) 자동 삽입 |
|||
templateEmphasizeType | String | O |
템플릿 강조 유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, ITEM_LIST: 아이템리스트형) - TEXT : templateTitle, templateSubtitle 필수 - ITEM_LIST: templateItem.list 필드 필수, templateImage(Name,Url), templateHeader, templateItemHighlight 필드 중 1개 이상 필수, templateItem.summary 필드 사용 가능 - IMAGE: templateImageName, templateImageUrl 필드 필수 |
|||
templateContent | String | O | 템플릿 내용 | |||
templateExtra | String | X |
부가정보 - templateMessageType “EX”, “MI” 선택 시 필수 |
|||
templateImageName | String | X |
템플릿 이미지 파일명 - templateEmphasizeType “IMAGE” 선택 시 필수 |
|||
templateImageUrl | String | X |
템플릿 이미지 링크 - templateEmphasizeType “IMAGE” 선택 시 필수 |
|||
templateTitle | String | X |
템플릿 내용 중 강조 표기할 핵심 정보 - templateEmphasizeType “TEXT” 선택 시 필수 |
|||
templateSubtitle | String | X |
강조 표기 보조 문구 - templateEmphasizeType “TEXT” 선택 시 필수 |
|||
templateHeader | String | X | 헤더 (최대 16자까지 입력 가능) | |||
templateItemHighlight | Object | X | 아이템 하이라이트 | |||
title | String | O | 타이틀 (최대 30자까지 입력 가능, 썸네일 이미지가 있을 경우 21자까지 입력) | |||
description | String | O | 상세 설명 (최대 19자까지 입력 가능, 썸네일 이미지가 있을 경우 13자까지 입력) | |||
imageUrl | String | X | 썸네일 이미지 주소 (최대 500자까지 입력 가능) | |||
templateItem | Object | X | 아이템 정보 | |||
list | Array | O |
아이템 리스트 (최소 2개, 최대 10개) - templateEmphasizeType “ITEM_LIST” 선택 시 필수 |
|||
title | String | O | 타이틀 (최대 6자까지 입력 가능) | |||
description | String | O | 디스크립션 (최대 23자까지 입력 가능) | |||
summary | Object | X | 아이템 요약 정보 | |||
title | String | O | 타이틀 (최대 6자까지 입력 가능) | |||
description | String | O | 디스크립션 (변수 및 화폐 단위, 숫자, 쉼표, 마침표만 사용 가능, 최대 14자까지 입력 가능) | |||
categoryCode | String | O | 템플릿 카테고리 코드 | |||
securityFlag | Boolean | X | 보안 템플릿 여부, OTP등 보안 메시지 일 경우 설정 발신 당시의 메인 디바이스를 제외한 모든 디바이스에 메시지 텍스트 미 노출 (true:설정, false:미설정) |
|||
buttons | Array | X | 버튼 정보 (최대 5개 등록 가능, 바로 연결과 함께 사용 시 최대 2개로 제한) | |||
name | String | O |
버튼명 - linkType “AC” 선택 시 버튼명은 “채널추가” 로 고정 |
|||
linkType | String | O | 버튼 링크타입 (DS:배송조회, WL:웹링크, AL:앱링크, BK:봇키워, MD: 메시지전달, AC: 채널추가, BC: 상담톡전환, BT: 봇전환, P1: 이미지 보안전송 플러그인, P2 : 개인정보이용 플러그인, P3: 원클릭 결제 플러그인) |
|||
linkAnd | String | X | Android 앱 링크 주소 (AL 사용시 필수) | |||
linkIos | String | X | IOS 앱 링크 주소 (AL 사용시 필수) | |||
linkMo | String | X | 모바일 웹 링크 주소 (WL 사용시 필수) | |||
linkPc | String | X | PC 웹 링크 주소 (WL 사용시 선택) | |||
pluginId | String | X | 플러그인 ID (P1, P2, P3 사용시 필수) | |||
quickReplies | Array | X |
바로연결 정보 (최대 10개 등록 가능) - 상담톡 이용 채널에 한해 바로연결 기능 사용이 가능 |
|||
name | String | O | 바로연결명 | |||
linkType | String | O |
바로연결 링크타입 (WL:웹링크, AL:앱링크, BK:봇키워드, MD: 메시지전달, BC : 상담톡전환, BT: 봇전환) |
|||
linkAnd | String | X | Android 앱 링크 주소 (AL 사용시 필수) | |||
linkIos | String | X | IOS 앱 링크 주소 (AL 사용시 필수) | |||
linkMo | String | X | 모바일 웹 링크 주소 (WL 사용시 필수) | |||
linkPc | String | X | PC 웹 링크 주소 (WL 사용시 선택) | |||
반환 값 |
||||||
키 | - | 타입 | 설명 | |||
code | String | 결과 코드 | ||||
message | String | 실패 시 결과 메시지 | ||||
data | Object | 성공 시 템플릿 정보 (3.5 템플릿 상세조회 반환 값 참조) |
템플릿 삭제
API 정보 |
• 등록된 템플릿을 삭제합니다. 템플릿 상태가 대기(R)이고 템플릿 검수상태가 등록(REG) 또는 반려(REJ)인 경우에만 삭제 가능합니다. • POST /v3/kakao/template/delete • Content-Type: application/json; charset=utf-8 |
|||
요청 파라미터 | ||||
키 | - | 타입 | 필수 |
설명 |
bizId | String | O | BIZPPURIO ID | |
apiKey | String | O | API 발급 키 | |
senderKey | String | O | 발신 프로필 키(senderKeyType이 G인 경우 프로필 그룹키) | |
senderKeyType | String | X | 발신 프로필 키 타입 (S:일반(default), G:그룹) | |
templateCode | String | O | 템플릿 코드 | |
반환 값 | ||||
키 | - | 타입 | 설명 | |
code | String | 결과 코드 | ||
message | String | 실패 시 결과 메시지 | ||
data | Array | 성공 시 카테고리 목록 | ||
code | String | 카테고리 코드 | ||
name | String | 카테고리 이름 | ||
groupName | String | 카테고리 그룹 이름 | ||
Inclusion | String | 카테고리 적용 대상 템플릿 설명 | ||
exclusion | String | 카테고리 제외 대상 템플릿 설명 |
템플릿 카테고리 전체 조회
API 정보 |
• 템플릿 등록시 사용할 카테고리 목록 전체를 조회합니다. • POST /v3/kakao/template/category/all • Content-Type: application/json; charset=utf-8 |
||
요청 파라미터 | |||
키 | 타입 | 필수 |
설명 |
bizId | String | O | BIZPPURIO ID |
apiKey | String | O | API 발급 키 |
반환 값 | |||
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 | |
data | Array | 성공 시 카테고리 목록 | |
code | String | 카테고리 코드 | |
name | String | 카테고리 이름 | |
groupName | String | 카테고리 그룹 이름 | |
Inclusion | String | 카테고리 적용 대상 템플릿 설명 | |
exclusion | String | 카테고리 제외 대상 템플릿 설명 |
템플릿 카테고리 조회
API 정보 |
• 카테고리 코드에 해당하는 특정 템플릿 카테고리를 조회합니다. • POST /v3/kakao/template/category • Content-Type: application/json; charset=utf-8 |
||
요청 파라미터 | |||
키 | 타입 | 필수 |
설명 |
bizId | String | O | BIZPPURIO ID |
apiKey | String | O | API 발급 키 |
categoryCode | String | O | 카테고리 코드 |
반환 값 | |||
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 | |
data | Object | 성공 시 카테고리 정보 | |
code | String | 카테고리 코드 | |
name | String | 카테고리 이름 | |
groupName | String | 카테고리 그룹 이름 | |
Inclusion | String | 카테고리 적용 대상 템플릿 설명 | |
exclusion | String | 카테고리 제외 대상 템플릿 설명 |
템플릿 검수 요청
API 정보 |
• 등록된 템플릿을 검수 요청합니다. 템플릿 상태가 대기(R)이고 템플릿 검수상태가 등록(REG)인 경우에만 요청 가능합니다. • POST /v3/kakao/template/request • Content-Type: application/json; charset=utf-8 |
||
요청 파라미터 | |||
키 | 타입 | 필수 |
설명 |
bizId | String | O | BIZPPURIO ID |
apiKey | String | O | API 발급 키 |
senderKey | String | O | 발신 프로필 키(senderKeyType이 G인 경우 프로필 그룹키) |
senderKeyType | String | X | 발신 프로필 키 타입 (S:일반(default), G:그룹) |
templateCode | String | O | 템플릿 코드 |
comment | String | X | 의견 또는 문의사항 (최대 500자까지 입력 가능) |
반환 값 | |||
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 |
템플릿 검수 요청 (파일첨부)
API 정보 |
• 등록된 템플릿을 검수 요청합니다. 템플릿 상태가 대기(R)이고 템플릿 검수상태가 등록(REG)인 경우에만 요청 가능합니다. 파일과 함께 문의 또는 의견을 남길수 있습니다. 파일 형식은 png, jpg, jpge, gif, pdf, hwp, doc, docx만 가능하며 개당 50MB까지 첨부할 수 있습니다. • POST /v3/kakao/template/request_with_file • Content-Type: multipart/form-data |
||
요청 파라미터 | |||
키 | 타입 | 필수 |
설명 |
bizId | String | O | BIZPPURIO ID |
apiKey | String | O | API 발급 키 |
senderKey | String | O | 발신 프로필 키(senderKeyType이 G인 경우 프로필 그룹키) |
senderKeyType | String | X | 발신 프로필 키 타입 (S:일반(default), G:그룹) |
templateCode | String | O | 템플릿 코드 |
comment | String | O | 의견 또는 문의사항 (최대 500자까지 입력 가능) |
attachment | File | X | 업로드할 파일의 절대 경로, 다수의 파일 업로드 가능 |
반환 값 | |||
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 |
템플릿 검수 요청 취소
API 정보 |
• 검수 요청 상태의 템플릿을 취소 요청합니다. 템플릿 상태가 대기(R)이고 템플릿 검수상태가 검수 요청(REQ)인 경우에만 요청 가능합니다. • POST /v3/kakao/template/cancel_request • Content-Type: application/json; charset=utf-8 |
||
요청 파라미터 | |||
키 | 타입 | 필수 |
설명 |
bizId | String | O | BIZPPURIO ID |
apiKey | String | O | API 발급 키 |
senderKey | String | O | 발신 프로필 키(senderKeyType이 G인 경우 프로필 그룹키) |
senderKeyType | String | X | 발신 프로필 키 타입 (S:일반(default), G:그룹) |
templateCode | String | O | 템플릿 코드 |
반환 값 | |||
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 |
템플릿 사용 중지
API 정보 |
• 등록된 템플릿을 중지 상태로 변경합니다. 템플릿 상태가 대기(R) 또는 정상(A) 이고 템플릿 검수상태가 승인(APR)인 경우에만 요청 가능합니다. • POST /v3/kakao/template/stop • Content-Type: application/json; charset=utf-8 |
|||
요청 파라미터 | ||||
키 | - | 타입 | 필수 |
설명 |
bizId | String | O | BIZPPURIO ID | |
apiKey | String | O | API 발급 키 | |
senderKey | String | O | 발신 프로필 키(senderKeyType이 G인 경우 프로필 그룹키) | |
senderKeyType | String | X | 발신 프로필 키 타입 (S:일반(default), G:그룹) | |
templateCode | String | O | 템플릿 코드 | |
반환 값 | ||||
키 | - | 타입 | 설명 | |
code | String | 결과 코드 | ||
message | String | 실패 시 결과 메시지 |
템플릿 사용 중지 해제
API 정보 |
• 등록된 템플릿을 정상 상태로 되돌립니다.. 템플릿 상태가 중지(S) 이고 템플릿 검수상태가 승인(APR)인 경우에만 요청 가능합니다. • POST /v3/kakao/template/reuse • Content-Type: application/json; charset=utf-8 |
||
요청 파라미터 | |||
키 | 타입 | 필수 |
설명 |
bizId | String | O | BIZPPURIO ID |
apiKey | String | O | API 발급 키 |
senderKey | String | O | 발신 프로필 키(senderKeyType이 G인 경우 프로필 그룹키) |
senderKeyType | String | X | 발신 프로필 키 타입 (S:일반(default), G:그룹) |
templateCode | String | O | 템플릿 코드 |
반환 값 | |||
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 |
템플릿 승인 취소
API 정보 |
• 승인된 템플릿이 대기(R) 상태 일 때 승인 취소할 수 있습니다. 승인 취소시 등록(REG) 상태로 변경되며 재 검수 요청 가능합니다. • POST /v3/kakao/template/cancel_approval • Content-Type: application/json; charset=utf-8 |
||
요청 파라미터 | |||
키 | 타입 | 필수 |
설명 |
bizId | String | O | BIZPPURIO ID |
apiKey | String | O | API 발급 키 |
senderKey | String | O | 발신 프로필 키(senderKeyType이 G인 경우 프로필 그룹키) |
senderKeyType | String | X | 발신 프로필 키 타입 (S:일반(default), G:그룹) |
templateCode | String | O | 템플릿 코드 |
반환 값 | |||
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 |
템플릿 휴면 해제
API 정보 |
• 장기간 미사용으로 휴면된 템플릿을 해제합니다. 해제 후 30일간 사용하지 않는 경우 재 휴면 처리 됩니다. • POST /v3/kakao/template/release • Content-Type: application/json; charset=utf-8 |
|||
요청 파라미터 | ||||
키 | - | 타입 | 필수 |
설명 |
bizId | String | O | BIZPPURIO ID | |
apiKey | String | O | API 발급 키 | |
senderKey | String | O | 발신 프로필 키(senderKeyType이 G인 경우 프로필 그룹키) | |
senderKeyType | String | X | 발신 프로필 키 타입 (S:일반(default), G:그룹) | |
templateCode | String | O | 템플릿 코드 | |
반환 값 | ||||
키 | - | 타입 | 설명 | |
code | String | 결과 코드 | ||
message | String | 실패 시 결과 메시지 |
템플릿 전환
API 정보 |
• 기등록된 템플릿 (타입 : BA, EX)을 "채널 추가 버튼" 및 "채널 추가 안내 문구"가 포함된 템플릿으로 전환 • 템플릿 전환이 되면 BA는 AD로, EX는 MI 타입으로 변경됨"채널 추가 버튼" 무조건 맨 처음으로 추가되며, 템플릿에 버튼이 이미 5개인 경우는 전환 실패 • 채널 추가 안내 문구 (36자)가 포함되므로 기존 템플릿이 이미 964를 초과하는 경우 전환 실패 • 기존 템플릿에 바로연결이 있으면서 버튼이 2개인 경우는 전환 실패 • 휴면 등 비정상적인 템플릿에 대해서는 전환 실패 • POST /v3/kakao/template/convertAddCh • Content-Type: application/json; charset=utf-8 |
|||
요청 파라미터 | ||||
키 | - | 타입 | 필수 |
설명 |
bizId | String | O | BIZPPURIO ID | |
apiKey | String | O | API 발급 키 | |
senderKey | String | O | 발신 프로필 키 | |
templateCode | String | O | 템플릿 코드 | |
반환 값 | ||||
키 | - | 타입 | 설명 | |
code | String | 결과 코드 | ||
message | String | 실패 시 결과 메시지 |
댓글
댓글 0개
이 문서에는 댓글을 달 수 없습니다.