카카오톡 전송
1. SendATS - 알림톡 전송
POST
https://popbill-test.linkhub.co.kr/ATS
POST
https://popbill.linkhub.co.kr/ATS
- 승인된 템플릿 내용을 작성하여 다수건의 알림톡 전송을 팝빌에 접수하며, 수신자별 개별 내용 또는 동일 내용을 전송합니다. (최대 1,000건)
- 전송실패시 사전에 지정한 변수 'altSendType' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
- 승인된 템플릿과 일치하지 않는 내용(알림톡 내용, 버튼 목록)을 입력하는 경우 '전송실패' 처리됩니다.
- 수신자 전체에 동일한 내용을 전송하는 동보 전송, 수신자별로 개별 내용을 전송하는 대량 전송을 지원합니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | 인증 토큰 | |
| Content-Type | Y | 요청 본문 형식 application/json |
|
| Accept-Language | N |
응답 언어 설정
ko-KR: 기본값
en-US
|
|
| Accept-Encoding | N | 응답 압축 방식 gzip |
|
| X-PB-UserID | N | 팝빌회원 아이디 |
요청 본문
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| templateCode | string | 12 | Y | 승인된 알림톡 템플릿 코드 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| emphasizeTitle | string | 50 | N |
강조표기 타이틀
템플릿 예시 : 주문하신 #{상품}이 도착했습니다.
작성 예시 : 주문하신 노트북이 도착했습니다. 동보 전송인 경우 입력
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| content | string | 1000 | 조건부 |
알림톡 내용
최대 : 1,000자
- 템플릿 예시 : 주문하신 #{상품}이 도착했습니다. - 작성 예시 : 주문하신 노트북이 도착했습니다. 동보 전송인 경우 필수
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| snd | string | 20 | 조건부 |
발신번호
대체문자 전송인 경우 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| altSubject | string | 40 | N |
대체문자 제목
메시지 길이가 90byte 이상인 경우에만 적용
동보 전송인 경우 입력
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| altContent | string | 2000 | N |
대체문자 내용
메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송
동보 전송인 경우 입력
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| altSendType | string | 1 | N |
대체문자 유형
C알림톡 내용 전송
A대체문자 내용 전송
기본값 : 미전송
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sndDT | string | 14 | N |
전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| requestNum | string | 36 | N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| msgs | array | - | Y | 수신자 정보 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
요청 예시
# 단건 전송
curl --request POST \
--url 'https://{domain}/ATS' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"templateCode": "025080000032",
"content": "알림톡 내용",
"msgs": [
{
"rcv": "01012345678",
"rcvnm": "수신자명"
}
],
"btns": [
{
"n": "버튼명",
"t": "WL",
"u1": "https://www.popbill.com",
"u2": "https://www.popbill.com"
}
]
}'
# 대량 전송
curl --request POST \
--url 'https://{domain}/ATS' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"templateCode": "025050001056",
"msgs": [
{
"rcv": "01012345678",
"msg": "알림톡 내용",
"rcvnm": "수신자명",
"btns": [
{
"n": "버튼명",
"t": "WL",
"u1": "https://www.popbill.com",
"u2": "https://www.popbill.com"
}
]
}
]
}'
# 동보 전송
curl --request POST \
--url 'https://{domain}/ATS' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"templateCode": "025080000032",
"content": "알림톡 내용",
"msgs": [
{
"rcv": "01012345678",
"rcvnm": "수신자명"
}
],
"btns": [
{
"n": "버튼명",
"t": "WL",
"u1": "https://www.popbill.com",
"u2": "https://www.popbill.com"
}
]
}'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| receiptNum | string | 18 | 접수번호 |
응답 예시
{
"receiptNum": "025102015544100001"
}
2. 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 |
전송대상
M전체
I채널 친구
N비채널 친구
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sendNum | string | 20 | 조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| unsubscribeNo | string | 13 | 조건부 |
080 수신거부 번호
{targeting}="M" or "N" 인 경우 필수
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| altYN | boolean | - | N |
대체문자 전송 여부
기본값 : false
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| altUnsubscribeNo | string | 20 | 조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| reserveDT | string | 14 | N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50 기본값 : 즉시전송
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| requestNum | string | 36 | N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| msgs | array | - | Y | 수신자 정보 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
요청 예시
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"
}
}
]
}'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| receiptNum | string | 18 | 접수번호 |
응답 예시
{
"receiptNum": "026012710214000001"
}
3. SendBMSImage - 브랜드 메시지 전송 (이미지)
POST
https://popbill-test.linkhub.co.kr/BMS/Image
POST
https://popbill.linkhub.co.kr/BMS/Image
- 카카오톡 채널을 추가한 사용자 또는 마케팅 정보 수신에 동의한 사용자에게 이미지형 광고성 메시지를 전송합니다. (최대 1,000건)
- 전송실패시 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
- 브랜드 메시지를 전송하기 위해서는 팝빌을 통해 브랜드 메시지 신청을 진행해야 합니다.
- 브랜드 메시지 전송 전에 [UploadImage - 이미지 업로드] API로 이미지 업로드가 필요합니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | 인증 토큰 | |
| Content-Type | Y | 요청 본문 형식 application/json |
|
| X-PB-UserID | N | 팝빌회원 아이디 |
요청 본문
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| plusFriendID | string | 30 | Y | 검색용 아이디 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| targeting | string | 1 | Y |
전송대상
M전체
I채널 친구
N비채널 친구
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| imageUrl | string | 500 | Y |
이미지 URL
[UploadImage - 이미지 업로드] API로 응답받은 URL
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| imageLink | string | 256 | N |
이미지 링크 URL
이미지를 클릭하면 연결되는 URL
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sendNum | string | 20 | 조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| unsubscribeNo | string | 13 | 조건부 |
080 수신거부 번호
{targeting}="M" or "N" 인 경우 필수
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| altYN | boolean | - | N |
대체문자 전송 여부
기본값 : false
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| altUnsubscribeNo | string | 20 | 조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| reserveDT | string | 14 | N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50 기본값 : 즉시전송
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| requestNum | string | 36 | N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| msgs | array | - | Y | 수신자 정보 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
요청 예시
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",
"msgs": [
{
"rcv": "01012345678",
"rcvnm": "홍길동",
"content": "브랜드 메시지 내용",
"btns": [
{
"n": "채널 추가",
"t": "AC"
},
{
"n": "봇키워드",
"t": "BK"
}
],
"coupon": {
"title": "10000원 할인 쿠폰",
"description": "쿠폰 설명",
"linkMobile": "https://www.popbill.com"
}
}
]
}'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| receiptNum | string | 18 | 접수번호 |
응답 예시
{
"receiptNum": "026012710214000001"
}
4. SendBMSWideImage - 브랜드 메시지 전송 (와이드 이미지)
POST
https://popbill-test.linkhub.co.kr/BMS/WideImage
POST
https://popbill.linkhub.co.kr/BMS/WideImage
- 카카오톡 채널을 추가한 사용자 또는 마케팅 정보 수신에 동의한 사용자에게 와이드 이미지형 광고성 메시지를 전송합니다. (최대 1,000건)
- 전송실패시 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
- 브랜드 메시지를 전송하기 위해서는 팝빌을 통해 브랜드 메시지 신청을 진행해야 합니다.
- 브랜드 메시지 전송 전에 [UploadWideImage - 와이드형 이미지 업로드] API로 이미지 업로드가 필요합니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | 인증 토큰 | |
| Content-Type | Y | 요청 본문 형식 application/json |
|
| X-PB-UserID | N | 팝빌회원 아이디 |
요청 본문
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| plusFriendID | string | 30 | Y | 검색용 아이디 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| targeting | string | 1 | Y |
전송대상
M전체
I채널 친구
N비채널 친구
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| imageUrl | string | 500 | Y |
이미지 URL
[UploadWideImage -와이드 이미지 업로드] API로 응답받은 URL
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| imageLink | string | 256 | N |
이미지 링크 URL
이미지를 클릭하면 연결되는 URL
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sendNum | string | 20 | 조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| unsubscribeNo | string | 13 | 조건부 |
080 수신거부 번호
{targeting}="M" or "N" 인 경우 필수
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| altYN | boolean | - | N |
대체문자 전송 여부
기본값 : false
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| altUnsubscribeNo | string | 20 | 조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| reserveDT | string | 14 | N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50 기본값 : 즉시전송
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| requestNum | string | 36 | N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| msgs | array | - | Y | 수신자 정보 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
요청 예시
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",
"msgs": [
{
"rcv": "01012345678",
"rcvnm": "홍길동",
"content": "브랜드 메시지 내용",
"btns": [
{
"n": "채널 추가",
"t": "AC"
},
{
"n": "봇키워드",
"t": "BK"
}
],
"coupon": {
"title": "10000원 할인 쿠폰",
"description": "쿠폰 설명",
"linkMobile": "https://www.popbill.com"
}
}
]
}'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| receiptNum | string | 18 | 접수번호 |
응답 예시
{
"receiptNum": "026012710214000001"
}
5. 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"
}
6. 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"
}
7. 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": "취소 완료"
}
8. 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": "취소 완료"
}
9. 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": "취소 완료"
}
10. 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": "취소 완료"
}
