POPBill Developers
연동신청
  • 가이드 0
  • 레퍼런스 0
  • 오류코드 0
카카오톡
  • 전자세금계산서
  • 현금영수증
  • 전자명세서
  • 홈택스수집(세금)
  • 홈택스수집(현금)
  • 사업자등록상태조회
  • 기업정보조회
  • 계좌조회
  • 예금주조회
  • 카카오톡
  • 문자
  • 팩스
가이드

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

SDK 레퍼런스

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

팝빌의
SDK 다운로드
API 레퍼런스

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

고객지원

API 연동 중 발생하는 문제는
팝빌에서 해결을 도와드립니다.

팝빌의
서비스 제안서 수많은 기업이
선택한 팝빌
API 레퍼런스
카카오톡
API 레퍼런스 카카오톡 브랜드 메시지 전송

브랜드 메시지 전송

1. SendBMSText - 브랜드 메시지 전송 (텍스트)

POST https://popbill-test.linkhub.co.kr/BMS/Text
POST https://popbill.linkhub.co.kr/BMS/Text
  • 카카오톡 채널을 추가한 사용자 또는 마케팅 정보 수신에 동의한 사용자에게 텍스트형 광고성 메시지를 전송합니다. (최대 1,000건)
  • 브랜드 메시지를 전송하기 위해서는 팝빌을 통해 브랜드 메시지 신청을 진행해야 합니다.
  • 전송실패시 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
Request
요청 헤더
순번 변수명 필수 설명
Authorization Y 인증 토큰
[참고] 인증 및 헤더 설정
Content-Type Y 요청 본문 형식
application/json
X-PB-UserID N 팝빌회원 아이디
요청 본문
순번 변수명 타입 길이 필수 설명
plusFriendID string 30 Y 검색용 아이디
targeting string 1 Y 전송대상
I채널 친구
M전체
N비채널 친구
adultYN boolean - N 성인용 메시지 여부
기본값 : false
동보 전송인 경우 입력
content string 1300 조건부 브랜드 메시지 내용
줄바꿈 최대 99개
동보 전송인 경우 필수
unsubscribeNo string 13 조건부 080 수신거부 번호
{targeting}="M" or "N" 인 경우 필수
altYN boolean - N 대체문자 전송 여부
기본값 : false
sendNum string 20 조건부 발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
altSubject string 40 N 대체문자 제목
메시지 길이가 90byte 이상인 경우에만 적용
동보 전송인 경우 입력
altContent string 2000 조건부 대체문자 내용
대체문자 전송 시 필수
단위 : byte
동보 전송인 경우 입력
altUnsubscribeNo string 20 조건부 대체문자 080 수신거부 번호
대체문자 전송 시 필수
reserveDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50
기본값 : 즉시전송
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
btns array - N 버튼 목록
최대 5개 (쿠폰 버튼을 포함하는 경우 최대 4개)
동보 전송인 경우 입력
순번 변수명 타입 길이 필수 설명
n string 14 Y 버튼명
t string 2 Y 버튼 유형
  • WL웹링크
  • AL앱링크
  • MD메시지전달
  • BK봇키워드
  • AC채널추가
채널 추가 버튼은 첫 번째 위치에만 가능
u1 string 1000 N 버튼링크
- {t} = "AL" 경우 iOS 앱링크 적용
- {t} = "WL" 경우 Mobile 웹링크 적용
u2 string 1000 N 버튼링크
- {t} = "AL" 경우 Android 앱링크 적용
- {t} = "WL" 경우 PC 웹링크 적용
coupon object - N 쿠폰 버튼
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
동보 전송인 경우 입력
순번 변수명 타입 길이 필수 설명
title string 15 Y 쿠폰제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
description string 12 Y 쿠폰 설명
줄바꿈 사용 불가
linkMobile string 1000 조건부 Mobile 웹링크
linkPC string 1000 N PC 웹링크
linkAndroid string 1000 조건부 Android 앱링크
linkIos string 1000 조건부 iOS 앱링크
msgs array - Y 수신자 정보
순번 변수명 타입 길이 필수 설명
receiveNum string 20 Y 수신번호
receiveName string 70 N 수신자명
adultYN boolean - N 성인용 메시지 여부
기본값 : false
대량 전송인 경우 입력
content string 1300 조건부 브랜드 메시지 내용
줄바꿈 최대 99개
대량 전송인 경우 필수
altSubject string 40 N 대체문자 제목
메시지 길이가 90byte 이상인 경우에만 적용
대량 전송인 경우 입력
altContent string 2000 조건부 대체문자 내용
대체문자 전송 시 필수
단위 : byte
대량 전송인 경우 입력
interOPRefKey string 20 N 파트너 지정키
브랜드 메시지 대량 전송 시 파트너가 개별건마다 입력할 수 있는 값
btns array - N 버튼 목록
최대 5개 (쿠폰 버튼을 포함하는 경우 최대 4개)
대량 전송인 경우 입력
순번 변수명 타입 길이 필수 설명
n string 14 Y 버튼명
t string 2 Y 버튼 유형
  • WL웹링크
  • AL앱링크
  • MD메시지전달
  • BK봇키워드
  • AC채널추가
채널 추가 버튼은 첫 번째 위치에만 가능
u1 string 1000 N 버튼링크
- {t} = "AL" 경우 iOS 앱링크 적용
- {t} = "WL" 경우 Mobile 웹링크 적용
u2 string 1000 N 버튼링크
- {t} = "AL" 경우 Android 앱링크 적용
- {t} = "WL" 경우 PC 웹링크 적용
coupon object - N 쿠폰 버튼
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
대량 전송인 경우 입력
순번 변수명 타입 길이 필수 설명
title string 15 Y 쿠폰제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
description string 12 Y 쿠폰 설명
줄바꿈 사용 불가
linkMobile string 1000 조건부 Mobile 웹링크
linkPC string 1000 N PC 웹링크
linkAndroid string 1000 조건부 Android 앱링크
linkIos string 1000 조건부 iOS 앱링크
요청 예시 (단건)
curl --request POST \
  --url 'https://{domain}/BMS/Text' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "plusFriendID": "@팝빌",
    "targeting": "I",
    "content": "브랜드 메시지 내용",
    "btns": [
        {
            "n": "채널 추가",
            "t": "AC"
        },
        {
            "n": "봇키워드",
            "t": "BK"
        }
    ],
    "coupon": {
        "title": "10000원 할인 쿠폰",
        "description": "쿠폰 설명",
        "linkMobile": "https://www.popbill.com"
    },
    "msgs": [
        {
            "receiveNum": "01012345678",
            "receiveName": "홍길동"
        }
    ]
}'
요청 예시 (대량)
curl --request POST \
  --url 'https://{domain}/BMS/Text' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "plusFriendID": "@팝빌",
    "targeting": "I",
    "msgs": [
        {
            "receiveNum": "01012345678",
            "receiveName": "홍길동",
            "content": "브랜드 메시지 내용",
            "btns": [
                {
                    "n": "채널 추가",
                    "t": "AC"
                },
                {
                    "n": "봇키워드",
                    "t": "BK"
                }
            ],
            "coupon": {
                "title": "10000원 할인 쿠폰",
                "description": "쿠폰 설명",
                "linkMobile": "https://www.popbill.com"
            }
        }
    ]
}'
요청 예시 (동보)
curl --request POST \
  --url 'https://{domain}/BMS/Text' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "plusFriendID": "@팝빌",
    "targeting": "I",
    "content": "브랜드 메시지 내용",
    "btns": [
        {
            "n": "채널 추가",
            "t": "AC"
        },
        {
            "n": "봇키워드",
            "t": "BK"
        }
    ],
    "coupon": {
        "title": "10000원 할인 쿠폰",
        "description": "쿠폰 설명",
        "linkMobile": "https://www.popbill.com"
    },
    "msgs": [
        {
            "receiveNum": "01012345678",
            "receiveName": "홍길동"
        }
    ]
}'
Response
응답 본문
순번 변수명 타입 길이 설명
receiptNum string 18 접수번호
응답 예시 
{
    "receiptNum": "026012710214000001"
}

2. SendBMSImage - 브랜드 메시지 전송 (이미지)

POST https://popbill-test.linkhub.co.kr/BMS/Image
POST https://popbill.linkhub.co.kr/BMS/Image
  • 카카오톡 채널을 추가한 사용자 또는 마케팅 정보 수신에 동의한 사용자에게 이미지형 광고성 메시지를 전송합니다. (최대 1,000건)
  • 브랜드 메시지를 전송하기 위해서는 팝빌을 통해 브랜드 메시지 신청을 진행해야 합니다.
  • 브랜드 메시지 전송 전에 [UploadImage - 이미지 업로드] API로 이미지 업로드가 필요합니다.
  • 전송실패시 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
Request
요청 헤더
순번 변수명 필수 설명
Authorization Y 인증 토큰
[참고] 인증 및 헤더 설정
Content-Type Y 요청 본문 형식
application/json
X-PB-UserID N 팝빌회원 아이디
요청 본문
순번 변수명 타입 길이 필수 설명
plusFriendID string 30 Y 검색용 아이디
targeting string 1 Y 전송대상
I채널 친구
M전체
N비채널 친구
imageUrl string 500 조건부 이미지 URL
[UploadImage - 이미지 업로드] API로 응답받은 URL
동보 전송인 경우 필수
adultYN boolean - N 성인용 메시지 여부
기본값 : false
동보 전송인 경우 입력
content string 1300 조건부 브랜드 메시지 내용
줄바꿈 최대 99개
동보 전송인 경우 필수
unsubscribeNo string 13 조건부 080 수신거부 번호
{targeting}="M" or "N" 인 경우 필수
altYN boolean - N 대체문자 전송 여부
기본값 : false
sendNum string 20 조건부 발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
altSubject string 40 N 대체문자 제목
메시지 길이가 90byte 이상인 경우에만 적용
동보 전송인 경우 입력
altContent string 2000 조건부 대체문자 내용
대체문자 전송 시 필수
단위 : byte
동보 전송인 경우 입력
altUnsubscribeNo string 20 조건부 대체문자 080 수신거부 번호
대체문자 전송 시 필수
reserveDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50
기본값 : 즉시전송
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
btns array - N 버튼 목록
최대 5개 (쿠폰 버튼을 포함하는 경우 최대 4개)
동보 전송인 경우 입력
순번 변수명 타입 길이 필수 설명
n string 14 Y 버튼명
t string 2 Y 버튼 유형
  • WL웹링크
  • AL앱링크
  • MD메시지전달
  • BK봇키워드
  • AC채널추가
채널 추가 버튼은 첫 번째 위치에만 가능
u1 string 1000 N 버튼링크
- {t} = "AL" 경우 iOS 앱링크 적용
- {t} = "WL" 경우 Mobile 웹링크 적용
u2 string 1000 N 버튼링크
- {t} = "AL" 경우 Android 앱링크 적용
- {t} = "WL" 경우 PC 웹링크 적용
coupon object - N 쿠폰 버튼
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
동보 전송인 경우 입력
순번 변수명 타입 길이 필수 설명
title string 15 Y 쿠폰제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
description string 12 Y 쿠폰 설명
줄바꿈 사용 불가
linkMobile string 1000 조건부 Mobile 웹링크
linkPC string 1000 N PC 웹링크
linkAndroid string 1000 조건부 Android 앱링크
linkIos string 1000 조건부 iOS 앱링크
msgs array - Y 수신자 정보
순번 변수명 타입 길이 필수 설명
receiveNum string 20 Y 수신번호
receiveName string 70 N 수신자명
imageUrl string 500 조건부 이미지 URL
[UploadImage - 이미지 업로드] API로 응답받은 URL
대량 전송인 경우 필수
adultYN boolean - N 성인용 메시지 여부
기본값 : false
대량 전송인 경우 입력
content string 1300 조건부 브랜드 메시지 내용
줄바꿈 최대 99개
대량 전송인 경우 필수
altSubject string 40 N 대체문자 제목
메시지 길이가 90byte 이상인 경우에만 적용
대량 전송인 경우 입력
altContent string 2000 조건부 대체문자 내용
대체문자 전송 시 필수
단위 : byte
대량 전송인 경우 입력
interOPRefKey string 20 N 파트너 지정키
브랜드 메시지 대량 전송 시 파트너가 개별건마다 입력할 수 있는 값
btns array - N 버튼 목록
최대 5개 (쿠폰 버튼을 포함하는 경우 최대 4개)
대량 전송인 경우 입력
순번 변수명 타입 길이 필수 설명
n string 14 Y 버튼명
t string 2 Y 버튼 유형
  • WL웹링크
  • AL앱링크
  • MD메시지전달
  • BK봇키워드
  • AC채널추가
채널 추가 버튼은 첫 번째 위치에만 가능
u1 string 1000 N 버튼링크
- {t} = "AL" 경우 iOS 앱링크 적용
- {t} = "WL" 경우 Mobile 웹링크 적용
u2 string 1000 N 버튼링크
- {t} = "AL" 경우 Android 앱링크 적용
- {t} = "WL" 경우 PC 웹링크 적용
coupon object - N 쿠폰 버튼
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
대량 전송인 경우 입력
순번 변수명 타입 길이 필수 설명
title string 15 Y 쿠폰제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
description string 12 Y 쿠폰 설명
줄바꿈 사용 불가
linkMobile string 1000 조건부 Mobile 웹링크
linkPC string 1000 N PC 웹링크
linkAndroid string 1000 조건부 Android 앱링크
linkIos string 1000 조건부 iOS 앱링크
요청 예시 (단건)
curl --request POST \
  --url 'https://{domain}/BMS/Image' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "plusFriendID": "@팝빌",
    "targeting": "I",
    "imageUrl": "https://mud-kage.kakao.com/dn/bpQO3e/dJMcafL82dm/vFoK4fIWdew8igTXjsK/img_l.jpg",
    "content": "브랜드 메시지 내용",
    "btns": [
        {
            "n": "채널 추가",
            "t": "AC"
        },
        {
            "n": "봇키워드",
            "t": "BK"
        }
    ],
    "coupon": {
        "title": "10000원 할인 쿠폰",
        "description": "쿠폰 설명",
        "linkMobile": "https://www.popbill.com"
    },
    "msgs": [
        {
            "receiveNum": "01012345678",
            "receiveName": "홍길동"
        }
    ]
}'
요청 예시 (대량)
curl --request POST \
  --url 'https://{domain}/BMS/Image' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "plusFriendID": "@팝빌",
    "targeting": "I",
    "msgs": [
        {
            "receiveNum": "01012345678",
            "receiveName": "홍길동",
            "imageUrl": "https://mud-kage.kakao.com/dn/bpQO3e/dJMcafL82dm/vFoK4fIWdew8igTXjsK/img_l.jpg",
            "content": "브랜드 메시지 내용",
            "btns": [
                {
                    "n": "채널 추가",
                    "t": "AC"
                },
                {
                    "n": "봇키워드",
                    "t": "BK"
                }
            ],
            "coupon": {
                "title": "10000원 할인 쿠폰",
                "description": "쿠폰 설명",
                "linkMobile": "https://www.popbill.com"
            }
        }
    ]
}'
요청 예시 (동보)
curl --request POST \
  --url 'https://{domain}/BMS/Image' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "plusFriendID": "@팝빌",
    "targeting": "I",
    "imageUrl": "https://mud-kage.kakao.com/dn/bpQO3e/dJMcafL82dm/vFoK4fIWdew8igTXjsK/img_l.jpg",
    "content": "브랜드 메시지 내용",
    "btns": [
        {
            "n": "채널 추가",
            "t": "AC"
        },
        {
            "n": "봇키워드",
            "t": "BK"
        }
    ],
    "coupon": {
        "title": "10000원 할인 쿠폰",
        "description": "쿠폰 설명",
        "linkMobile": "https://www.popbill.com"
    },
    "msgs": [
        {
            "receiveNum": "01012345678",
            "receiveName": "홍길동"
        }
    ]
}'
Response
응답 본문
순번 변수명 타입 길이 설명
receiptNum string 18 접수번호
응답 예시 
{
    "receiptNum": "026012710214000001"
}

3. SendBMSWideImage - 브랜드 메시지 전송 (와이드 이미지)

POST https://popbill-test.linkhub.co.kr/BMS/WideImage
POST https://popbill.linkhub.co.kr/BMS/WideImage
  • 카카오톡 채널을 추가한 사용자 또는 마케팅 정보 수신에 동의한 사용자에게 와이드 이미지형 광고성 메시지를 전송합니다. (최대 1,000건)
  • 브랜드 메시지를 전송하기 위해서는 팝빌을 통해 브랜드 메시지 신청을 진행해야 합니다.
  • 브랜드 메시지 전송 전에 [UploadWideImage - 와이드형 이미지 업로드] API로 이미지 업로드가 필요합니다.
  • 전송실패시 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
Request
요청 헤더
순번 변수명 필수 설명
Authorization Y 인증 토큰
[참고] 인증 및 헤더 설정
Content-Type Y 요청 본문 형식
application/json
X-PB-UserID N 팝빌회원 아이디
요청 본문
순번 변수명 타입 길이 필수 설명
plusFriendID string 30 Y 검색용 아이디
targeting string 1 Y 전송대상
I채널 친구
M전체
N비채널 친구
imageUrl string 500 조건부 이미지 URL
[UploadWideImage -와이드 이미지 업로드] API로 응답받은 URL
동보 전송인 경우 필수
adultYN boolean - N 성인용 메시지 여부
기본값 : false
동보 전송인 경우 입력
content string 76 조건부 브랜드 메시지 내용
줄바꿈 최대 5개
동보 전송인 경우 필수
unsubscribeNo string 13 조건부 080 수신거부 번호
{targeting}="M" or "N" 인 경우 필수
altYN boolean - N 대체문자 전송 여부
기본값 : false
sendNum string 20 조건부 발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
altSubject string 40 N 대체문자 제목
메시지 길이가 90byte 이상인 경우에만 적용
동보 전송인 경우 입력
altContent string 2000 조건부 대체문자 내용
대체문자 전송 시 필수
단위 : byte
동보 전송인 경우 입력
altUnsubscribeNo string 20 조건부 대체문자 080 수신거부 번호
대체문자 전송 시 필수
reserveDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50
기본값 : 즉시전송
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
btns array - N 버튼 목록
최대 2개
동보 전송인 경우 입력
순번 변수명 타입 길이 필수 설명
n string 14 Y 버튼명
t string 2 Y 버튼 유형
  • WL웹링크
  • AL앱링크
  • MD메시지전달
  • BK봇키워드
  • AC채널추가
채널 추가 버튼은 첫 번째 위치에만 가능
u1 string 1000 N 버튼링크
- {t} = "AL" 경우 iOS 앱링크 적용
- {t} = "WL" 경우 Mobile 웹링크 적용
u2 string 1000 N 버튼링크
- {t} = "AL" 경우 Android 앱링크 적용
- {t} = "WL" 경우 PC 웹링크 적용
coupon object - N 쿠폰 버튼
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
동보 전송인 경우 입력
순번 변수명 타입 길이 필수 설명
title string 15 Y 쿠폰제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
description string 12 Y 쿠폰 설명
줄바꿈 사용 불가
linkMobile string 1000 조건부 Mobile 웹링크
linkPC string 1000 N PC 웹링크
linkAndroid string 1000 조건부 Android 앱링크
linkIos string 1000 조건부 iOS 앱링크
msgs array - Y 수신자 정보
순번 변수명 타입 길이 필수 설명
receiveNum string 20 Y 수신번호
receiveName string 70 N 수신자명
imageUrl string 500 조건부 이미지 URL
[UploadWideImage - 와이드 이미지 업로드] API로 응답받은 URL
대량 전송인 경우 필수
adultYN boolean - N 성인용 메시지 여부
기본값 : false
대량 전송인 경우 입력
content string 76 Y 브랜드 메시지 내용
줄바꿈 최대 5개
대량 전송인 경우 필수
altSubject string 40 N 대체문자 제목
메시지 길이가 90byte 이상인 경우에만 적용
대량 전송인 경우 입력
altContent string 2000 조건부 대체문자 내용
대체문자 전송 시 필수
단위 : byte
대량 전송인 경우 입력
interOPRefKey string 20 N 파트너 지정키
브랜드 메시지 대량 전송 시 파트너가 개별건마다 입력할 수 있는 값
btns array - N 버튼 목록
최대 2개
대량 전송인 경우 입력
순번 변수명 타입 길이 필수 설명
n string 8 Y 버튼명
t string 2 Y 버튼 유형
  • WL웹링크
  • AL앱링크
  • MD메시지전달
  • BK봇키워드
  • AC채널추가
채널 추가 버튼은 두 번째 위치에만 가능
u1 string 1000 N 버튼링크
- {t} = "AL" 경우 iOS 앱링크 적용
- {t} = "WL" 경우 Mobile 웹링크 적용
u2 string 1000 N 버튼링크
- {t} = "AL" 경우 Android 앱링크 적용
- {t} = "WL" 경우 PC 웹링크 적용
coupon object - N 쿠폰 버튼
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
대량 전송인 경우 입력
순번 변수명 타입 길이 필수 설명
title string 15 Y 쿠폰제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
description string 18 Y 쿠폰 설명
줄바꿈 사용 불가
linkMobile string 1000 조건부 Mobile 웹링크
linkPC string 1000 N PC 웹링크
linkAndroid string 1000 조건부 Android 앱링크
linkIos string 1000 조건부 iOS 앱링크
요청 예시 (단건)
curl --request POST \
  --url 'https://{domain}/BMS/WideImage' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "plusFriendID": "@팝빌",
    "targeting": "I",
    "imageUrl": "https://mud-kage.kakao.com/dn/bpQO3e/dJMcafL82dm/vFoK4fIWdew8igTXjsK/img_l.jpg",
    "content": "브랜드 메시지 내용",
    "btns": [
        {
            "n": "채널 추가",
            "t": "AC"
        },
        {
            "n": "봇키워드",
            "t": "BK"
        }
    ],
    "coupon": {
        "title": "10000원 할인 쿠폰",
        "description": "쿠폰 설명",
        "linkMobile": "https://www.popbill.com"
    },
    "msgs": [
        {
            "receiveNum": "01012345678",
            "receiveName": "홍길동"
        }
    ]
}'
요청 예시 (대량)
curl --request POST \
  --url 'https://{domain}/BMS/WideImage' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "plusFriendID": "@팝빌",
    "targeting": "I",
    "msgs": [
        {
            "receiveNum": "01012345678",
            "receiveName": "홍길동",
            "imageUrl": "https://mud-kage.kakao.com/dn/bpQO3e/dJMcafL82dm/vFoK4fIWdew8igTXjsK/img_l.jpg",
            "content": "브랜드 메시지 내용",
            "btns": [
                {
                    "n": "채널 추가",
                    "t": "AC"
                },
                {
                    "n": "봇키워드",
                    "t": "BK"
                }
            ],
            "coupon": {
                "title": "10000원 할인 쿠폰",
                "description": "쿠폰 설명",
                "linkMobile": "https://www.popbill.com"
            }
        }
    ]
}'
요청 예시 (동보)
curl --request POST \
  --url 'https://{domain}/BMS/WideImage' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "plusFriendID": "@팝빌",
    "targeting": "I",
    "imageUrl": "https://mud-kage.kakao.com/dn/bpQO3e/dJMcafL82dm/vFoK4fIWdew8igTXjsK/img_l.jpg",
    "content": "브랜드 메시지 내용",
    "btns": [
        {
            "n": "채널 추가",
            "t": "AC"
        },
        {
            "n": "봇키워드",
            "t": "BK"
        }
    ],
    "coupon": {
        "title": "10000원 할인 쿠폰",
        "description": "쿠폰 설명",
        "linkMobile": "https://www.popbill.com"
    },
    "msgs": [
        {
            "receiveNum": "01012345678",
            "receiveName": "홍길동"
        }
    ]
}'
Response
응답 본문
순번 변수명 타입 길이 설명
receiptNum string 18 접수번호
응답 예시 
{
    "receiptNum": "026012710214000001"
}

4. UploadImage - 이미지 업로드

POST https://popbill-test.linkhub.co.kr/BMS/Upload/Image/Default
POST https://popbill.linkhub.co.kr/BMS/Upload/Image/Default
  • 브랜드 메시지 전송에 사용할 이미지를 업로드하고, 업로드 된 이미지 URL을 응답 받습니다.
Request
요청 헤더
순번 변수명 필수 설명
Authorization Y 인증 토큰
[참고] 인증 및 헤더 설정
Content-Type Y 요청 본문 형식
multipart/form-data
X-PB-UserID N 팝빌회원 아이디
요청 본문
순번 변수명 타입 길이 필수 설명
image file - Y 이미지 파일
가로:세로 비율제한 2:1이상 3:4이하
권장 사이즈 800*400px
가로 500px 이상
파일형식 및 크기 jpg, png / 최대 5MB
요청 예시
curl --request POST \
  --url 'https://{domain}/BMS/Upload/Image/Default' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'image=@"/path/test.jpg"'
Response
응답 본문
순번 변수명 타입 길이 설명
code number - API 처리에 대한 응답코드
1성공
message string - API 처리에 대한 응답메시지
imageUrl string 500 이미지 URL
응답 예시 
{
    "code": "1",
    "message": "성공",
    "imageUrl": "https://mud-kage.kakao.com/dn/bMQ3ze/dJMcahpDs55/FnZPcowCMtxkeZkvSyopu1/img_l.jpg"
}

5. UploadWideImage - 와이드 이미지 업로드

POST https://popbill-test.linkhub.co.kr/BMS/Upload/Image/WideImage
POST https://popbill.linkhub.co.kr/BMS/Upload/Image/WideImage
  • 브랜드 메시지 전송에 사용할 와이드 이미지를 업로드하고, 업로드 된 이미지 URL을 응답 받습니다.
Request
요청 헤더
순번 변수명 필수 설명
Authorization Y 인증 토큰
[참고] 인증 및 헤더 설정
Content-Type Y 요청 본문 형식
multipart/form-data
X-PB-UserID N 팝빌회원 아이디
요청 본문
순번 변수명 타입 길이 필수 설명
image file - Y 이미지 파일
가로:세로 비율제한 2:1이상 1:1이하
권장 사이즈 800*600px
가로 500px 이상
파일형식 및 크기 jpg, png / 최대 5MB
요청 예시
curl --request POST \
  --url 'https://{domain}/BMS/Upload/Image/WideImage' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'image=@"/path/test.jpg"'
Response
응답 본문
순번 변수명 타입 길이 설명
code number - API 처리에 대한 응답코드
1성공
message string - API 처리에 대한 응답메시지
imageUrl string 500 이미지 URL
응답 예시 
{
    "code": "1",
    "message": "성공",
    "imageUrl": "https://mud-kage.kakao.com/dn/bMQ3ze/dJMcahpDs55/FnZPcowCMtxkeZkvSyopu1/img_l.jpg"
}

6. CancelReserve - 예약전송 취소 (접수번호)

GET https://popbill-test.linkhub.co.kr/KakaoTalk/{receiptNum}/Cancel
GET https://popbill.linkhub.co.kr/KakaoTalk/{receiptNum}/Cancel
  • 팝빌에서 반환받은 접수번호로 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
Request
요청 헤더
순번 변수명 필수 설명
Authorization Y 인증 토큰
[참고] 인증 및 헤더 설정
Accept-Language N 응답 언어 설정
ko-KR: 기본값
en-US
Accept-Encoding N 응답 압축 방식
gzip
X-PB-UserID N 팝빌회원 아이디
Query 파라미터
순번 변수명 타입 길이 필수 설명
receiptNum string 18 Y 팝빌에서 할당한 접수번호
카카오톡 예약전송 요청의 반환값
요청 예시
curl --request GET \
  --url 'https://{domain}/KakaoTalk/{receiptNum}/Cancel' \
  --header 'Authorization: Bearer {token}'
Response
응답 본문
순번 변수명 타입 길이 설명
code number - API 처리에 대한 응답코드
0미등록
1등록
message string - API 처리에 대한 응답메시지
응답 예시
{
    "code": 1,
    "message": "취소 완료"
}

7. CancelReservebyRCV - 예약전송 부분 취소 (접수번호)

POST https://popbill-test.linkhub.co.kr/KakaoTalk/{receiptNum}/Cancel
POST https://popbill.linkhub.co.kr/KakaoTalk/{receiptNum}/Cancel
  • 팝빌에서 반환받은 접수번호로 접수 건을 식별하여 수신번호에 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
Request
요청 헤더
순번 변수명 필수 설명
Authorization Y 인증 토큰
[참고] 인증 및 헤더 설정
Content-Type Y 요청 본문 형식
application/json
Accept-Language N 응답 언어 설정
ko-KR: 기본값
en-US
Accept-Encoding N 응답 압축 방식
gzip
X-PB-UserID N 팝빌회원 아이디
Query 파라미터
순번 변수명 타입 길이 필수 설명
receiptNum string 18 Y 팝빌에서 할당한 접수번호
카카오톡 예약전송 요청의 반환값
요청 본문
순번 변수명 타입 길이 필수 설명
receiveNum string 20 Y 예약전송 수신번호
요청 예시
curl --request POST \
  --url 'https://{domain}/KakaoTalk/{receiptNum}/Cancel' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "receiveNum": "01012345678"
  }'
Response
응답 본문
순번 변수명 타입 길이 설명
code number - API 처리에 대한 응답코드
0미등록
1등록
message string - API 처리에 대한 응답메시지
응답 예시
{
    "code": 1,
    "message": "취소 완료"
}

8. CancelReserveRN - 예약전송 전체 취소 (요청번호)

GET https://popbill-test.linkhub.co.kr/KakaoTalk/Cancel/{requestNum}
GET https://popbill.linkhub.co.kr/KakaoTalk/Cancel/{requestNum}
  • 파트너가 할당한 요청번호로 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
Request
요청 헤더
순번 변수명 필수 설명
Authorization Y 인증 토큰
[참고] 인증 및 헤더 설정
Accept-Language N 응답 언어 설정
ko-KR: 기본값
en-US
Accept-Encoding N 응답 압축 방식
gzip
X-PB-UserID N 팝빌회원 아이디
Query 파라미터
순번 변수명 타입 길이 필수 설명
requestNum string 36 Y 파트너가 할당한 요청번호
요청 예시
curl --request GET \
  --url 'https://{domain}/KakaoTalk/Cancel/{requestNum}' \
  --header 'Authorization: Bearer {token}'
Response
응답 본문
순번 변수명 타입 길이 설명
code number - API 처리에 대한 응답코드
0미등록
1등록
message string - API 처리에 대한 응답메시지
응답 예시
{
    "code": 1,
    "message": "취소 완료"
}

9. CancelReserveRNbyRCV - 예약전송 부분 취소 (요청번호)

POST https://popbill-test.linkhub.co.kr/KakaoTalk/Cancel/{requestNum}
POST https://popbill.linkhub.co.kr/KakaoTalk/Cancel/{requestNum}
  • 파트너가 할당한 요청번호로 접수 건을 식별하여 수신번호에 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
Request
요청 헤더
순번 변수명 필수 설명
Authorization Y 인증 토큰
[참고] 인증 및 헤더 설정
Content-Type Y 요청 본문 형식
application/json
Accept-Language N 응답 언어 설정
ko-KR: 기본값
en-US
Accept-Encoding N 응답 압축 방식
gzip
X-PB-UserID N 팝빌회원 아이디
Query 파라미터
순번 변수명 타입 길이 필수 설명
requestNum string 36 Y 파트너가 할당한 요청번호
요청 본문
순번 변수명 타입 길이 필수 설명
receiveNum string 20 Y 예약전송 수신번호
요청 예시
curl --request POST \
  --url 'https://{domain}/KakaoTalk/Cancel/{requestNum}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "receiveNum": "01012345678"
  }'
Response
응답 본문
순번 변수명 타입 길이 설명
code number - API 처리에 대한 응답코드
0미등록
1등록
message string - API 처리에 대한 응답메시지
응답 예시
{
    "code": 1,
    "message": "취소 완료"
}