Skip to main content
POST
브랜드메시지는 발신 채널(비즈니스 채널)이 등록되어 있어야 하며, 비친구 대상(M/N 타겟팅)은 채널 친구 5만명 이상 승인된 채널만 발송할 수 있습니다.

발송 유형

브랜드메시지는 두 가지 발송 유형을 지원합니다.

대상(타겟팅)과 과금

Base URL

Headers

string
required
제공받은 API key

Body (JSON)

number
required
제공받은 브랜드메시지 서비스 번호
string
required
말풍선 타입. TEXT, IMAGE, WIDE, WIDE_ITEM_LIST, CAROUSEL_FEED, PREMIUM_VIDEO, COMMERCE, CAROUSEL_COMMERCE 중 하나
string
required
그룹코드
object[]
required
수신자 배열. 각 항목은 아래 필드로 구성됩니다. (단건 발송 시 mobile 문자열로 대체 가능)
  • key (number): unique key
  • hp (string): 수신자 핸드폰 번호
  • name (string): 수신자 이름
  • VAR1, VAR2, … (string): 템플릿 가변변수에 대입될 값 (BASIC)
string
default:"FREE"
발송 유형. FREE(자유형) 또는 BASIC(기본형)
string
등록된 브랜드메시지 템플릿 코드. sendType=BASIC인 경우 필수
string
default:"I"
발송 대상. I / F / N / M (위 표 참조)
string
발신 채널 ID. targetingN 또는 M인 경우 필수
string
본문 메시지 (자유형 TEXT 등에서 사용)
string
이미지 URL (자유형 IMAGE / WIDE)
object[]
버튼 정보 (JSON Array). 각 버튼의 link1(PC URL), link2(모바일 URL) 지정
캐러셀 아이템 배열 (자유형 CAROUSEL_FEED)
object
아이템 리스트 (자유형 WIDE_ITEM_LIST)
object
쿠폰 정보
string
헤더 텍스트
string
부가 정보 텍스트
boolean
default:"false"
대체문자 발송 여부
string
대체문자 본문 (alter=true 시)
string
대체문자 발신번호 (alter=true 시 필수). 사전에 등록된 발신번호만 사용 가능합니다.
기본형(BASIC)은 이미지·캐러셀·아이템·커머스·쿠폰·버튼 등 구조적 데이터가 템플릿에 이미 포함되어 있습니다. 이 값들을 요청에 추가로 보내면 오류(ERR_201)가 발생하므로, 기본형에서는 template과 가변변수(numbers[].VARn)만 전달하세요.

예제

응답 필드

참고

  • 단건 발송은 numbers 대신 mobile 문자열만 보내도 됩니다. 이 경우 응답도 단건 포맷으로 반환됩니다.
  • 자유형(FREE)은 PREMIUM_VIDEO, COMMERCE, CAROUSEL_COMMERCE를 지원하지 않습니다. 해당 타입은 기본형(BASIC + 템플릿)으로 발송하세요.
  • N/M 타겟팅(비친구 발송)은 channelId가 필수이며, 채널 친구 5만명 이상 승인된 채널에서만 가능합니다.
  • 발송 실패(KKO_*) 시 alter: true로 설정하면 자동으로 SMS 대체 발송이 진행됩니다.