Skip to navigation

알림톡 템플릿 만들기

View as Markdown

템플릿을 작성 상태(PENDING)로 만듭니다. 검수는 시작되지 않으며, 검수 요청을 따로 호출해야 합니다.

같은 요청을 다시 보내면 템플릿이 하나 더 만들어집니다. 응답을 받지 못했다면 목록에서 확인한 뒤 다시 보내세요. 발신번호 범위를 지정한 API 키로는 호출할 수 없습니다.

Authentication

AuthorizationBearer

API Key를 Bearer 토큰으로 전달

Path parameters

accountIdstringRequired

계정 ID

Request

This endpoint expects an object.
channelIdstringRequired

채널 목록 API가 반환한 한국AI통신 채널 리소스 ID.

namestringRequired<=200 characters
contentstringRequired<=1000 characters

본문. 치환 변수는 #{변수명} 으로 씁니다.

categoryCodestringRequired

템플릿 카테고리 목록 API의 code.

emphasizeTypeenumOptional

강조 유형. 생략하면 NONE 입니다. 이미지형은 콘솔에서 작성합니다.

Allowed values:
useExtrabooleanOptional

부가정보 사용 여부. 생략하면 extra 가 있을 때 켜집니다. 켜면 extra 가 필수입니다.

extrastring or nullOptional<=500 characters

부가정보. 치환 변수를 쓸 수 없습니다.

useChannelAddbooleanOptional

채널 추가 안내 사용 여부. 생략하면 ad 가 있을 때 켜집니다. 켜면 ad 가 필수입니다.

adstring or nullOptional<=80 characters

채널 추가 안내

emphasizeTitlestring or nullOptional<=50 characters

강조 문구. emphasizeType 이 TEXT 면 필수입니다.

emphasizeSubtitlestring or nullOptional<=50 characters

강조 보조 문구. emphasizeType 이 TEXT 면 필수입니다.

headerstring or nullOptional<=16 characters

헤더

highlightobject or nullOptional
itemobject or nullOptional
buttonslist of objectsOptional

버튼. 바로연결이 있으면 최대 2개입니다.

quickReplieslist of objectsOptional

바로연결. AC·DS 유형은 쓸 수 없습니다.

securityFlagbooleanOptional

보안 템플릿 여부

Response

만들어진 템플릿

idstring

한국AI통신 템플릿 리소스 ID. 발송 요청의 Kakao.TemplateId에 이 값을 사용합니다.

channelIdstring

한국AI통신 채널 리소스 ID. 발송 요청의 Kakao.ChannelId와 같은 값입니다.

namestring
contentstring

템플릿 본문.

statusstring

카카오 검수 상태. PENDING·INSPECTING·APPROVED·REJECTED 입니다. 발송에는 APPROVED 템플릿만 사용할 수 있습니다.

dormantboolean

휴면 템플릿 여부. true면 승인 상태여도 발송할 수 없습니다.

sendableboolean

현재 발송에 사용할 수 있으면 true.

assignTypestring

CHANNEL(채널 소유) 또는 GROUP(기본 제공).

messageTypestring
emphasizeTypestring
variableslist of strings

발송 요청의 Kakao.Variables에 모두 채워야 하는 변수 이름.

createdAtdatetime
updatedAtdatetime
categoryCodestring or null
useExtraboolean

부가정보 사용 여부

useChannelAddboolean

채널 추가 안내 사용 여부

buttonslist of objects
quickReplieslist of objects
hasImageboolean

이미지가 있으면 true. 이미지가 있는 템플릿의 내용은 콘솔에서 수정합니다.

securityFlagboolean
inspectionCommentslist of objects

검수 의견. 반려 사유가 여기에 있습니다.

extrastring or nullOptional
adstring or nullOptional
emphasizeTitlestring or nullOptional
emphasizeSubtitlestring or nullOptional
headerstring or nullOptional
highlightobject or nullOptional
itemobject or nullOptional

아이템 목록(list)과 요약(summary)

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
503
Service Unavailable Error