브랜드 메시지

브랜드 메시지는 광고성 메시지를 카카오톡 메시지 발송하는 것으로, 알림톡과는 달리 마케팅 수신 동의(카카오톡 수신동의) 또는 카카오톡 친구로 추가한 사용자에게 발송할 수 있습니다. 브랜드 메시지는 채널 친구 또는 전화번호 정보 기반으로 발송되며, 등록된 전화번호로 모두 메시지가 발송되는 것이 아닌 서비스 정책상 마케팅 수신 동의 또는 카카오톡 채널을 추가한 사용자 대상으로만 광고성 메시지 발송됩니다. 자세한 설명은 브랜드메시지 발송 API 문서를 참고하시기 바랍니다.

브랜드 메시지 발송

브랜드 메시지 발송 API는 다음과 같습니다.

Request

표API 호출 방식

메서드	요청 URL
POST	`https://{base_url}/v2/send/kakao/ftupgrade`

Request Element

표브랜드 메시지 발송 Request Elements

프로퍼티	타입	필수 여부	설명
cid	text(50)	`필수`	사용자 정의 Message ID
message_type	String	`필수`	메시지 타입: U_FT : 브랜드 메시지 텍스트 U_FI : 브랜드 메시지 이미지 U_FW : 브랜드 메시지 와이드 이미지 U_FL : 브랜드 메시지 와이드 리스트 U_FC : 브랜드 메시지 캐러셀 피드 U_FP : 브랜드 메시지 프리미엄 동영상 U_FM : 브랜드 메시지 커머스 U_FA : 브랜드 메시지 캐러셀 커머스
sender_key	text(40)	`필수`	발신 프로필키
sender_no	String	`필수`	발신 번호
phone_number	text(16)	`필수`	수신 번호
fall_back_yn	String	`필수`	부달 사용 여부 true : 부달 사용 false : 부달 미사용
fall_back_message_type	String		부달 타입  SM, LM - 부달 사용시 필수
fall_back_title	String		부달 메시지 제목
fall_back_message	String		부달 메시지 본문 - 부달 사용시 필수
message	text(1,300)		브랜드 메시지 자유형 본문, 브랜드 메시지 기본형 전문형(upgrade_tp가 BM일 경우 사용) upgrade_tp BV(기본형 변수 분리형)시 사용불가 줄바꿈 최대 99개
template_code	text(100)		브랜드 메시지 템플릿 코드 - 기본형 upgrade_tp(BN, BV, BM) 필수 - upgrade_tp FN, FY(자유형) 사용불가
targeting	String		수신 타겟(기본형 타입 사용시 지원) - M : 마수동 유저 대상 - N : 마수동 유저 - 채널 친구 - I : 발송요청 대상중 채널 친구 - F : 채널 전체 친구 대상 발송 upgrade_tp FN, FY(자유형) 타입은 사용 불가 - 25.07.29 자유형 지원 예정
push_alarm	String		메시지 푸시 알람 발송 여부
group_tag_key	String		그룹 태그 키
adult	String		성인용 메시지 여부
svatbo_no	String		특수한 유형의 부가통신 식별자 코드
button	List<Button>		자유형 버튼, upgrade_tp BM(기본 전문형) 버튼 전문
coupon	FtCoupon		브랜드 메시지 쿠폰 - upgrade_tp BV(기본형 변수 분리형)시 미사용
commerce	FtCommerce		브랜드 메시지 커머스 - upgrade_tp BV(기본형 변수 분리형)시 미사용
image	Image		브랜드 메시지 이미지 - upgrade_tp BV(기본형 변수 분리형)시 미사용
video	FtVideo		브랜드 메시지 비디오 - upgrade_tp BV(기본형 변수 분리형)시 미사용
additional_content	String		부가 정보 COMMERCE - 최대 34자 (줄바꿈: 최대 1개)
header	text(20)		U_FL 사용시 필수 최대 20글자
item	FtItem		와이드 리스트(최소3, 최대4)
head	Head		캐러셀 인트로 message_type이 U_FA인 경우 사용 - upgrade_tp BV(기본형 변수 분리형)시 미사용
tail	Tail		캐러셀 더보기 버튼 message_type이 U_FA인 경우 사용 - upgrade_tp BV(기본형 변수 분리형)시 미사용
carousel	List<CarouselList>		캐러셀 리스트 message_type이 U_FA인 경우 사용 - 케러셀 인트로(head)사용시 1~5개 - 미사용시 2~6개 - upgrade_tp BV(기본형 변수 분리형)시 미사용
upgrade_tp	String	O	브랜드 메시지 구분 - BN : 기본형 변수 미사용 - BV : 기본형 변수 분리 - BM : 기본형 전문형 - FY : 자유형 친구톡 호환 - FN : 자유형 친구톡 비호환
tax_cd1	text(50)		정산 코드1 - 사용자 정의 컬럼(정산 대응)
tax_cd2	text(50)		정산 코드2 - 사용자 정의 컬럼(정산 대응)
client_api_poll_yn	String		고객사 -> DKT간 폴링 처리를 위한 변수 - Y : 사용
message_variable	Map<String, String>		upgrade_tp BV(기본형 변수 분리형)시 사용 - 메시지 본문 변수
button_variable	Map<String, String>		upgrade_tp BV(기본형 변수 분리형)시 사용 - 버튼 변수
commerce_variable	Map<String, String>		upgrade_tp BV(기본형 변수 분리형)시 사용 - 커머스 변수
coupon_variable	Map<String, String>		upgrade_tp BV(기본형 변수 분리형)시 사용 - 쿠폰 변수
video_variable	Map<String, String>		upgrade_tp BV(기본형 변수 분리형)시 사용 - 비디오 변수
carousel_variable	List<UpCarouselList>		upgrade_tp BV(기본형 변수 분리형)시 사용 - 케러셀 변수
image_variable	String		upgrade_tp BV(기본형 변수 분리형)시 사용 - 이미지 변수
svatbo_no	text(9)	특수부가통신사업자 필수	특수부가통신사업자일때 사용 파라미터 - 특수부가통신사업자 코드 입력 - KISA에 전달될 재판매사 구분 코드 - 브랜드메시지/문자메시지 부달 처리시 사용
unsubscribe_phone_number	text(13)		무료수신거부 전화번호 - unsubscribe_phone_number와 unsubscribe_auth_number 둘다 미입력시 발신프로필에 등록된 무료수신거부 정보로 발송됨 ex) 080-1234-1234
unsubscribe_auth_number	text(10)		무료수신거부 인증번호 - unsubscribe_phone_number, unsubscribe_auth_number 둘다 미입력시 발신프로필에 등록된 무료수신거부 정보로 발송 unsubscribe_phone_number 없이 unsubscribe_auth_number만 입력 불가 ex) 1234

표Button Request Elements 브랜드 메시지 발송 Request 내 버튼 공통 Property Request Elements는 다음과 같습니다.

프로퍼티	타입	필수 여부	설명
name	String	O	버튼 제목
type	String	O	버튼 타입
scheme_android	String		안드로이드 환경에서 클릭 시 실행할 application custom scheme
scheme_ios	String		iOS 환경에서 클릭 시 실행할 application custom scheme
url_mobile	String		MOBILE 환경에서 클릭 시 이동할 URL
url_pc	String		PC 환경에서 클릭 시 이동할 URL
chat_extra	String		상담톡<->카카오톡 챗봇 전환 시 전달할 메타정보
chat_event	String		카카오톡 챗봇 전환 시 연결할 카카오톡 챗봇 이벤트명
biz_form_key	String		비즈니스폼키

코드예제브랜드 메시지(자유형) 텍스트형 (U_FT) 발송 예시

JSON

{
  "cid":"TEST-202502171928-0014",
  "fall_back_yn":false,
  "sender_key":"[발신프로필키]",
  "phone_number":"[수신번호]",
  "message_type": "U_FT",
  "sender_no":"[발신번호]",
  "upgrade_tp" : "FY",
  "message" : "친구톡 업그레이드FY TYPE 발송 테스트",
  "button": [
    {"name":"앱링크버튼","type":"AL","scheme_android":"https://kakao.com"
    ,"scheme_ios":"https://kakao.com","url_mobile":"https://kakao.com"}
    ,{"name":"웹링크버튼","type":"WL","url_mobile":"http://kakao.com"}
  ],
  "client_api_poll_yn": "Y"
}

코드예제브랜드 메시지(기본) 텍스트형 (U_FT) 전문형 타입 예시 (BM형)

JSON

{
  "cid":"[CID]",
  "fall_back_yn":false,
  "sender_key":"[발신프로필키]",
  "phone_number":"[수신번호]",
  "message_type": "U_FT",
  "upgrade_tp": "BM",
  "sender_no":"[발신번호]",
  "template_code" : "[template_code]",
  "message" : "친구톡 업그레이드FY TYPE 발송 테스트",
  "targeting" : "N",
  "message": "브랜드메시지\n본문내용\n",
  "client_api_poll_yn": "Y"
}

코드예제브랜드 메시지(기본) 텍스트형 (U_FT) 변수 분리형 타입 예시 (BV)

JSON

{
  "cid":"[CID]",
  "fall_back_yn":false,
  "sender_key":"[발신프로필키]",
  "phone_number":"[수신번호]",
  "message_type": "U_FT",
  "upgrade_tp": "BV",
  "sender_no":"[발신번호]",
  "template_code" : "[template_code]",
  "message_variable" : {"본문": "친구톡 업그레이드FY TYPE 발송 테스트"},
  "targeting" : "N",
  "client_api_poll_yn": "Y"
}

표Image Request Elements 브랜드 메시지 발송 Request 내 Image Property Request Elements는 다음과 같습니다.

프로퍼티	타입	필수 여부	설명
img_url	text	O	이미지 업로드 API로 등록한 이미지 URL
img_link	text(1000)		이미지 클릭시 이동할 URL 미설정시 카카오톡 내 이미지 뷰어 사용

코드예제브랜드 메시지(자유형) 이미지형 (U_FI) 발송 예시

JSON

{
  "cid":"TEST-202502171928-0015-FN",
  "fall_back_yn":false,
  "sender_key":"[발신프로필키]",
  "phone_number":"[수신번호]",
  "message_type": "U_FI",
  "sender_no":"[발신번호]",
  "upgrade_tp" : "FY",
  "message" : "MSG_TYPE : U_FI\nUPGRADE_TP:FN\n 발송 테스트",
  "button": [
    {"name":"앱링크버튼","type":"AL","scheme_android":"https://kakao.com",
      "scheme_ios":"https://kakao.com",
      "url_mobile":"https://kakao.com"},
    {"name":"웹링크버튼","type":"WL","url_mobile":"http://kakao.com"}
  ],
  "image":{
    "img_url":"https://mud-kage.kakao.com/dn/yCcKz/btsK15n8p6T/5LCu3yqzjzEgY0wk8POhTk/img_l.jpg",
    "img_link":"https://google.com"
  },
  "client_api_poll_yn": "Y"
}

코드예제브랜드 메시지(자유형) 와이드 이미지형 (U_FW) 발송 예시

JSON

{
  "cid":"TEST-202502171928-0019-FN",
  "fall_back_yn":false,
  "sender_key":"[발신프로필키]",
  "phone_number":"[수신전화번호]",
  "message_type": "U_FW",
  "sender_no":"[발송번호]",
  "upgrade_tp" : "FN",
  "message" : "MSG_TYPE : U_FW UPGRADE_TP:FN 발송 테스트",
  "image":{
  "img_url":"https://mud-kage.kakao.com/dn/c0In8v/btsHt1XNqdN/H7Ee9ajYyFN2oRnEYKLXnk/img_l.jpg", "img_link":"https://google.com"},
  "client_api_poll_yn": "Y"
}

코드예제브랜드 메시지(기본형) 이미지(U_FI), 변수 분리형 타입 예시 (BV)

JSON

{
  "cid" : "UP-202502211629-00004",
  "sender_key": "[프로필키]",
  "fall_back_yn":"false",
  "upgrade_tp":"BV",
  "phone_number":"[수신번호]",
  "sender_no": "[발신번호]",
  "message_type": "U_FI",
  "message_variable":{"이름":"전문형"},
  "button_variable":{"mobile링크":"www.daum.net"},
  "template_code": "19315d723ad68089985c02d904b0c0d424d5c5dc",
  "targeting":"I",
  "client_api_poll_yn": "Y"
}

코드예제브랜드 메시지(기본형) 이미지(U_FI) 전문형 타입 예시 (BM)

JSON

{
  "cid" : "UP-202502211634-00005",
  "sender_key": "[프로필키]",
  "fall_back_yn":"false",
  "upgrade_tp":"BM",
  "phone_number":"[수신번호]",
  "sender_no": "[발신번호]",
  "message_type": "U_FI",
  "message" : "[테스트]\n전문형\n친구톡 업그레이드 기본형 이미지 테스트입니다.",
  "button" :[ { "type":"WL"} ,{"type":"WL","url_mobile":"https://daum.net"} ],
  "template_code": "19315d723ad68089985c02d904b0c0d424d5c5dc",
  "targeting":"I"
}

표Commerce Request Elements 브랜드 메시지 발송 Request 내 Commerce Property Request Elements는 다음과 같습니다.

프로퍼티	타입	필수 여부	설명
title	String	O	상품 제목 최대 30자 (줄바꿈: 불가)
regular_price	Int	O	정상 가격 (0 ~ 99,999,999)
discount_price	Int		할인 후 가격 (0 ~ 99,999,999)
discount_rate	Int		할인율 (0 ~ 100) 할인 가격 존재시 할인율, 정액 할인 가격 중 하나는 필수
discount_fixed	Int		정액 할인 가격 (0 ~ 999,999) 할인 가격 존재시 할인율, 정액 할인 가격 중 하나는 필수

코드예제브랜드 메시지(자유형) 커머스 (U_FM) 발송 예시

JSON

{
  "cid":"U_FA-202502171928-0050-FN",
  "message_type": "U_FM",
  "sender_key":"[발신프로필키]",
  "phone_number":"[수신번호]",
  "fall_back_yn":false,
  "upgrade_tp" : "FY",
  "sender_no" :"[발신번호]",
  "message": "친구톡 Upgrade U_FM 커머스",
  "button": [{"type": "MD", "name": "메시지 본문"}],
  "commerce" : {
    "title": "친구톡 커머스 제목",
    "regular_price": 100000,
    "discount_price": 90000,
    "discount_rate": 10,
    "discount_fixed": 90000
  },
  "image":{
    "img_url":"https://mud-kage.kakao.com/dn/c0In8v/btsHt1XNqdN/H7Ee9ajYyFN2oRnEYKLXnk/img_l.jpg"
  },
  "client_api_poll_yn": "Y"
}

코드예제브랜드 메시지(기본형) 커머스 (U_FM) 변수분리형 타입 발송 예시 (BV)

JSON

{
  "cid" : "UP-202502211657-00004",
  "sender_key" : "[프로파일]",
  "fall_back_yn":"false",
  "upgrade_tp":"BV",
  "phone_number":"[수신번호]",
  "message_type": "U_FM",
  "sender_no": "[발신번호]",
  "template_code" : "39422517dc8a65ffe692c49bfcd9628f08abee43",
  "targeting": "I",
  "client_api_poll_yn" : "Y",
  "message_variable": {
    "부가정보" : "커머스 TP: U_FM, UPGRADE_TP : BV 입니다."
  },
  "commerce_variable": {
    "상품명": "U_FM FM",
    "정상가격" : "10000",
    "할인가격" : "8000",
    "할인율" : "10"
  },
  "button_variable": {
    "mobile링크" : "www.daum.net"
  }
}

코드예제브랜드 메시지(기본형) 커머스 (U_FM) 전문형 타입 발송 예시 (BM)

JSON

{
  "cid" : "UP-202502211663-00004",
  "sender_key" : "[프로파일]",
  "fall_back_yn":"false",
  "upgrade_tp":"BM",
  "phone_number":"[수신번호]",
  "message_type": "U_FM",
  "sender_no": "[발신번호]",
  "template_code" : "39422517dc8a65ffe692c49bfcd9628f08abee43",
  "targeting": "I",
  "client_api_poll_yn" : "Y",
  "commerce":{
    "title": "U_FM BM",
    "regular_price": "77777",
    "discount_price": "2000",
    "discount_rate" :"10"
  },
  "button":[{"type":"WL"},{"type":"AL", "url_mobile":"https://www.daum.net"}
  ],
  "additional_content" :"FtUp 기본형 업그레이드 BM, U_FM 입니다."
}

표Video Request Elements 브랜드 메시지 발송 Request 내 video Property Request Elements는 다음과 같습니다.

프로퍼티	타입	필수 여부	설명
video_url	text(500)	O	카카오TV 동영상 URL
thumbnail_url	text(500)	O	이미지 업로드 API로 등록한 동영상 썸네일용 이미지 URL (기본값: 동영상 기본 썸네일 이미지) thumbnail_url 필드 필수 video_url이 비공개 동영상

코드예제브랜드 메시지(자유형) 프리미엄 동영상형 (U_FP) 발송 예시 (FY)

JSON

{
  "cid":"U_FA-202502171928-0035-FN",
  "message_type": "U_FP", //프리미엄 동영상
  "sender_key":"[프로필키]",
  "phone_number":"[수신번호]",
  "fall_back_yn":false,
  "upgrade_tp" : "FY",
  "sender_no" :"[발신번호]",
  "message": "친구톡 Upgrade 프리미엄 동영상 : 자유형 - 한 건 발송",
  "video" : {"video_url":"https://tv.kakao.com/channel/10135667/cliplink/451361691"},
  "button": [ {"type": "MD","name": "메시지 본문" } ],
  "client_api_poll_yn": "Y"
}

코드예제브랜드 메시지(기본형) 프리미엄 동영상(U_FP), 변수분리형 타입 예시 (BV)

JSON

{
  "cid" : "UP-202502211638-00005",
  "sender_key": "[프로파일키]",
  "fall_back_yn":"false",
  "upgrade_tp":"BV",
  "phone_number":"[수신번호]",
  "sender_no": "[발신번]",
  "message_type": "U_FP",
  "message_variable":{"헤더":"프리미엄 동영상"},
  "button_variable":{"iOS링크": "www.daum.net"},
  "template_code": "9e7d33e090a0598ff9d178f1bb652f51dd6a8e3d",
  "targeting":"I",
  "client_api_poll_yn": "Y"
}

코드예제브랜드 메시지(기본형) 프리미엄 동영상(U_FP), 전문형 타입 예시 (BM)

JSON

{
  "cid" : "UP-202502211643-00005",
  "sender_key": "[프로파일]",
  "fall_back_yn":"false",
  "upgrade_tp":"BM",
  "phone_number":"[수신번호]",
  "sender_no": "[발신번호]",
  "message_type": "U_FP",
  "header" : "U_FP 기본형 전문",
  "button":[
    {"type": "AL", "scheme_ios":"https://www.daum.net" }
  ],
  "video":{"video_url": "https://tv.kakao.com/channel/10135667/cliplink/451361691"},
  "template_code": "9e7d33e090a0598ff9d178f1bb652f51dd6a8e3d",
  "targeting":"I",
  "client_api_poll_yn": "Y"
}

표FtItem Request Elements 브랜드 메시지 발송 Request 내 Item Property (FtItem 타입)의 FtItemInfo로부터 리스트 항목을 받기 위한 Request Elements는 다음과 같습니다.

프로퍼티	타입	필수 여부	설명
List	List<FtItemInfo>		아이템 리스트 목록

표FtItemInfo Request Elements FtItem Request 내 List Property Request Elements는 다음과 같습니다.
FtItemInfo에서 설정한 아이템 목록이 메시지 발송 시 사용자에게 발송되는 실제 데이터 입니다.

프로퍼티	타입	설명
title	text	아이템 제목 (줄바꿈 최대 1개) 1번째 아이템 – 최대 25자 2~4번째 아이템 – 최대 30자
Img_url	text	이미지 업로드 API로 등록한 이미지 URL
url_mobile	text(1000)	Mobile환경에서 클릭 시 이동할 URL
url_pc	text(1000)	PC 환경에서 클릭 시 이동할 URL
scheme_android	text(1000)	MOBILE Android 환경에서 클릭 시 실행할 application custom scheme
scheme_Ios	text(1000)	MOBILE iOS 환경에서 클릭 시 실행할 application custom scheme

코드예제브랜드 메시지(자유형) 와이드리스트 (U_FL) 발송 예시

JSON

{
  "cid":"U_FA-202502171928-0044-FN",
  "message_type": "U_FL",
  "sender_key":"[프로필키]",
  "phone_number":"[수신번호]",
  "fall_back_yn":false,
  "upgrade_tp" : "FY",
  "sender_no" :"[발신번호]",
  "client_api_poll_yn": "Y",
  "message": "친구톡 Upgrade FL 와이드 리스트",
  "button": [ {"type": "MD","name": "메시지 본문"} ],
  "header" : "친구톡 아이템 리스트 헤더",
  "item": {
    "list" : [
      {
        "title":"제목1","img_url":"https://mud-kage.kakao.com/dn/c0In8v/btsHt1XNqdN/H7Ee9ajYyFN2oRnEYKLXnk/img_l.jpg",
        "scheme_android": "https://kakao.com", "scheme_ios":"https://kakao.com",
        "url_mobile":"https://kakao.com", "url_pc":"https://kakao.com"
      },
      {
        "title":"제목2","img_url":"https://mud-kage.kakao.com/dn/c0In8v/btsHt1XNqdN/H7Ee9ajYyFN2oRnEYKLXnk/img_l.jpg",
        "scheme_android": "https://kakao.com", "scheme_ios":"https://kakao.com",
        "url_mobile":"https://kakao.com", "url_pc":"https://kakao.com"
      },
      {
        "title":"제목3","img_url":"https://mud-kage.kakao.com/dn/c0In8v/btsHt1XNqdN/H7Ee9ajYyFN2oRnEYKLXnk/img_l.jpg",
        "scheme_android": "https://kakao.com", "scheme_ios":"https://kakao.com",
        "url_mobile":"https://kakao.com", "url_pc":"https://kakao.com"
      }
    ]
  }
}

코드예제브랜드 메시지(기본형) 와이드리스트 (U_FL) 변수분리형 타입 발송 예시 (BV)

JSON

{
  "cid" : "UP-202502211644-00004",
  "sender_key" : "[프로파일]",
  "fall_back_yn":"false",
  "upgrade_tp":"BV",
  "phone_number":"[수신번호]",
  "message_type": "U_FL",
  "sender_no": "[발신번호]",
  "template_code" : "9ce8a145324d599f6bd547f142e01c4d2ddb35f4",
  "message_variable":{
    "타이틀1" :"U_FL 변수분리",
    "타이틀3" :"BV",
    "mobile_link": "dktechin.com"
  },
  "client_api_poll_yn": "Y",
  "targeting": "I"
}

코드예제브랜드 메시지(기본형) 와이드리스트 (U_FL) 전문형형 타입 발송 예시 (BM)

JSON

{
  "cid" : "UP-202502211650-00004",
  "sender_key" : "[프로파일]",
  "fall_back_yn":"false",
  "upgrade_tp":"BM",
  "phone_number":"[수신번호]",
  "message_type": "U_FL",
  "sender_no": "[발신번]",
  "template_code" : "9ce8a145324d599f6bd547f142e01c4d2ddb35f4",
  "targeting": "I",
  "item":{"list":[{"title": "U_FL 전문"}, {},
    {"title" :"BM","url_mobile": "https://dktechin.com"}
  ]
  }
,"client_api_poll_yn": "Y"
}

표head Request Elements 브랜드 메시지 발송 Request 내 head Property Request Elements는 다음과 같습니다.

프로퍼티	타입	필수 여부	설명
header	text(20)	O	캐러셀 인트로 헤더 최대 20자 (줄바꿈: 불가)
content	text(50)	O	캐러셀 인트로 내용 최대 50자 (줄바꿈: 최대 2개)
image_url	text	O	이미지 업로드 API로 등록한 캐러셀 인트로 이미지 URL
url_mobile	text(1000)		MOBILE 환경에서 클릭 시 이동할 URL
url_pc	text(1000)		PC 환경에서 클릭 시 이동할 URL
scheme_android	text(1000)		MOBILE Android 환경에서 클릭 시 실행할 application custom scheme
scheme_ios	text(1000)		MOBILE iOS 환경에서 클릭 시 실행할 application custom scheme

표tail Request Elements 브랜드 메시지 발송 Request 내 tail Property Request Elements는 다음과 같습니다.

프로퍼티	타입	필수 여부	설명
url_pc	text(1000)		PC 환경에서 클릭 시 이동할 URL
url_mobile	text(1000)	O	MOBILE 환경에서 클릭 시 이동할 URL
scheme_ios	text(1000)		MOBILE iOS 환경에서 클릭 시 실행할 application custom scheme
scheme_android	text(1000)		MOBILE Android 환경에서 클릭 시 실행할 application custom scheme

표carousel Request Elements 브랜드 메시지 발송 Request 내 carousel Property Request Elements는 다음과 같습니다.

프로퍼티	타입	필수 여부	설명
header	text(20)		캐러셀 리스트 헤더 최대 20자 (줄바꿈: 불가) header 필드 필수 - message_type : U_FC header 필드 사용불가 - message_type : U_FA
message	text(180)		캐러셀 리스트 메시지 최대 180자 (줄바꿈: 최대 2개) - message_type : U_FC인 경우 필수 - message_type이 U_FA인 경우 사용불가
additional_content	text(34)		캐러셀 리스트 부가 정보 최대 34자 (줄바꿈: 최대 1개) message_type이 U_FC인 경우 사용 불가
attachment	CarouselAttachment	O	캐러셀 아이템 이미지, 버튼 정보

표carouselAttachment Request Elements Carousel Request 내 attachment Property Request Elements는 다음과 같습니다.

프로퍼티	타입	필수 여부	설명
button	List<CarouselButton>		최소 1개, 최대 2개 - button - 상위 button 객체 동일
image	CarouselImage	O	- 상위 image 객체 동일
coupon	Coupon		- 상위 Coupon 객체 동일
commerce	CarouselCommerce		- 상위 Commerce 객체 동일

표UpCarouselList Request Elements 브랜드 메시지 발송 Request 내 carousel_variable Property의 변수형 타입 Request Elements는 다음과 같습니다.

프로퍼티	타입	설명
message_variable	Map<String, String>	- 캐러셀 커머스 메시지 변수
button_variable	Map<String, String>	- 캐러셀 커머스 버튼 변수
image_variable	Map<String, String>	- 캐러셀 커머스 이미지 변수
commerce_variable	Map<String, String>	- 캐러셀 커머스 변수
coupon_variable	Map<String, String>	- 캐러셀 쿠폰 변수

표Coupon Request Elements 브랜드 메시지 발송 Request 내 coupon Property Request Elements는 다음과 같습니다.

프로퍼티	타입	필수 여부	설명
title	text	O	쿠폰 제목 사용 가능한 쿠폰 제목 - ${숫자}원 할인 쿠폰 (숫자: 1 ~ 99,999,999) - ${숫자}% 할인 쿠폰 (숫자: 1 ~ 100) - 배송비 할인 쿠폰 - ${7자 이내} 무료 쿠폰 - ${7자 이내} UP 쿠폰
description	text	O	쿠폰 설명 U_FW, U_FL, U_FP - 최대 18자 (줄바꿈: 불가) 그 외 - 최대 12자 (줄바꿈: 불가)
url_pc	text(1000)		PC 환경에서 클릭 시 이동할 URL
url_mobile	text(1000)		MOBILE 환경에서 클릭 시 이동할 URL
scheme_android	text(1000)		MOBILE Android 환경에서 클릭 시 실행할 application custom scheme
scheme_ios	text(1000)		MOBILE IOS 환경에서 클릭 시 실행할 application custom scheme

코드예제브랜드 메시지(자유형) 캐러셀 커머스 (U_FA) 발송 예시

JSON

{
  "cid":"U_FA-202502171928-0054-FN",
  "message_type": "U_FA",
  "sender_key":"[발신프로필키]",
  "phone_number":"[수신번호]",
  "fall_back_yn":false,
  "upgrade_tp" : "FY",
  "sender_no" :"[발신번호]",
  "message": "친구톡Upgrade U_FA 캐러셀 커머스",
  "head" : {"header": "캐러셀 커머스 인트로 헤더","content": "캐러셀 커머스 인트로 내용",
    "image_url": "https://mud-kage.kakao.com/dn/c0In8v/btsHt1XNqdN/H7Ee9ajYyFN2oRnEYKLXnk/img_l.jpg",
    "url_mobile": "https://kakao.com", "url_pc": "https://kakao.com", "scheme_android":"https://kakao.com", "scheme_ios":"https://kakao.com"
  },
  "tail" : {
    "url_pc":"https://kakao.com",
    "url_mobile":"https://kakao.com",
    "scheme_ios":"https://kakao.com",
    "scheme_android":"https://kakao.com"
  },
  "carousel" :
  [
    {
      "header": "FT_CAR_LIST1_HEADER",
      "message": "FT_CAR_LIST1_MESSAGE",
      "additional_content": "FT_CAR_LIST1_ADD_CONTENT",
      "attachment": {
        "button":[
          {
            "name": "1btn1",
            "type": "WL",
            "scheme_android": "https://kakao.com",
            "scheme_ios": "https://kakao.com",
            "url_mobile": "https://kakao.com",
            "url_pc":null
          },
          {
            "name": "1btn2",
            "type": "WL",
            "scheme_android": "https://kakao.com",
            "scheme_ios": "https://kakao.com",
            "url_mobile": "https://kakao.com",
            "url_pc":null
          }],
        "image":{ "img_url": "https://mud-kage.kakao.com/dn/c0In8v/btsHt1XNqdN/H7Ee9ajYyFN2oRnEYKLXnk/img_l.jpg", "img_link":null},
        "commerce": {
          "title": "CAR_LIST1_TITLE",
          "regular_price": 100000,
          "discount_price": 90000,
          "discount_rate": 10,
          "discount_fixed": 90000
        }
      }
    }
  ]
,"client_api_poll_yn": "Y"
}

코드예제브랜드 메시지(기본형) 캐러셀 커머스 (U_FA) 변수분리형 발송 예시 (BV)

JSON

{
  "cid" : "UP-202502211672-00004",
  "sender_key" : "[프로파일키]",
  "fall_back_yn":"false",
  "upgrade_tp":"BV",
  "phone_number":"[수신번호]",
  "message_type": "U_FA",
  "sender_no": "[발신번호]",
  "template_code" : "c8b21b6391c7b6b494ef7f5f5f2fb331b11eeda6",
  "targeting": "I",
  "client_api_poll_yn" : "Y",
  "carousel_variable":[
    {
      "message_variable":
      {
        "헤더":"캐러셀 커머스 헤더",
        "변수": "U_FA[BV]"
      }
    },
    {
      "message_variable":
      {
        "부가정보변수":"test"
      },
      "commerce_variable":{
        "상품명1":"테스트상품",
        "정상가격":"10000",
        "할인가격":"8000",
        "할인율":"20"
      }
    },
    {
      "commerce_variable":{
        "상품명2": "테스트상품2",
        "정상가격" : "20000",
        "할인가격" : "16000",
        "정액할인가격" : "16000"
      },
      "button_variable":{
        "mobile_link":"www.daum.net"
      }
    }
  ]
  ,"client_api_poll_yn": "Y"
}

코드예제브랜드 메시지(기본형) 캐러셀 커머스 (U_FA) 전문형 발송 예시 (BM)

JSON

{
  "cid" : "UP-202502211670-00004",
  "sender_key" : "[프로파일]",
  "fall_back_yn":"false",
  "upgrade_tp":"BM",
  "phone_number":"[수신번호]",
  "message_type": "U_FA",
  "sender_no": "[발신번호]",
  "template_code" : "c8b21b6391c7b6b494ef7f5f5f2fb331b11eeda6",
  "targeting": "I",
  "client_api_poll_yn" : "Y",
  "head":{ "header":"캐러셀 커머스 헤더","content" :"[테스트]\n브랜드 메시지 기본형 캐러셀 커머스 테스트입니다. (test)"},
  "carousel": [
    {
      "additional_content": "1번의 부가정보 (test)",
      "attachment": {
        "commerce":{"title":"상품1","regular_price":"10000","discount_price":"6000","discount_rate":"10"}
      }
    },
    {
      "attachment": {
        "commerce":{
          "title":"상품2",
          "regular_price":"20000",
          "discount_price":"16000",
          "discount_fixed":"4000"
        },
        "button":[{"type":"WL", "url_mobile":"https://www.daum.net"}]
      }
    }
  ]
  ,"client_api_poll_yn": "Y"
}

코드예제브랜드 메시지(기본형) 캐러셀피드(U_FC) 변수분리형 발송 예시 (BV)

JSON

{
  "cid" : "UP-202502211676-00007",
  "sender_key": "[프로파일]",
  "fall_back_yn":"false",
  "upgrade_tp":"BV",
  "phone_number":"[수신번호]",
  "sender_no": "[발신번호]",
  "message_type": "U_FC",
  "template_code": "ddd64baf1650e6eb896c10bb075de8064e442078",
  "carousel_variable":[
    {
    },
    {
      "message_variable":{"헤더2" : "캐러셀피드2","변수" : "zoe"}
    }
  ],
  "clinet_poll_api_yn" :"Y",
  "targeting":"I"
}

코드예제브랜드 메시지(기본형) 캐러셀피드(U_FC) 전문형 발송 예시 (BM)

JSON

{
  "cid" : "UP-202502211673-00007",
  "sender_key": "[프로파일]",
  "fall_back_yn":"false",
  "upgrade_tp":"BM",
  "phone_number":"[수신번호]",
  "sender_no": "[발신번호]",
  "message_type": "U_FC",
  "template_code": "ddd64baf1650e6eb896c10bb075de8064e442078",
  "carousel" :[
    {
    },
    {
      "header": "캐러셀피드"
    ,"message": "[테스트]\n브랜드 메시지 기본형 캐러셀 피드 내용2 테스트입니다. (collin.23))"
    }
  ],
  "clinet_poll_api_yn" :"Y",
  "targeting":"I"
}

Responses Elements

표브랜드 메시지 발송 결과 코드

HTTP Code	메시지	설명
200	OK	메시지 전송 결과가 성공일 경우 - 상세 정보는 발송결과 데이터 구조를 참고하십시오.
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

표발송결과 데이터 구조 HTTP Code 값이 200인 경우 사용되는 메시지 데이터 구조는 다음과 같습니다.

프로퍼티	타입	Required	설명
code	String	No	메시지 발송 결과 코드
uid	String	No	메시지 Key Id
cid	String	No	사용자 정의 Key Id
result	Result	No	세부 결과 정보 (참고용) - 상세 정보는 result 데이터 구조를 참고하십시오.

표Result 데이터 구조 발송결과 데이터 구조 내 Result 프로퍼티에 대한 상세 값은 다음과 같습니다.

프로퍼티	타입	Required	설명
detail_code	String	No	세부 결과 코드 (참고용)
detail_message	String	No	세부 결과 메시지 (참고용)

kakaoIdocumentation

Kakao i Connect Message::BizMessage(KOR)::API 호출 방식::API 레퍼런스::브랜드 메시지 발송

페이지 이동경로

브랜드 메시지

브랜드 메시지 발송

Request

Request Element

Responses Elements