본문으로 건너뛰기

알림톡 템플릿 관리

해당 페이지에서는 SOLAPI Java/Koltin SDK를 이용하여 카카오 알림톡 템플릿을 관리하는 방법에 대해 가이드하고 있습니다.
Java/Koltin SDK를 통해 빠르고 쉽게 알림톡 템플릿을 관리해보세요!

  • 해당 페이지에서 작성된 모든 코드는 Java로 작성되었습니다.
  • 각 예시에 대한 결과 값 표시 기능은 현재 준비중에 있습니다.
  • 해당 예제는 SDK 1.0.3 버전을 기준으로 작성되었습니다.
  • 템플릿을 생성/수정하려면 카테고리 코드를 미리 조회하셔야 합니다.
  • 문서가 작성된 순서로 코드를 작성하여 템플릿을 생성/수정해보세요!
  • 알림톡 템플릿 관련 파라미터 항목들은 Request 객체 설명 문서를 참고 해주세요!

템플릿 카테고리 조회​

DefaultMessageService messageService = SolapiClient.INSTANCE.createInstance("API 키 입력", "API 시크릿 키 입력");

for (KakaoAlimtalkTemplateCategory category : messageService.getKakaoAlimtalkTemplateCategories()) {
  // 알림톡 템플릿 카테고리 코드
  System.out.println(category.getCode());
  // 알림톡 템플릿 카테고리 이름
  System.out.println(category.getName());
}

템플릿 생성​

템플릿 생성에 관련된 세부 파라미터는 알림톡 템플릿 생성/수정 Request 객체 설명 문서를 참고 해주세요!

DefaultMessageService messageService = SolapiClient.INSTANCE.createInstance("API 키 입력", "API 시크릿 키 입력");

KakaoAlimtalkTemplateMutationRequest request = new KakaoAlimtalkTemplateMutationRequest();
request.setName("등록할 템플릿 제목(등록된 템플릿과 중복불가)");
request.setContent("등록할 템플릿 내용");
request.setChannelId("등록할 템플릿의 채널 ID(pfId)");
request.setCategoryCode("조회한 템플릿 카테고리 코드");

KakaoAlimtalkTemplateResponse created = messageService.createKakaoAlimtalkTemplate(request);
System.out.println(created);

템플릿 검수 요청(대기 상태일때만 가능)​

Java 예제 (검수 요청)
DefaultMessageService messageService = SolapiClient.INSTANCE.createInstance("API 키 입력", "API 시크릿 키 입력");

// 템플릿 검수 요청, 반드시 대기 상태의 템플릿만 검수 요청할 수 있습니다.
messageService.requestKakaoAlimtalkTemplateInspection("검수할 알림톡 템플릿 ID");

템플릿 검수 취소(검수중 상태에서만 가능)​

Java 예제 (검수 취소)
DefaultMessageService messageService = SolapiClient.INSTANCE.createInstance("API 키 입력", "API 시크릿 키 입력");

// 템플릿 검수 취소, 반드시 검수중 상태의 템플릿만 취소할 수 있습니다.
messageService.cancelKakaoAlimtalkTemplateInspection("검수취소할 알림톡 템플릿 ID");

템플릿 조회(목록, 단일 건 포함)​

Java 예제 (단일 조회)
DefaultMessageService messageService = SolapiClient.INSTANCE.createInstance("API 키 입력", "API 시크릿 키 입력");

KakaoAlimtalkTemplateResponse single = messageService.getKakaoAlimtalkTemplate("조회할 알림톡 template ID");
System.out.println(single);
Java 예제 (목록 조회 - 기본)
DefaultMessageService messageService = SolapiClient.INSTANCE.createInstance("API 키 입력", "API 시크릿 키 입력");

KakaoAlimtalkTemplateListResponse list = messageService.getKakaoAlimtalkTemplates();
System.out.println(list);
Java 예제 (목록 조회 - 조건 포함)
DefaultMessageService messageService = SolapiClient.INSTANCE.createInstance("API 키 입력", "API 시크릿 키 입력");

KakaoAlimtalkTemplateListRequest request = new KakaoAlimtalkTemplateListRequest();
request.setChannelId("카카오 채널 ID 입력(구 pfId)");
request.setLimit(5);

KakaoAlimtalkTemplateListResponse list = messageService.getKakaoAlimtalkTemplates(request);
System.out.println(list);

템플릿 수정​

템플릿 수정에 관련된 세부 파라미터는 알림톡 템플릿 생성/수정 Request 객체 설명 문서를 참고 해주세요!

  • 템플릿 수정 시 channelId(혹은 channelGroupId)는 수정할 수 없습니다.
Java 예제 (전체 수정)
DefaultMessageService messageService = SolapiClient.INSTANCE.createInstance("API 키 입력", "API 시크릿 키 입력");

KakaoAlimtalkTemplateMutationRequest request = new KakaoAlimtalkTemplateMutationRequest();
// request.setName("수정할 템플릿 제목(등록된 템플릿과 중복불가)");
// request.setContent("수정할 템플릿 내용");
// request.setCategoryCode("999999");

KakaoAlimtalkTemplateResponse updated = messageService.updateKakaoAlimtalkTemplate("수정할 알림톡 템플릿 ID", request);
System.out.println(updated);
DefaultMessageService messageService = SolapiClient.INSTANCE.createInstance("API 키 입력", "API 시크릿 키 입력");
messageService.updateKakaoAlimtalkTemplateName("수정할 알림톡 템플릿 ID", "새 템플릿 이름");

템플릿 삭제​

DefaultMessageService messageService = SolapiClient.INSTANCE.createInstance("API 키 입력", "API 시크릿 키 입력");
messageService.removeKakaoAlimtalkTemplate("삭제할 알림톡 템플릿 ID");

발송 가능한 템플릿 목록 조회​

DefaultMessageService messageService = SolapiClient.INSTANCE.createInstance("API 키 입력", "API 시크릿 키 입력");

// 발송 가능한 템플릿 목록 조회
List<KakaoAlimtalkTemplateResponse> sendables = messageService.getSendableKakaoAlimtalkTemplates();
System.out.println(sendables);
Java 예제 (발송 가능 목록 조회 - 채널 기준)
DefaultMessageService messageService = SolapiClient.INSTANCE.createInstance("API 키 입력", "API 시크릿 키 입력");

KakaoAlimtalkSendableTemplateListRequest request = new KakaoAlimtalkSendableTemplateListRequest();
request.setChannelId("카카오 채널 ID 입력(구 pfId)");

List<KakaoAlimtalkTemplateResponse> sendables = messageService.getSendableKakaoAlimtalkTemplates(request);
System.out.println(sendables);

브랜드 메시지 템플릿 조회​

DefaultMessageService messageService = SolapiClient.INSTANCE.createInstance("API 키 입력", "API 시크릿 키 입력");

KakaoBrandMessageTemplateListResponse brandList = messageService.getKakaoBrandMessageTemplates();
System.out.println(brandList);
Java 예제 (브랜드 템플릿 조회 - 조건 포함)
DefaultMessageService messageService = SolapiClient.INSTANCE.createInstance("API 키 입력", "API 시크릿 키 입력");

KakaoBrandMessageTemplateListRequest request = new KakaoBrandMessageTemplateListRequest();
request.setPfId("연동한 비즈니스 채널의 pfId");
request.setLimit(10);

KakaoBrandMessageTemplateListResponse brandList = messageService.getKakaoBrandMessageTemplates(request);
System.out.println(brandList);