콘텐츠로 이동

전송결과

1. GetMessages - 카카오톡 전송내역 확인

섹션 제목: “1. GetMessages - 카카오톡 전송내역 확인”
GET https://popbill-test.linkhub.co.kr/KakaoTalk/{receiptNum}
  • 팝빌에서 반환받은 접수번호를 통해 알림톡 전송상태 및 결과를 확인합니다.

Request

요청 헤더
순번 변수명 필수 설명
1AuthorizationY
2Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
3Accept-EncodingN
응답 압축 방식
  • gzip
4X-PB-UserIDN
팝빌회원 아이디
Path 파라미터
순번 변수명 타입 길이 필수 설명
1receiptNumstring18Y
팝빌에서 할당한 접수번호
요청 예시
curl --request GET \
--url 'https://{domain}/KakaoTalk/{receiptNum}' \
--header 'Authorization: Bearer {token}'

Response

응답 본문
순번 변수명 타입 길이 설명
1contentTypestring-
카카오톡 유형
  • 1 알림톡
  • 4 알림톡 이미지
  • 5 알림톡 강조표기
  • 6 브랜드 메시지 텍스트
  • 7 브랜드 메시지 이미지
  • 8 브랜드 메시지 와이드
  • 9 브랜드 메시지 리스트
  • 10 브랜드 메시지 캐러셀
  • 12 브랜드 메시지 커머스
  • 13 브랜드 메시지 캐러셀 커머스
2templateCodestring12
알림톡 템플릿 코드
알림톡 전송 시 사용한 코드값
3bmsTemplateCodestring12
브랜드 메시지 템플릿 코드
브랜드 메시지 전송 시 사용한 코드값
4plusFriendIDstring30
검색용 아이디
5targetingstring1
전송대상
  • I 채널친구
  • M 전체
  • N 비채널 친구
브랜드 메시지 전송 시 반환
6unsubscribeNostring20
080 수신거부 전화번호
브랜드 메시지 전송 시 반환
7sendNumstring20
발신번호
8altUnsubscribeNostring20
대체문자 080 수신거부 전화번호
브랜드 메시지 전송 시 반환
9altSubjectstring64
대체문자 제목
단위 : byte
10altContentstring2,000
대체문자 내용
단위 : byte
11altSendTypestring1
대체문자 유형
  • null 미전송
  • C 카카오톡과 동일 내용 전송
  • A 대체문자 내용 전송
12reserveDTstring14
예약일시
형식 : yyyyMMddHHmmss
13adsYNboolean-
광고메시지 전송 여부
  • true 광고
  • false 일반
14sendCntstring-
전송건수
15successCntstring-
성공건수
16failCntstring-
실패건수
17altCntstring-
대체문자 건수
18cancelCntstring-
취소건수
19array5
버튼 목록
btns
순번변수명타입길이설명
1nstring14
버튼명
2tstring2
버튼유형
  • WL 웹링크
  • AL 앱링크
  • TN 전화걸기
  • DS 배송조회
  • MD 메시지전달
  • BK 봇키워드
  • AC 채널추가
3u1string1,000
버튼링크
{t} = "AL" 경우 iOS 앱링크 적용
{t} = "WL" 경우 Mobile 웹링크 적용
4u2string1,000
버튼링크
{t} = "AL" 경우 Android 앱링크 적용
{t} = "WL" 경우 PC 웹링크 적용
5tgstring3
아웃 링크
  • out 디바이스 기본 브라우저
기본값 : 카카오톡 인앱 브라우저 사용
6telNumstring14
전화걸기 번호
20array1,000
전송결과 정보
msgs
순번변수명타입길이설명
1statenumber1
상태코드
2sendDTstring14
전송일시
형식 : yyyyMMddHHmmss
3resultnumber3
카카오 결과코드
{state} = 3 경우 카카오톡 전송결과 확인 가능
4resultDTstring14
전송결과 수신일시
형식 : yyyyMMddHHmmss
5reserveDTstring14
예약일시
형식 : yyyyMMddHHmmss
6contentTypestring-
카카오톡 유형
  • 1 알림톡
  • 4 알림톡 이미지
  • 5 알림톡 강조표기
  • 6 브랜드 메시지 텍스트
  • 7 브랜드 메시지 이미지
  • 8 브랜드 메시지 와이드
  • 9 브랜드 메시지 리스트
  • 10 브랜드 메시지 캐러셀
  • 12 브랜드 메시지 커머스
  • 13 브랜드 메시지 캐러셀 커머스
7receiveNumstring20
수신번호
8receiveNamestring70
수신자명
9emphasizeTitlestring50
강조표기 타이틀
알림톡 강조표기형 전송 시 반환
10adultYNboolean-
성인용 메시지 여부
브랜드 메시지 전송 시 반환
11headerstring20
제목
브랜드 메시지 전송 시 반환
12contentstring1,300
카카오톡 내용
13addContentstring34
부가메시지
브랜드 메시지 전송 시 반환
14imageUrlstring500
이미지 URL
브랜드 메시지 전송 시 반환
16altSubjectstring64
대체문자 제목
단위 : byte
17altContentstring2,000
대체문자 내용
단위 : byte
18altContentTypenumber-
대체문자 전송타입
  • 4 단문
  • 6 장문
19altSendDTstring14
대체문자 전송일시
형식 : yyyyMMddHHmmss
20altResultstring3
대체문자 통신사 결과코드
21altResultDTstring14
대체문자 전송결과 수신일시
형식 : yyyyMMddHHmmss
22receiptNumstring18
접수번호
23requestNumstring36
요청번호
24interOPRefKeystring20
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
25array4
아이템 목록
브랜드 메시지 전송 시 반환
item
순번변수명타입길이설명
1titlestring30
타이틀
2imageUrlstring500
이미지 URL
메인 아이템인 경우 [UploadWideListMainImage - 리스트 메인 이미지 업로드] API로 응답받은 URL
서브 아이템인 경우 [UploadWideListImage - 리스트 서브 이미지 업로드] API로 응답받은 URL
3linkMobilestring1,000
Mobile 웹링크
4linkPcstring1,000
PC 웹링크
5linkAndroidstring1,000
Android 앱링크
6linkIosstring1,000
iOS 앱링크
26object-
커머스 정보
브랜드 메시지 전송 시 반환
commerce
순번변수명타입길이설명
1titlestring30
상품명
2regularPricenumber-
정상가격
0 ~ 99,999,999
3discountTypestring1
할인유형
  • R 할인율
  • F 할인금액
4discountnumber-
5discountPricenumber-
할인가격
0 ~ 99,999,999
할인 적용 후 최종 가격
27object-
캐러셀 인트로
브랜드 메시지 전송 시 반환
head
순번변수명타입길이설명
1headerstring20
제목
2contentstring50
내용
3imageUrlstring500
4linkMobilestring1,000
Mobile 웹링크
5linkPcstring1,000
PC 웹링크
6linkAndroidstring1,000
Android 앱링크
7linkIosstring1,000
iOS 앱링크
29object-
캐러셀 더보기
브랜드 메시지 전송 시 반환
tail
순번변수명타입길이설명
1linkMobilestring1,000
Mobile 웹링크
2linkPcstring1,000
PC 웹링크
3linkAndroidstring1,000
Android 앱링크
4linkIosstring1,000
iOS 앱링크
30array5
버튼 목록
btns
순번변수명타입길이설명
1nstring14
버튼명
2tstring2
버튼유형
  • WL 웹링크
  • AL 앱링크
  • TN 전화걸기
  • DS 배송조회
  • MD 메시지전달
  • BK 봇키워드
  • AC 채널추가
3u1string1,000
버튼링크
{t} = "AL" 경우 iOS 앱링크 적용
{t} = "WL" 경우 Mobile 웹링크 적용
4u2string1,000
버튼링크
{t} = "AL" 경우 Android 앱링크 적용
{t} = "WL" 경우 PC 웹링크 적용
5tgstring3
아웃 링크
  • out 디바이스 기본 브라우저
기본값 : 카카오톡 인앱 브라우저 사용
6telNumstring14
전화걸기 번호
31object-
쿠폰
브랜드 메시지 전송 시 반환
coupon
순번변수명타입길이설명
1titlestring15
쿠폰 제목
  • #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999)
  • #{숫자}% 할인 쿠폰 (숫자 : 1~100)
  • 배송비 할인 쿠폰
  • #{7자 이내} 무료 쿠폰
  • #{7자 이내} UP 쿠폰
2descriptionstring12
쿠폰 설명
줄바꿈 사용 불가
3linkMobilestring1,000
Mobile 웹링크
4linkPcstring1,000
PC 웹링크
5linkAndroidstring1,000
Android 앱링크
6linkIosstring1,000
iOS 앱링크
32contentVariableobject-
브랜드 메시지 내용 변수
브랜드 메시지 전송 시 반환
33buttonVariableobject-
브랜드 메시지 버튼 변수
브랜드 메시지 전송 시 반환
34couponVariableobject-
브랜드 메시지 쿠폰 변수
브랜드 메시지 전송 시 반환
35commerceVariableobject-
브랜드 메시지 커머스 변수
브랜드 메시지 전송 시 반환
36object-
브랜드 메시지 캐러셀 변수
브랜드 메시지 전송 시 반환
carouselVariable
순번변수명타입길이설명
1contentVariableobject-
브랜드 메시지 캐러셀 내용 변수
캐러셀 제목, 캐러셀 내용, 캐러셀 이미지 링크, 캐러셀 부가메시지에 변수 사용한 경우 필수
2buttonVariableobject-
브랜드 메시지 캐러셀 버튼 변수
버튼 링크에 변수 사용한 경우 필수
3couponVariableobject-
브랜드 메시지 캐러셀 쿠폰 변수
쿠폰 설명, 링크에 변수 사용한 경우 필수
4commerceVariableobject-
브랜드 메시지 캐러셀 커머스 변수
상품명, 정상가격, 할인가격, 할인율, 할인금액에 변수 사용한 경우 필수
응답 예시
{
"contentType": "1",
"templateCode": "025050001056",
"plusFriendID": "@팝빌",
"sendNum": "1599-7709",
"sendCnt": "1",
"successCnt": "1",
"failCnt": "0",
"altCnt": "0",
"cancelCnt": "0",
"reserveDT": "20251021191706",
"adsYN": false,
"btns": [
{
"t": "WL",
"n": "팝빌 바로가기",
"u1": "https://www.popbill.com/",
"u2": "https://www.popbill.com/"
}
],
"msgs": [
{
"state": 3,
"receiveNum": "01012345678",
"receiveName": "수신자명",
"content": "[팝빌] 담당자 변경완료 안내\n\n#{담당자}님, 안녕하세요.",
"sendDT": "20251021191722",
"result": 100,
"resultDT": "20251021191722",
"reserveDT": "20251021191706",
"adsYN": false,
"altContent": "",
"altSubject": "",
"contentType": "6",
"regDT": "20251021191207",
"receiptNum": "025102119120600001",
"btns": [
{
"t": "WL",
"n": "버튼 제목",
"u1": "https://www.popbill.com",
"u2": "https://www.popbill.com"
}
],
"coupon": {
"title": "1000원 할인 쿠폰",
"description": "쿠폰 설명",
"linkMobile": "https://www.popbill.com"
}
}
]
}

2. GetMessagesRN - 카카오톡 전송내역 확인 (요청번호 할당)

섹션 제목: “2. GetMessagesRN - 카카오톡 전송내역 확인 (요청번호 할당)”
GET https://popbill-test.linkhub.co.kr/KakaoTalk/Get/{requestNum}
  • 파트너가 할당한 요청번호를 통해 알림톡 전송상태 및 결과를 확인합니다.

Request

요청 헤더
순번 변수명 필수 설명
1AuthorizationY
2Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
3Accept-EncodingN
응답 압축 방식
  • gzip
4X-PB-UserIDN
팝빌회원 아이디
Path 파라미터
순번 변수명 타입 길이 필수 설명
1requestNumstring36Y
파트너가 할당한 요청번호
요청 예시
curl --request GET \
--url 'https://{domain}/KakaoTalk/Get/{requestNum}' \
--header 'Authorization: Bearer {token}'

Response

응답 본문
순번 변수명 타입 길이 설명
1contentTypestring-
카카오톡 유형
  • 1 알림톡
  • 4 알림톡 이미지
  • 5 알림톡 강조표기
  • 6 브랜드 메시지 텍스트
  • 7 브랜드 메시지 이미지
  • 8 브랜드 메시지 와이드
  • 9 브랜드 메시지 리스트
  • 10 브랜드 메시지 캐러셀
  • 12 브랜드 메시지 커머스
  • 13 브랜드 메시지 캐러셀 커머스
2templateCodestring12
알림톡 템플릿 코드
알림톡 전송시 사용한 코드값
3bmsTemplateCodestring12
브랜드 메시지 템플릿 코드
브랜드 메시지 전송 시 사용한 코드값
4plusFriendIDstring30
검색용 아이디
5targetingstring1
전송대상
  • I 채널친구
  • M 전체
  • N 비채널 친구
브랜드 메시지 전송 시 반환
6unsubscribeNostring20
080 수신거부 전화번호
브랜드 메시지 전송 시 반환
7sendNumstring20
발신번호
8altUnsubscribeNostring20
대체문자 080 수신거부 전화번호
브랜드 메시지 전송 시 반환
9altSubjectstring64
대체문자 제목
단위 : byte
10altContentstring2,000
대체문자 내용
단위 : byte
11altSendTypestring1
대체문자 유형
  • null 미전송
  • C 카카오톡과 동일 내용 전송
  • A 대체문자 내용 전송
12reserveDTstring14
예약일시
형식 : yyyyMMddHHmmss
13adsYNboolean-
광고메시지 전송 여부
  • true 광고
  • false 일반
14sendCntstring-
전송건수
15successCntstring-
성공건수
16failCntstring-
실패건수
17altCntstring-
대체문자 건수
18cancelCntstring-
취소건수
19array5
버튼 목록
btns
순번변수명타입길이설명
1nstring14
버튼명
2tstring2
버튼유형
  • WL 웹링크
  • AL 앱링크
  • TN 전화걸기
  • DS 배송조회
  • MD 메시지전달
  • BK 봇키워드
  • AC 채널추가
3u1string1,000
버튼링크
{t} = "AL" 경우 iOS 앱링크 적용
{t} = "WL" 경우 Mobile 웹링크 적용
4u2string1,000
버튼링크
{t} = "AL" 경우 Android 앱링크 적용
{t} = "WL" 경우 PC 웹링크 적용
5tgstring3
아웃 링크
  • out 디바이스 기본 브라우저
기본값 : 카카오톡 인앱 브라우저 사용
6telNumstring14
전화걸기 번호
20array-
전송결과 정보
최대 : 1,000건
msgs
순번변수명타입길이설명
1statenumber1
상태코드
2sendDTstring14
전송일시
형식 : yyyyMMddHHmmss
3resultnumber3
카카오 결과코드
{state} = 3 경우 카카오톡 전송결과 확인 가능
4resultDTstring14
전송결과 수신일시
형식 : yyyyMMddHHmmss
5reserveDTstring14
예약일시
형식 : yyyyMMddHHmmss
6contentTypestring-
카카오톡 유형
  • 1 알림톡
  • 4 알림톡 이미지
  • 5 알림톡 강조표기
  • 6 브랜드 메시지 텍스트
  • 7 브랜드 메시지 이미지
  • 8 브랜드 메시지 와이드
  • 9 브랜드 메시지 리스트
  • 10 브랜드 메시지 캐러셀
  • 12 브랜드 메시지 커머스
  • 13 브랜드 메시지 캐러셀 커머스
7receiveNumstring20
수신번호
8receiveNamestring70
수신자명
9emphasizeTitlestring50
강조표기 타이틀
알림톡 강조표기형 전송 시 반환
10adultYNboolean-
성인용 메시지 여부
브랜드 메시지 전송 시 반환
11headerstring20
제목
브랜드 메시지 전송 시 반환
12contentstring1,300
카카오톡 내용
13addContentstring34
부가메시지
브랜드 메시지 전송 시 반환
14imageUrlstring500
이미지 URL
브랜드 메시지 전송 시 반환
16altSubjectstring64
대체문자 제목
단위 : byte
17altContentstring2,000
대체문자 내용
단위 : byte
18altContentTypenumber-
대체문자 전송타입
  • 4 단문
  • 6 장문
19altSendDTstring14
대체문자 전송일시
형식 : yyyyMMddHHmmss
20altResultstring3
대체문자 통신사 결과코드
21altResultDTstring14
대체문자 전송결과 수신일시
형식 : yyyyMMddHHmmss
22receiptNumstring18
접수번호
23requestNumstring36
요청번호
24interOPRefKeystring20
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
25array4
아이템 목록
브랜드 메시지 전송 시 반환
item
순번변수명타입길이설명
1titlestring30
타이틀
2imageUrlstring500
이미지 URL
메인 아이템인 경우 [UploadWideListMainImage - 리스트 메인 이미지 업로드] API로 응답받은 URL
서브 아이템인 경우 [UploadWideListImage - 리스트 서브 이미지 업로드] API로 응답받은 URL
3linkMobilestring1,000
Mobile 웹링크
4linkPcstring1,000
PC 웹링크
5linkAndroidstring1,000
Android 앱링크
6linkIosstring1,000
iOS 앱링크
26object-
커머스 정보
브랜드 메시지 전송 시 반환
commerce
순번변수명타입길이설명
1titlestring30
상품명
2regularPricenumber-
정상가격
0 ~ 99,999,999
3discountTypestring1
할인유형
  • R 할인율
  • F 할인금액
4discountnumber-
5discountPricenumber-
할인가격
0 ~ 99,999,999
할인 적용 후 최종 가격
27object-
캐러셀 인트로
브랜드 메시지 전송 시 반환
head
순번변수명타입길이설명
1headerstring20
제목
2contentstring50
내용
3imageUrlstring500
4linkMobilestring1,000
Mobile 웹링크
5linkPcstring1,000
PC 웹링크
6linkAndroidstring1,000
Android 앱링크
7linkIosstring1,000
iOS 앱링크
29object-
캐러셀 더보기
tail
순번변수명타입길이설명
1linkMobilestring1,000
Mobile 웹링크
2linkPcstring1,000
PC 웹링크
3linkAndroidstring1,000
Android 앱링크
4linkIosstring1,000
iOS 앱링크
30array5
버튼 목록
btns
순번변수명타입길이설명
1nstring14
버튼명
2tstring2
버튼유형
  • WL 웹링크
  • AL 앱링크
  • TN 전화걸기
  • DS 배송조회
  • MD 메시지전달
  • BK 봇키워드
  • AC 채널추가
3u1string1,000
버튼링크
{t} = "AL" 경우 iOS 앱링크 적용
{t} = "WL" 경우 Mobile 웹링크 적용
4u2string1,000
버튼링크
{t} = "AL" 경우 Android 앱링크 적용
{t} = "WL" 경우 PC 웹링크 적용
5tgstring3
아웃 링크
  • out 디바이스 기본 브라우저
기본값 : 카카오톡 인앱 브라우저 사용
6telNumstring14
전화걸기 번호
31object-
쿠폰
브랜드 메시지 전송 시 반환
coupon
순번변수명타입길이설명
1titlestring15
쿠폰 제목
  • #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999)
  • #{숫자}% 할인 쿠폰 (숫자 : 1~100)
  • 배송비 할인 쿠폰
  • #{7자 이내} 무료 쿠폰
  • #{7자 이내} UP 쿠폰
2descriptionstring12
쿠폰 설명
줄바꿈 사용 불가
3linkMobilestring1,000
Mobile 웹링크
4linkPcstring1,000
PC 웹링크
5linkAndroidstring1,000
Android 앱링크
6linkIosstring1,000
iOS 앱링크
32contentVariableobject-
브랜드 메시지 내용 변수
브랜드 메시지 전송 시 반환
33buttonVariableobject-
브랜드 메시지 버튼 변수
브랜드 메시지 전송 시 반환
34couponVariableobject-
브랜드 메시지 쿠폰 변수
브랜드 메시지 전송 시 반환
35commerceVariableobject-
브랜드 메시지 커머스 변수
브랜드 메시지 전송 시 반환
36object-
브랜드 메시지 캐러셀 변수
브랜드 메시지 전송 시 반환
carouselVariable
순번변수명타입길이설명
1contentVariableobject-
브랜드 메시지 캐러셀 내용 변수
캐러셀 제목, 캐러셀 내용, 캐러셀 이미지 링크, 캐러셀 부가메시지에 변수 사용한 경우 필수
2buttonVariableobject-
브랜드 메시지 캐러셀 버튼 변수
버튼 링크에 변수 사용한 경우 필수
3couponVariableobject-
브랜드 메시지 캐러셀 쿠폰 변수
쿠폰 설명, 링크에 변수 사용한 경우 필수
4commerceVariableobject-
브랜드 메시지 캐러셀 커머스 변수
상품명, 정상가격, 할인가격, 할인율, 할인금액에 변수 사용한 경우 필수
응답 예시
{
"contentType": "6",
"requestNum": "25251026131000",
"templateCode": "025050001052",
"plusFriendID": "@팝빌",
"sendNum": "1599-7709",
"altContent": "대체문자 내용",
"sendCnt": "2",
"successCnt": "0",
"failCnt": "2",
"altCnt": "0",
"cancelCnt": "0",
"adsYN": false,
"btns": [
{
"t": "WL",
"n": "팝빌 바로가기",
"u1": "https://www.popbill.com/",
"u2": "https://www.popbill.com/"
}
],
"msgs": [
{
"state": 3,
"receiveNum": "01022223333",
"receiveName": "수신자명",
"content": "[테스트] 테스트 템플릿입니다",
"sendDT": "20251026131238",
"result": 680,
"resultDT": "20251026131238",
"adsYN": false,
"contentType": "1",
"regDT": "20251026131236",
"receiptNum": "025102613123600001",
"requestNum": "25251026131000",
"btns": [
{
"t": "WL",
"n": "버튼 제목",
"u1": "https://www.popbill.com",
"u2": "https://www.popbill.com"
}
],
"coupon": {
"title": "1000원 할인 쿠폰",
"description": "쿠폰 설명",
"linkMobile": "https://www.popbill.com"
}
}
]
}
GET https://popbill-test.linkhub.co.kr/KakaoTalk/Search
  • 검색조건에 해당하는 카카오톡 전송내역을 조회합니다. (조회기간 단위 : 최대 2개월)
  • 카카오톡 접수일시로부터 12개월 이내 접수건만 조회할 수 있습니다.

매개변수 Page, PerPage, Order를 이용하여 페이징 기능을 구현할 수 있습니다.

Request

요청 헤더
순번 변수명 필수 설명
1AuthorizationY
2Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
3Accept-EncodingN
응답 압축 방식
  • gzip
4X-PB-UserIDN
팝빌회원 아이디
Query 파라미터
순번 변수명 타입 길이 필수 설명
1SDatestring8Y
검색 시작일자
형식 : yyyyMMdd
2EDatestring8Y
검색 종료일자
형식 : yyyyMMdd
3Statestring-N
전송상태 (다중 선택 가능)
  • 0 전송대기
  • 1 전송중
  • 2 전송성공
  • 3 대체문자 전송성공
  • 4 전송실패
  • 5 예약취소
다중 선택시 콤마(',')로 구분. 예) 0,1
4Itemstring-N
검색대상(다중 선택 가능)
  • ATS 알림톡
  • BMS 브랜드 메시지
다중 선택 시 콤마(',')로 구분. 예) ATS,BMS
기본값 : 전체조회
5ReserveYNstring1N
전송유형별 조회 (택 1)
  • 0 즉시전송건
  • 1 예약전송건
기본값 : 전체조회
6SenderOnlyboolean-N
사용자권한별 조회
  • true 팝빌회원 아이디(UserID)로 전송한 카카오톡만 조회
  • false 전송한 카카오톡 전체 조회 : 기본값
7Orderstring1N
카카오톡 접수일시를 기준으로 하는 목록 정렬 방향
  • D 내림차순 : 기본값
  • A 오름차순
8Pagenumber-N
목록 페이지번호
기본값 : 1
9PerPagenumber-N
페이지당 표시할 목록 건수
최대 : 1,000건
기본값 : 500건
10QStringstring70N
조회 검색어(수신자명, 수신번호)
기본값 : 전체조회
11PlusFriendIDstring30N
검색용 아이디
12ContentTypestring-N
카카오톡 유형 (다중 선택 가능)
  • 1 알림톡
  • 4 알림톡 이미지
  • 5 알림톡 강조표기
  • 6 브랜드 메시지 텍스트
  • 7 브랜드 메시지 이미지
  • 8 브랜드 메시지 와이드
  • 9 브랜드 메시지 리스트
  • 10 브랜드 메시지 캐러셀
  • 12 브랜드 메시지 커머스
  • 13 브랜드 메시지 캐러셀 커머스
다중 선택 시 콤마(',')로 구분. 예) 1,4
요청 예시
curl --request GET \
--url 'https://{domain}/KakaoTalk/Search?SDate={Sdate}&EDate={EDate}&State={State}' \
--header 'Authorization: Bearer {token}'

Response

응답 본문
순번 변수명 타입 길이 설명
1codenumber-
API 처리에 대한 응답코드
  • 1 성공
2messagestring-
API 처리에 대한 응답메시지
3totalnumber-
총 검색결과 건수
4perPagenumber-
페이지 당 목록 건수
5pageNumnumber-
페이지 번호
6pageCountnumber-
페이지 개수
7array1,000
전송결과 정보
list
순번변수명타입길이설명
1statenumber1
상태코드
2sendDTstring14
전송일시
형식 : yyyyMMddHHmmss
3resultnumber3
카카오 결과코드
{state} = 3 경우 카카오톡 전송결과 확인 가능
4resultDTstring14
전송결과 수신일시
형식 : yyyyMMddHHmmss
5contentTypestring-
카카오톡 유형
  • 1 알림톡
  • 4 알림톡 이미지
  • 5 알림톡 강조표기
  • 6 브랜드 메시지 텍스트
  • 7 브랜드 메시지 이미지
  • 8 브랜드 메시지 와이드
  • 9 브랜드 메시지 리스트
  • 10 브랜드 메시지 캐러셀
  • 12 브랜드 메시지 커머스
  • 13 브랜드 메시지 캐러셀 커머스
6receiveNumstring20
수신번호
7receiveNamestring70
수신자명
8emphasizeTitlestring50
강조표기 타이틀
알림톡 강조표기형 전송 시 반환
9adultYNboolean-
성인용 메시지 여부
브랜드 메시지 전송 시 반환
10headerstring20
제목
브랜드 메시지 전송 시 반환
11contentstring1,300
카카오톡 내용
12addContentstring34
부가메시지
브랜드 메시지 전송 시 반환
13imageUrlstring500
이미지 URL
15altSubjectstring64
대체문자 제목
단위 : byte
16altContentstring2,000
대체문자 내용
단위 : byte
17altContentTypenumber-
대체문자 전송타입
  • 4 단문
  • 6 장문
18altSendDTstring14
대체문자 전송일시
형식 : yyyyMMddHHmmss
19altResultstring3
대체문자 통신사 결과코드
20altResultDTstring14
대체문자 전송결과 수신일시
형식 : yyyyMMddHHmmss
21receiptNumstring18
접수번호
22requestNumstring36
요청번호
23interOPRefKeystring20
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
24array4
아이템 목록
브랜드 메시지 전송 시 반환
item
순번변수명타입길이설명
1titlestring30
타이틀
2imageUrlstring500
이미지 URL
메인 아이템인 경우 [UploadWideListMainImage - 리스트 메인 이미지 업로드] API로 응답받은 URL
서브 아이템인 경우 [UploadWideListImage - 리스트 서브 이미지 업로드] API로 응답받은 URL
3linkMobilestring1,000
Mobile 웹링크
4linkPcstring1,000
PC 웹링크
5linkAndroidstring1,000
Android 앱링크
6linkIosstring1,000
iOS 앱링크
25object-
커머스 정보
브랜드 메시지 전송 시 반환
commerce
순번변수명타입길이설명
1titlestring30
상품명
2regularPricenumber-
정상가격
0 ~ 99,999,999
3discountTypestring1
할인유형
  • R 할인율
  • F 할인금액
4discountnumber-
5discountPricenumber-
할인가격
0 ~ 99,999,999
할인 적용 후 최종 가격
26object-
캐러셀 인트로
브랜드 메시지 전송 시 반환
head
순번변수명타입길이설명
1headerstring20
제목
2contentstring50
내용
3imageUrlstring500
4linkMobilestring1,000
Mobile 웹링크
5linkPcstring1,000
PC 웹링크
6linkAndroidstring1,000
Android 앱링크
7linkIosstring1,000
iOS 앱링크
28object-
캐러셀 더보기
브랜드 메시지 전송 시 반환
tail
순번변수명타입길이설명
1linkMobilestring1,000
Mobile 웹링크
2linkPcstring1,000
PC 웹링크
3linkAndroidstring1,000
Android 앱링크
4linkIosstring1,000
iOS 앱링크
29array5
버튼 목록
btns
순번변수명타입길이설명
1nstring14
버튼명
2tstring2
버튼유형
  • WL 웹링크
  • AL 앱링크
  • TN 전화걸기
  • DS 배송조회
  • MD 메시지전달
  • BK 봇키워드
  • AC 채널추가
3u1string1,000
버튼링크
{t} = "AL" 경우 iOS 앱링크 적용
{t} = "WL" 경우 Mobile 웹링크 적용
4u2string1,000
버튼링크
{t} = "AL" 경우 Android 앱링크 적용
{t} = "WL" 경우 PC 웹링크 적용
5tgstring3
아웃 링크
  • out 디바이스 기본 브라우저
기본값 : 카카오톡 인앱 브라우저 사용
6telNumstring14
전화걸기 번호
30object-
쿠폰
브랜드 메시지 전송 시 반환
coupon
순번변수명타입길이설명
1titlestring15
쿠폰 제목
  • #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999)
  • #{숫자}% 할인 쿠폰 (숫자 : 1~100)
  • 배송비 할인 쿠폰
  • #{7자 이내} 무료 쿠폰
  • #{7자 이내} UP 쿠폰
2descriptionstring12
쿠폰 설명
줄바꿈 사용 불가
3linkMobilestring1,000
Mobile 웹링크
4linkPcstring1,000
PC 웹링크
5linkAndroidstring1,000
Android 앱링크
6linkIosstring1,000
iOS 앱링크
31contentVariableobject-
브랜드 메시지 내용 변수
브랜드 메시지 전송 시 반환
32buttonVariableobject-
브랜드 메시지 버튼 변수
브랜드 메시지 전송 시 반환
33couponVariableobject-
브랜드 메시지 쿠폰 변수
브랜드 메시지 전송 시 반환
34commerceVariableobject-
브랜드 메시지 커머스 변수
브랜드 메시지 전송 시 반환
35object-
브랜드 메시지 캐러셀 변수
브랜드 메시지 전송 시 반환
carouselVariable
순번변수명타입길이설명
1contentVariableobject-
브랜드 메시지 캐러셀 내용 변수
캐러셀 제목, 캐러셀 내용, 캐러셀 이미지 링크, 캐러셀 부가메시지에 변수 사용한 경우 필수
2buttonVariableobject-
브랜드 메시지 캐러셀 버튼 변수
버튼 링크에 변수 사용한 경우 필수
3couponVariableobject-
브랜드 메시지 캐러셀 쿠폰 변수
쿠폰 설명, 링크에 변수 사용한 경우 필수
4commerceVariableobject-
브랜드 메시지 캐러셀 커머스 변수
상품명, 정상가격, 할인가격, 할인율, 할인금액에 변수 사용한 경우 필수
응답 예시
{
"code": 1,
"message": "검색 완료",
"total": 10,
"perPage": 500,
"pageNum": 1,
"pageCount": 1,
"list": [
{
"state": 3,
"receiveNum": "01012345678",
"receiveName": "수신자명",
"content": "[팝빌] 국세청 전송실패 안내",
"sendDT": "20251025091511",
"result": 100,
"resultDT": "20251025091511",
"adsYN": false,
"altContent": "[팝빌] 현금영수증 국세청 전송실패 안내",
"contentType": "6",
"regDT": "20251025091509",
"receiptNum": "025102509150800001",
"btns": [
{
"t": "WL",
"n": "버튼 제목",
"u1": "https://www.popbill.com",
"u2": "https://www.popbill.com"
}
],
"coupon": {
"title": "1000원 할인 쿠폰",
"description": "쿠폰 설명",
"linkMobile": "https://www.popbill.com"
}
}
]
}

4. GetSentListURL - 카카오톡 전송내역 팝업 URL

섹션 제목: “4. GetSentListURL - 카카오톡 전송내역 팝업 URL”
GET https://popbill-test.linkhub.co.kr/KakaoTalk

카카오톡 전송내역 팝업 URL 미리보기

카카오톡 전송내역 팝업 URL 미리보기

카카오톡 전송내역 팝업 URL을 반환합니다.

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

Request

요청 헤더
순번 변수명 필수 설명
1AuthorizationY
2Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
3Accept-EncodingN
응답 압축 방식
  • gzip
4X-PB-UserIDN
팝빌회원 아이디
Query 파라미터
순번 변수명 타입 길이 필수 설명
1TGstring-Y
고정값 : BOX
요청 예시
curl --request GET \
--url 'https://{domain}/KakaoTalk?TG=BOX' \
--header 'Authorization: Bearer {token}'

Response

응답 본문
순번 변수명 타입 길이 설명
1urlstring-
카카오톡 전송내역 팝업 URL
응답 예시
{
"url": "https://test.popbill.com/App/API?T=IRXSGITDREOTPOIRLPUHCB4BSBC4...NX7BMAR3="
}