Kakao 알림톡 Template API

Owned by Hannah
Last updated: Dec 08, 2022
9 min read

[API 도메인]

Test

Production

 

[Header]

Name

Type

Description

Name

Type

Description

apiKey

String

별도 요청

 

[Content-Type]

application/json;charset=UTF-8

 

[Common Response]

{ "time": String, "result": String, "resultMessage": String, "locale": String }

Name

Type

Required

Description

Name

Type

Required

Description

time

String

true

Response Time 2022-11-07T07:52:35.949+00:00

result

String

true

Response Code

resultMessage

String

true

Response Message

locale

String

true

API Locale

 

템플릿 카테고리

 

[URL]

 

[Response]

{ "time": String, "result": String, "resultMessage": String, "locale": String, "totalCount": Integer, "resultCount": Integer, "items": [ { "id": String, "label": String, "code": String, "name": String, "groupName": String, "inclusion": String, "exclusion": String } ] }

Name

Type

Required

Description

Name

Type

Required

Description

items

Array

true

카테고리 정보

– id

String

true

카테고리 코드

– label

String

true

카테고리 명

– code

String

true

카테고리 코드

– name

String

true

카테고리 명

– groupName

String

true

카테고리 그룹 명

– inclusion

String

true

카테고리 적용 대상 템플릿 설명

– exclusion

String

true

카테고리 제외 대상 템플릿 설명

 

템플릿 등록

 

[URL]

 

[Request Body]

{ "senderKey": String, "templateCode": String, "name": String, "content": String, "category": String, "messageType": String, "emphasisType": String, "emphasisAssistPhrase": String, "emphasisTitle": String, "moreInfo": String, "image": { "contentType": String, "fileName": String, "body": String }, "imageLink": String, "securityTemplate": Boolean, "buttons": [ { "buttonType": String, "name": String, "mobileUrl": String, "pcUrl": String, "androidUrl": String, "iosUrl": String, "chatExtra": String, "chatEvent": String, "target": String, "orderNo": Integer } ] }

Name

Type

Required

Description

Name

Type

Required

Description

senderKey

String

true

발신키

templateCode

String

true

템플릿 코드

name

String

true

템플릿 명

content

String

true

템플릿 내용

category

String

false

템플릿 카테고리 코드

messageType

String

false

템플릿 메시지 유형

  • 기본형 (basic)

  • 부가정보형 (additionalInfo)

  • 채널추가형 (channelAddition)

  • 복합형 (composite)

  • default : basic

emphasisType

String

false

강조 유형

  • 기본 (none)

  • 이미지 (image)

  • 강조표기 (emphasis)

  • default : none

emphasisAssistPhrase

String

false

보조 문구

  • 필수 강조 유형

    • 강조표기 (emphasis)

emphasisTitle

String

false

제목

  • 필수 강조 유형

    • 강조표기 (emphasis)

moreInfo

String

false

부가 정보

  • 필수 템플릿 메시지 유형

    • 부가정보형 (additionalInfo)

    • 복합형 (composite)

image

Object

false

이미지

  • 필수 강조 유형

    • 이미지 (image)

– contentType

String

true

MIME Type

  • JPG(image/jpeg), JPEG(image/jpeg), SIS(image/vnd.wap.sis)

– fileName

String

true

File Name

– body

String

true

File Body

  • File byte[] 를 Base64 인코딩

  • size : 50kb 이하

ex) Base64.getEncoder().encodeToString(Files.readAllBytes(file.toPath()))

imageLink

String

false

이미지 링크

  • 필수 강조 유형

    • 이미지 (image)

securityTemplate

Boolean

false

보안 템플릿 여부

  • OTP등 보안 메시지 일 경우 설정
    발신 당시의 메인 디바이스를 제외한 모든 디바이스에 메시지 텍스트 미노출(default: false)

buttons

Array

false

버튼 리스트

– buttonType

String

false

버튼 타입

  • 웹링크 (webLink)

  • 앱링크 (appLink)

  • 채널추가 (channelAddition)

  • 봇 키워드 (botKeyword)

  • 메시지 전달 (messageDelivery)

  • 상담톡 전환 (counselingTalkConversion)

  • 봇 전환 (botConversion)

  • 배송조회페이지로 연결 (deliveryTracking)

– name

String

false

버튼 명

– mobileUrl

String

false

모바일 웹링크

  • 필수 버튼 타입

    • 웹링크 (webLink)

– pcUrl

String

false

PC 웹링크

  • 필수 버튼 타입

    • 웹링크 (webLink)

– androidUrl

String

false

Android 앱링크

  • 필수 버튼 타입

    • 앱링크 (appLink)

– iosUrl

String

false

IOS 앱링크

  • 필수 버튼 타입

    • 앱링크 (appLink)

– chatExtra

String

false

상담톡 전환, 봇 전환 버튼일 때 전달할 정보

  • 필수 버튼 타입

    • 상담톡 전환 (counselingTalkConversion)

    • 봇 전환 (botConversion)

– chatEvent

String

false

봇 전환 버튼일 때, 연결할 이벤트명

  • 필수 버튼 타입

    • 봇 전환 (botConversion)

– target

String

false

웹링크 버튼인 경우, 아웃링크 기본 인앱 링크로 발송

"target":"out"

  • 필수 버튼 타입

    • 웹링크 (webLink)

– orderNo

Integer

false

버튼 순서

 

[Response]

Name

Type

Required

Description

Name

Type

Required

Description

item

Object

true

템플릿 정보

– id

String

true

ID

– templateCode

String

true

템플릿 코드

– name

String

false

템플릿 명

– content

String

false

템플릿 내용

– category

Object

false

템플릿 카테고리

– – value

String

false

템플릿 카테고리 코드

– – label

String

false

템플릿 카테고리 명

– – refId

String

false

템플릿 카테고리 코드

– messageType

Object

false

템플릿 메시지 유형

  • 기본형 (basic)

  • 부가정보형 (additionalInfo)

  • 채널추가형 (channelAddition)

  • 복합형 (composite)

  • default : basic

– – value

String

false

템플릿 메시지 유형 코드

– – label

String

false

템플릿 메시지 유형 명

– emphasisType

Object

false

강조 유형

  • 기본 (none)

  • 이미지 (image)

  • 강조표기 (emphasis)

  • default : none

– – value

String

false

강조 유형 코드

– – label

String

false

강조 유형 명

– emphasisAssistPhrase

String

false

보조 문구

– emphasisTitle

String

false

제목

– moreInfo

String

false

부가 정보

– image

String

false

이미지

– imageLink

String

false

이미지 링크

– securityTemplate

Boolean

false

보안 템플릿 여부

– buttons

Array

false

버튼 리스트

– – buttonType

Object

false

버튼 타입

  • 웹링크 (webLink)

  • 앱링크 (appLink)

  • 채널추가 (channelAddition)

  • 봇 키워드 (botKeyword)

  • 메시지 전달 (messageDelivery)

  • 상담톡 전환 (counselingTalkConversion)

  • 봇 전환 (botConversion)

  • 배송조회페이지로 연결 (deliveryTracking)

– – – value

String

false

버튼 타입 코드

– – – label

String

false

버튼 타입 명

– – name

String

false

버튼 명

– – mobileUrl

String

false

모바일 웹링크

– – pcUrl

String

false

PC 웹링크

– – androidUrl

String

false

Android 앱링크

– – iosUrl

String

false

IOS 앱링크

– – chatExtra

String

false

상담톡 전환, 봇 전환 버튼일 때 전달할 정보

– – chatEvent

String

false

봇 전환 버튼일 때, 연결할 이벤트명

– – target

String

false

웹링크 버튼인 경우, 아웃링크 기본 인앱 링크로 발송

– – orderNo

Integer

false

버튼 순서

– created

String

false

등록일

– changed

String

false

수정일

– templateStatus

String

true

템플릿 상태

  • 임시저장 (waiting)

  • 검수요청 (request)

  • 카카오검수중 (kakaoChecking)

  • 사용가능 (approval)

  • 반려 (reject)

– – value

String

true

템플릿 상태 코드

– – label

String

true

템플릿 상태 명

– inspectionComment

String

false

템플릿 검수 코멘트

– inspectionDate

String

false

템플릿 검수 일자

 

템플릿 수정

 

[URL]

 

[Request Body]

Name

Type

Required

Description

Name

Type

Required

Description

senderKey

String

true

발신키

templateCode

String

true

템플릿 코드

name

String

true

템플릿 명

content

String

true

템플릿 내용

category

String

false

템플릿 카테고리 코드

messageType

String

false

템플릿 메시지 유형

  • 기본형 (basic)

  • 부가정보형 (additionalInfo)

  • 채널추가형 (channelAddition)

  • 복합형 (composite)

  • default : basic

emphasisType

String

false

강조 유형

  • 기본 (none)

  • 이미지 (image)

  • 강조표기 (emphasis)

  • default : none

emphasisAssistPhrase

String

false

보조 문구

  • 필수 강조 유형

    • 강조표기 (emphasis)

emphasisTitle

String

false

제목

  • 필수 강조 유형

    • 강조표기 (emphasis)

moreInfo

String

false

부가 정보

  • 필수 템플릿 메시지 유형

    • 부가정보형 (additionalInfo)

    • 복합형 (composite)

image

Object

false

이미지

  • 필수 강조 유형

    • 이미지 (image)

– contentType

String

true

MIME Type

  • JPG(image/jpeg), JPEG(image/jpeg), SIS(image/vnd.wap.sis)

– fileName

String

true

File Name

– body

String

true

File Body

  • File byte[] 를 Base64 인코딩

  • size : 50kb 이하

ex) Base64.getEncoder().encodeToString(Files.readAllBytes(file.toPath()))

imageLink

String

false

이미지 링크

  • 필수 강조 유형

    • 이미지 (image)

securityTemplate

Boolean

false

보안 템플릿 여부

  • OTP등 보안 메시지 일 경우 설정
    발신 당시의 메인 디바이스를 제외한 모든 디바이스에 메시지 텍스트 미노출(default: false)

buttons

Array

false

버튼 리스트

– buttonType

String

false

버튼 타입

  • 웹링크 (webLink)

  • 앱링크 (appLink)

  • 채널추가 (channelAddition)

  • 봇 키워드 (botKeyword)

  • 메시지 전달 (messageDelivery)

  • 상담톡 전환 (counselingTalkConversion)

  • 봇 전환 (botConversion)

  • 배송조회페이지로 연결 (deliveryTracking)

– name

String

false

버튼 명

– mobileUrl

String

false

모바일 웹링크

  • 필수 버튼 타입

    • 웹링크 (webLink)

– pcUrl

String

false

PC 웹링크

  • 필수 버튼 타입

    • 웹링크 (webLink)

– androidUrl

String

false

Android 앱링크

  • 필수 버튼 타입

    • 앱링크 (appLink)

– iosUrl

String

false

IOS 앱링크

  • 필수 버튼 타입

    • 앱링크 (appLink)

– chatExtra

String

false

상담톡 전환, 봇 전환 버튼일 때 전달할 정보

  • 필수 버튼 타입

    • 상담톡 전환 (counselingTalkConversion)

    • 봇 전환 (botConversion)

– chatEvent

String

false

봇 전환 버튼일 때, 연결할 이벤트명

  • 필수 버튼 타입

    • 봇 전환 (botConversion)

– target

String

false

웹링크 버튼인 경우, 아웃링크 기본 인앱 링크로 발송

"target":"out"

  • 필수 버튼 타입

    • 웹링크 (webLink)

– orderNo

Integer

false

버튼 순서

 

[Response]

Name

Type

Required

Description

Name

Type

Required

Description

item

Object

false

템플릿 정보

– id

String

false

ID

– templateCode

String

false

템플릿 코드

– name

String

false

템플릿 명

– content

String

false

템플릿 내용

– category

Object

false

템플릿 카테고리

– – value

String

false

템플릿 카테고리 코드

– – label

String

false

템플릿 카테고리 명

– – refId

String

false

템플릿 카테고리 코드

– messageType

Object

false

템플릿 메시지 유형

  • 기본형 (basic)

  • 부가정보형 (additionalInfo)

  • 채널추가형 (channelAddition)

  • 복합형 (composite)

  • default : basic

– – value

String

false

템플릿 메시지 유형 코드

– – label

String

false

템플릿 메시지 유형 명

– emphasisType

Object

false

강조 유형

  • 기본 (none)

  • 이미지 (image)

  • 강조표기 (emphasis)

  • default : none

– – value

String

false

강조 유형 코드

– – label

String

false

강조 유형 명

– emphasisAssistPhrase

String

false

보조 문구

– emphasisTitle

String

false

제목

– moreInfo

String

false

부가 정보

– image

String

false

이미지

– imageLink

String

false

이미지 링크

– securityTemplate

Boolean

false

보안 템플릿 여부

– buttons

Array

false

버튼 리스트

– – buttonType

Object

false

버튼 타입

  • 웹링크 (webLink)

  • 앱링크 (appLink)

  • 채널추가 (channelAddition)

  • 봇 키워드 (botKeyword)

  • 메시지 전달 (messageDelivery)

  • 상담톡 전환 (counselingTalkConversion)

  • 봇 전환 (botConversion)

  • 배송조회페이지로 연결 (deliveryTracking)

– – – value

String

false

버튼 타입 코드

– – – label

String

false

버튼 타입 명

– – name

String

false

버튼 명

– – mobileUrl

String

false

모바일 웹링크

– – pcUrl

String

false

PC 웹링크

– – androidUrl

String

false

Android 앱링크

– – iosUrl

String

false

IOS 앱링크

– – chatExtra

String

false

상담톡 전환, 봇 전환 버튼일 때 전달할 정보

– – chatEvent

String

false

봇 전환 버튼일 때, 연결할 이벤트명

– – target

String

false

웹링크 버튼인 경우, 아웃링크 기본 인앱 링크로 발송

– – orderNo

Integer

false

버튼 순서

– created

String

false

등록일

– changed

String

false

수정일

– templateStatus

String

true

템플릿 상태

  • 임시저장 (waiting)

  • 검수요청 (request)

  • 카카오검수중 (kakaoChecking)

  • 사용가능 (approval)

  • 반려 (reject)

– – value

String

true

템플릿 상태 코드

– – label

String

true

템플릿 상태 명

– inspectionComment

String

false

템플릿 검수 코멘트

– inspectionDate

String

false

템플릿 검수 일자

 

템플릿 삭제

 

[URL]

 

[Request Body]

Name

Type

Required

Description

Name

Type

Required

Description

senderKey

String

true

발신키

templateCode

String

true

템플릿 코드

 

[Response]

 

템플릿 리스트

 

[URL]

 

[Request Parameter]

Name

Type

Required

Description

Name

Type

Required

Description

templateCode

String

false

템플릿 코드

templateStatus

String

false

템플릿 상태

page

String

false

페이지 번호

  • default : 1

pageSize

String

false

페이지 조회 건수

  • defualt : 10

 

[Response]

Name

Type

Required

Description

Name

Type

Required

Description

items

Object

false

템플릿 정보

– id

String

false

ID

– templateCode

String

false

템플릿 코드

– name

String

false

템플릿 명

– content

String

false

템플릿 내용

– category

Object

false

템플릿 카테고리

– – value

String

false

템플릿 카테고리 코드

– – label

String

false

템플릿 카테고리 명

– – refId

String

false

템플릿 카테고리 코드

– messageType

Object

false

템플릿 메시지 유형

  • 기본형 (basic)

  • 부가정보형 (additionalInfo)

  • 채널추가형 (channelAddition)

  • 복합형 (composite)

  • default : basic

– – value

String

false

템플릿 메시지 유형 코드

– – label

String

false

템플릿 메시지 유형 명

– emphasisType

Object

false

강조 유형

  • 기본 (none)

  • 이미지 (image)

  • 강조표기 (emphasis)

  • default : none

– – value

String

false

강조 유형 코드

– – label

String

false

강조 유형 명

– emphasisAssistPhrase

String

false

보조 문구

– emphasisTitle

String

false

제목

– moreInfo

String

false

부가 정보

– image

String

false

이미지

– imageLink

String

false

이미지 링크

– securityTemplate

Boolean

false

보안 템플릿 여부

– buttons

Array

false

버튼 리스트

– – buttonType

Object

false

버튼 타입

  • 웹링크 (webLink)

  • 앱링크 (appLink)

  • 채널추가 (channelAddition)

  • 봇 키워드 (botKeyword)

  • 메시지 전달 (messageDelivery)

  • 상담톡 전환 (counselingTalkConversion)

  • 봇 전환 (botConversion)

  • 배송조회페이지로 연결 (deliveryTracking)

– – – value

String

false

버튼 타입 코드

– – – label

String

false

버튼 타입 명

– – name

String

false

버튼 명

– – mobileUrl

String

false

모바일 웹링크

– – pcUrl

String

false

PC 웹링크

– – androidUrl

String

false

Android 앱링크

– – iosUrl

String

false

IOS 앱링크

– – chatExtra

String

false

상담톡 전환, 봇 전환 버튼일 때 전달할 정보

– – chatEvent

String

false

봇 전환 버튼일 때, 연결할 이벤트명

– – target

String

false

웹링크 버튼인 경우, 아웃링크 기본 인앱 링크로 발송

– – orderNo

Integer

false

버튼 순서

– created

String

true

등록일

– changed

String

true

수정일

– templateStatus

String

true

템플릿 상태

  • 임시저장 (waiting)

  • 검수요청 (request)

  • 카카오검수중 (kakaoChecking)

  • 사용가능 (approval)

  • 반려 (reject)

– – value

String

true

템플릿 상태 코드

– – label

String

true

템플릿 상태 명

– inspectionComment

String

false

템플릿 검수 코멘트

– inspectionDate

String

false

템플릿 검수 일자

– channelId

String

true

카카오톡 채널 검색용 ID

– senderKey

String

true

발신키