템플릿 정보 수정

목차

• Request
  • Authorization 인증 필요
  • Path Parameters
  • Request Structure
  • Body Params

Request

[PUT] https://api.coolsms.co.kr/kakao/v2/templates/:templateId

템플릿의 정보를 수정합니다.

---

Authorization 인증 필요

Authorization 인증이란?

계정 권한	회원 권한	계정 상태	회원 상태	계정 인증
kakao:write	role-kakao:write	ACTIVE	ACTIVE	O

Path Parameters

Name	Description
:templateId	템플릿 고유 아이디

Request Structure

{
    "name": "string",
    "content": "string",
    "buttons": [
        {
            "buttonType": "string",
            "buttonName": "string",
            "linkMo": "string",
            "linkPc": "string",
            "linkAnd": "string",
            "linkIos": "string"
        }
    ],
    "quickReplies": [
        {
            "name": "string",
            "linkType": "string",
            "linkMo": "string",
            "linkPc": "string",
            "linkAnd": "string",
            "linkIos": "string"
        }
    ],
    "categoryCode": "string",
    "extra": "string",
    "ad": "string",
    "emphasizeTitle": "string",
    "emphasizeSubtitle": "string",
    "messageType": "string",
    "emphasizeType": "string",
    "header": "string",
    "highlight": {
        "title": "string",
        "description": "string",
        "imageId": "string"
    },
    "item": {
        "list": [
            {
                "title": "string",
                "description": "string"
            }
        ],
        "summary": {
            "title": "string",
            "description": "string"
        }
    },
    "securityFlag": "boolean",
    "imageId": "string"
}

Body Params

Name	Type	Required	Description
name	string		알림톡 이름. 최대 100자
content	string		템플릿 내용
buttons	array		템플릿에 들어가는 버튼들
quickReplies	array		바로 연결. 최소 1개, 최대 10개.
categoryCode	string		카카오톡 채널 카테고리 코드
extra	string		부가정보. 변수 포함 불가능. 최대 500자
ad	string		채널 추가 문구. 문구는 채널 추가하고 이 채널의 광고와 마케팅 메시지를 카카오톡으로 받기 고정입니다.
emphasizeTitle	string		강조 표기 문구. 변수가 들어갈 수 있습니다. 템플릿 강조유형이 강조표기형일 때만 사용할 수 있습니다. 최대 50자
emphasizeSubtitle	string		강조 표기 보조 문구. 변수가 들어갈 수 없습니다. 템플릿 강조유형이 강조표기형일 때만 사용할 수 있습니다. 최대 50자
messageType	string		메시지 유형. 기본값: BA BA: 기본형 EX: 부가정보형 AD: 채널추가형 MI: 복합형
emphasizeType	string		강조 유형. 기본값: NONE NONE: 선택안함 TEXT: 강조표기형 IMAGE: 이미지형 ITEM_LIST: 아이템 리스트
header	string		알림톡 헤더. 강조 유형이 아이템 리스트일 때만 사용 가능합니다. 변수 포함 가능. 최대 16자
highlight	object		알림톡 하이라이트. 강조 유형이 아이템 리스트일 때만 사용 가능합니다.
item	object		알림톡 아이템. 목록과 요약이 있습니다. 강조 유형이 아이템 리스트일 때만 사용 가능합니다.
securityFlag	boolean		보안 템플릿 여부. true일 경우 해당 템플릿을 PC에서는 확인할 수 없습니다. 기본값: false
imageId	string		알림톡에 사용되는 이미지 고유 아이디

Body / buttons

Name	Type	Required	Description
buttonType	string	O	버튼 유형(DS:배송조회, WL:웹링크, AL:앱링크, BK:봇키워드 MD: 메시지전달 BC: 상담톡 전환 BT: 봇전환 AC: 채널추가)
buttonName	string		버튼 이름. 변수 포함 불가능. 최대 14자.
linkMo	string		모바일 링크(WL 웹링크)
linkPc	string		웹 링크(WL 웹링크)
linkAnd	string		안드로이드 링크(AL 앱링크)
linkIos	string		IOS 링크(AL 앱링크)

Body / quickReplies

Name	Type	Required	Description
name	string	O	바로 연결 이름. 변수 포함 불가능
linkType	string	O	링크 타입(WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달, BC: 상담톡 전환, BT: 봇전환)
linkMo	string		모바일 링크(WL 웹링크)
linkPc	string		웹 링크(WL 웹링크)
linkAnd	string		안드로이드 링크(AL 앱링크)
linkIos	string		IOS 링크(AL 앱링크)

Body / highlight

Name	Type	Required	Description
title	string		알림톡 하이라이트 제목. 변수 포함 가능. 최대 30자
description	string		알림톡 하이라이트 내용. 변수 포함 불가능. 최대 16자
imageId	string		알림톡에 사용되는 이미지 고유 아이디. 이미지 타입이 ATA일 경우에만 사용 가능합니다. 이미지 관리 페이지 (로그인 필요) 이미지 관리 API

Body / item

Name	Type	Required	Description
list	array		알림톡 아이템 리스트. 최소 2개, 최대 10개까지 등록할 수 있습니다.
summary	object		알림톡 아이템 리스트 요약.

Body / item / list

Name	Type	Required	Description
title	string	O	알림톡 아이템 리스트 제목. 변수 포함 불가능. 최대 6자
description	string	O	알림톡 아이템 리스트 제목. 변수 포함 가능. 최대 23자

Body / item / summary

Name	Type	Required	Description
title	string		알림톡 아이템 리스트 요약 제목. 변수 포함 불가능. 최대 6자
description	string		알림톡 아이템 리스트 요약 내용. 변수 포함 가능. 화폐 단위, 숫자, 쉼표, 마침표만 사용 가능합니다. 최대 14자.

---

문서 생성일 : 2024-11-14