브랜드 메시지 템플릿

1. GetBMSTemplateMgtURL - 브랜드 메시지 템플릿 관리 팝업 URL

테스트(Sandbox) 운영(Production)

GET https://popbill-test.linkhub.co.kr/KakaoTalk Copied

미리보기

브랜드 메시지 템플릿을 관리하는 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 1,000px (최소 1,000px) / height = 800px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

Request

요청 헤더

순번	변수명	필수	설명
1	Authorization	Y	인증 토큰 → [참고] 인증 및 헤더 설정
2	Accept-Language	N	응답 언어 설정 ko-KR 기본값 en-US
3	Accept-Encoding	N	응답 압축 방식 gzip
4	X-PB-UserID	N	팝빌회원 아이디

Query 파라미터

순번	변수명	타입	길이	필수	설명
1	TG	string	-	Y	고정값 : BMS_TEMPLATE

요청 예시

curl --request GET \
  --url 'https://{domain}/KakaoTalk?TG=BMS_TEMPLATE' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번	변수명	타입	길이	설명
1	url	string	-	브랜드 메시지 템플릿 관리 팝업 URL

응답 예시

{
    "url": "https://test.popbill.com/App/API?T=IRXSGITDREOTPOIRLPUHCB4BSBC4...NX7BMAR3="
}

2. GetBMSTemplate - 브랜드 메시지 템플릿 정보 확인

테스트(Sandbox) 운영(Production)

GET https://popbill-test.linkhub.co.kr/KakaoTalk/BMSTemplate/{templateCode} Copied

• 브랜드 메시지 템플릿 정보를 확인합니다.

Request

요청 헤더

순번	변수명	필수	설명
1	Authorization	Y	인증 토큰 → [참고] 인증 및 헤더 설정
2	Accept-Language	N	응답 언어 설정 ko-KR 기본값 en-US
3	Accept-Encoding	N	응답 압축 방식 gzip
4	X-PB-UserID	N	팝빌회원 아이디

Path 파라미터

순번	변수명	타입	길이	필수	설명
1	templateCode	string	12	Y	템플릿 코드

요청 예시

curl --request GET \
  --url 'https://{domain}/KakaoTalk/BMSTemplate/{templateCode}' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번	변수명	타입	길이	설명
1	templateCode	string	12	템플릿 코드
2	templateType	string	4	템플릿 유형 BMST 브랜드 메시지 텍스트 BMSI 브랜드 메시지 이미지 BMSW 브랜드 메시지 와이드 BMSL 브랜드 메시지 리스트 BMSC 브랜드 메시지 캐러셀 BMSM 브랜드 메시지 커머스 BMSA 브랜드 메시지 캐러셀 커머스
3	templateName	string	200	템플릿 제목
4	content	string	1,300	템플릿 내용
5	plusFriendID	string	30	검색용 아이디
6	adultYN	boolean	-	성인용 메시지 여부
7	header	string	20	제목
8	addContent	string	34	부가메시지
9	imageUrl	string	500	이미지 URL
10	imageLink	string	500	이미지 링크 URL
11	state	number	-	템플릿 상태 1 사용 3 차단
12	stateDT	string	14	템플릿 상태 일시 → 형식 : yyyyMMddHHmmss
13	item	array	-	아이템 리스트 목록
item 순번 변수명 타입 길이 설명 1 title string 30 타이틀 2 imageUrl string 500 이미지 URL → 메인 아이템인 경우 [UploadWideListMainImage - 리스트 메인 이미지 업로드] API로 응답받은 URL 서브 아이템인 경우 [UploadWideListImage - 리스트 서브 이미지 업로드] API로 응답받은 URL 3 linkMobile string 1,000 Mobile 웹링크 4 linkPc string 1,000 PC 웹링크 5 linkAndroid string 1,000 Android 앱링크 6 linkIos string 1,000 iOS 앱링크
14	commerce	object	-	커머스 정보
commerce 순번 변수명 타입 길이 설명 1 title string 30 상품명 2 regularPrice number - 정상가격 → 0 ~ 99,999,999 3 discountType string 1 할인유형 R 할인율 F 할인금액 4 discount number - 할인율/할인금액 → {discountType}="R" 경우 1 ~ 100 {discountType}="F" 경우 0 ~ 999,999 5 discountPrice number - 할인가격 → 0 ~ 99,999,999 할인 적용 후 최종 가격 → {discountType} 입력 시 필수
15	head	object	-	캐러셀 인트로
head 순번 변수명 타입 길이 설명 1 header string 20 제목 2 content string 50 내용 3 imageUrl string 500 이미지 URL → [UploadCarouselCommerceImage - 캐러셀 커머스 이미지 업로드] API로 응답받은 URL 4 linkMobile string 1,000 Mobile 웹링크 5 linkPc string 1,000 PC 웹링크 6 linkAndroid string 1,000 Android 앱링크 7 linkIos string 1,000 iOS 앱링크
16	carousel	array	-	캐러셀 목록
carousel 순번 변수명 타입 길이 설명 1 header string 20 제목 2 content string 180 내용 3 addContent string 34 부가메시지 4 imageUrl string 500 이미지 URL 5 imageLink string 500 이미지 링크 URL 6 commerce object - 커머스 정보 commerce 순번 변수명 타입 길이 설명 1 title string 30 상품명 2 regularPrice number - 정상가격 → 0 ~ 99,999,999 3 discountType string 1 할인유형 R 할인율 F 할인금액 4 discount number - 할인율/할인금액 → {discountType}="R" 경우 1 ~ 100 {discountType}="F" 경우 0 ~ 999,999 5 discountPrice number - 할인가격 → 0 ~ 99,999,999 할인 적용 후 최종 가격 → {discountType} 입력 시 필수 7 btns array - 버튼 목록 btns 순번 변수명 타입 길이 설명 1 n string 8 버튼명 2 t string 2 버튼유형 WL 웹링크 AL 앱링크 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 string 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 string 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 8 coupon object - 쿠폰 coupon 순번 변수명 타입 길이 설명 1 title string 15 쿠폰 제목 #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999) #{숫자}% 할인 쿠폰 (숫자 : 1~100) 배송비 할인 쿠폰 #{7자 이내} 무료 쿠폰 #{7자 이내} UP 쿠폰 2 description string 12 쿠폰 설명 → 줄바꿈 사용 불가 3 linkMobile string 1,000 Mobile 웹링크 4 linkPc string 1,000 PC 웹링크 5 linkAndroid string 1,000 Android 앱링크 6 linkIos string 1,000 iOS 앱링크
17	tail	object	-	캐러셀 더보기
tail 순번 변수명 타입 길이 설명 1 linkMobile string 1,000 Mobile 웹링크 2 linkPc string 1,000 PC 웹링크 3 linkAndroid string 1,000 Android 앱링크 4 linkIos string 1,000 iOS 앱링크
18	btns	array	-	버튼 목록
btns 순번 변수명 타입 길이 설명 1 n string 14 버튼명 2 t string 2 버튼유형 WL 웹링크 AL 앱링크 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 string 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 string 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용
19	coupon	object	-	쿠폰
coupon 순번 변수명 타입 길이 설명 1 title string 15 쿠폰 제목 #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999) #{숫자}% 할인 쿠폰 (숫자 : 1~100) 배송비 할인 쿠폰 #{7자 이내} 무료 쿠폰 #{7자 이내} UP 쿠폰 2 description string 12 쿠폰 설명 → 줄바꿈 사용 불가 3 linkMobile string 1,000 Mobile 웹링크 4 linkPc string 1,000 PC 웹링크 5 linkAndroid string 1,000 Android 앱링크 6 linkIos string 1,000 iOS 앱링크

응답 예시

{
    "templateCode": "026050000001",
    "plusFriendID": "@팝빌",
    "templateType": "BMST",
    "templateName": "테스트",
    "adultYN": false,
    "content": "테스트",
    "state": 1,
    "stateDT": "20260504113705"
}

3. ListBMSTemplate - 브랜드 메시지 템플릿 목록 확인

테스트(Sandbox) 운영(Production)

GET https://popbill-test.linkhub.co.kr/KakaoTalk/BMSTemplates Copied

• “사용” 상태의 브랜드 메시지 템플릿 목록을 확인합니다.

Request

요청 헤더

순번	변수명	필수	설명
1	Authorization	Y	인증 토큰 → [참고] 인증 및 헤더 설정
2	Accept-Language	N	응답 언어 설정 ko-KR 기본값 en-US
3	Accept-Encoding	N	응답 압축 방식 gzip
4	X-PB-UserID	N	팝빌회원 아이디

요청 예시

curl --request GET \
  --url 'https://{domain}/KakaoTalk/BMSTemplates' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번	변수명	타입	길이	설명
1	templateCode	string	12	템플릿 코드
2	templateType	string	4	템플릿 유형 BMST 브랜드 메시지 텍스트 BMSI 브랜드 메시지 이미지 BMSW 브랜드 메시지 와이드 BMSL 브랜드 메시지 리스트 BMSC 브랜드 메시지 캐러셀 BMSM 브랜드 메시지 커머스 BMSA 브랜드 메시지 캐러셀 커머스
3	templateName	string	200	템플릿 제목
4	content	string	1,300	템플릿 내용
5	plusFriendID	string	30	검색용 아이디
6	adultYN	boolean	-	성인용 메시지 여부
7	header	string	20	제목
8	addContent	string	34	부가메시지
9	imageUrl	string	500	이미지 URL
10	imageLink	string	500	이미지 링크 URL
11	state	number	-	템플릿 상태 1 사용
12	stateDT	string	14	템플릿 상태 일시 → 형식 : yyyyMMddHHmmss
13	item	array	-	아이템 리스트 목록
item 순번 변수명 타입 길이 설명 1 title string 30 타이틀 2 imageUrl string 500 이미지 URL → 메인 아이템인 경우 [UploadWideListMainImage - 리스트 메인 이미지 업로드] API로 응답받은 URL 서브 아이템인 경우 [UploadWideListImage - 리스트 서브 이미지 업로드] API로 응답받은 URL 3 linkMobile string 1,000 Mobile 웹링크 4 linkPc string 1,000 PC 웹링크 5 linkAndroid string 1,000 Android 앱링크 6 linkIos string 1,000 iOS 앱링크
14	commerce	object	-	커머스 정보
commerce 순번 변수명 타입 길이 설명 1 title string 30 상품명 2 regularPrice number - 정상가격 → 0 ~ 99,999,999 3 discountType string 1 할인유형 R 할인율 F 할인금액 4 discount number - 할인율/할인금액 → {discountType}="R" 경우 1 ~ 100 {discountType}="F" 경우 0 ~ 999,999 5 discountPrice number - 할인가격 → 0 ~ 99,999,999 할인 적용 후 최종 가격 → {discountType} 입력 시 필수
15	head	object	-	캐러셀 인트로
head 순번 변수명 타입 길이 설명 1 header string 20 제목 2 content string 50 내용 3 imageUrl string 500 이미지 URL → [UploadCarouselCommerceImage - 캐러셀 커머스 이미지 업로드] API로 응답받은 URL 4 linkMobile string 1,000 Mobile 웹링크 5 linkPc string 1,000 PC 웹링크 6 linkAndroid string 1,000 Android 앱링크 7 linkIos string 1,000 iOS 앱링크
16	carousel	array	-	캐러셀 목록
carousel 순번 변수명 타입 길이 설명 1 header string 20 제목 2 content string 180 내용 3 addContent string 34 부가메시지 4 imageUrl string 500 이미지 URL 5 imageLink string 500 이미지 링크 URL 6 commerce object - 커머스 정보 commerce 순번 변수명 타입 길이 설명 1 title string 30 상품명 2 regularPrice number - 정상가격 → 0 ~ 99,999,999 3 discountType string 1 할인유형 R 할인율 F 할인금액 4 discount number - 할인율/할인금액 → {discountType}="R" 경우 1 ~ 100 {discountType}="F" 경우 0 ~ 999,999 5 discountPrice number - 할인가격 → 0 ~ 99,999,999 할인 적용 후 최종 가격 → {discountType} 입력 시 필수 7 btns array - 버튼 목록 btns 순번 변수명 타입 길이 설명 1 n string 8 버튼명 2 t string 2 버튼유형 WL 웹링크 AL 앱링크 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 string 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 string 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 8 coupon object - 쿠폰 coupon 순번 변수명 타입 길이 설명 1 title string 15 쿠폰 제목 #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999) #{숫자}% 할인 쿠폰 (숫자 : 1~100) 배송비 할인 쿠폰 #{7자 이내} 무료 쿠폰 #{7자 이내} UP 쿠폰 2 description string 12 쿠폰 설명 → 줄바꿈 사용 불가 3 linkMobile string 1,000 Mobile 웹링크 4 linkPc string 1,000 PC 웹링크 5 linkAndroid string 1,000 Android 앱링크 6 linkIos string 1,000 iOS 앱링크
17	tail	object	-	캐러셀 더보기
tail 순번 변수명 타입 길이 설명 1 linkMobile string 1,000 Mobile 웹링크 2 linkPc string 1,000 PC 웹링크 3 linkAndroid string 1,000 Android 앱링크 4 linkIos string 1,000 iOS 앱링크
18	btns	array	-	버튼 목록
btns 순번 변수명 타입 길이 설명 1 n string 14 버튼명 2 t string 2 버튼유형 WL 웹링크 AL 앱링크 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 string 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 string 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용
19	coupon	object	-	쿠폰
coupon 순번 변수명 타입 길이 설명 1 title string 15 쿠폰 제목 #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999) #{숫자}% 할인 쿠폰 (숫자 : 1~100) 배송비 할인 쿠폰 #{7자 이내} 무료 쿠폰 #{7자 이내} UP 쿠폰 2 description string 12 쿠폰 설명 → 줄바꿈 사용 불가 3 linkMobile string 1,000 Mobile 웹링크 4 linkPc string 1,000 PC 웹링크 5 linkAndroid string 1,000 Android 앱링크 6 linkIos string 1,000 iOS 앱링크

응답 예시

[
    {
        "templateCode": "026050000001",
        "plusFriendID": "@팝빌",
        "templateType": "BMST",
        "templateName": "테스트",
        "adultYN": false,
        "content": "테스트",
        "state": 1,
        "stateDT": "20260504113705"
    }
]