정보확인

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

GET https://popbill-test.linkhub.co.kr/KakaoTalk/{receiptNum}

GET https://popbill.linkhub.co.kr/KakaoTalk/{receiptNum}

팝빌에서 반환받은 접수번호를 통해 알림톡 전송상태 및 결과를 확인합니다.

Request

요청 헤더

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

Path 파라미터

순번	변수명	타입	길이	필수	설명
	receiptNum	string	18	Y	팝빌에서 할당한 접수번호

요청 예시

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

Response

응답 본문

순번

변수명

타입

길이

설명

contentType

string

카카오톡 유형

1알림톡

4알림톡 이미지

5알림톡 강조표기

6브랜드 메시지 텍스트

7브랜드 메시지 이미지

8브랜드 메시지 와이드 이미지

templateCode

string

템플릿 코드

알림톡 전송 시 사용한 코드값

plusFriendID

string

검색용 아이디

카카오톡 전송시 사용한 아이디값

targeting

string

전송대상

M전체

I채널 친구

N비채널 친구

브랜드 메시지 전송 시 반환

unsubscribeNo

string

080 수신거부 전화번호

브랜드 메시지 전송 시 반환

sendNum

string

발신번호

altUnsubscribeNo

string

대체문자 080 수신거부 전화번호

대체문자 전송 시 반환

altSubject

string

대체문자 제목

altContent

string

2000

대체문자 내용

altSendType

string

대체문자 유형

null미전송

C카카오톡과 동일 내용 전송

A대체문자 내용 전송

reserveDT

string

예약일시

형식 : yyyyMMddHHmmss

adsYN

boolean

광고메시지 전송 여부

true광고

false일반

sendCnt

string

전송건수

successCnt

string

성공건수

failCnt

string

실패건수

altCnt

string

대체문자 건수

cancelCnt

string

취소건수

btns

array

버튼 목록

최대 : 5개

변수명	타입	길이	설명
n	string	14	버튼명
t	string	2	버튼 유형 WL웹링크 AL앱링크 MD메시지전달 DS배송조회 - 알림톡 전용 BK봇키워드 AC채널추가
u1	string	1000	버튼링크 - {t} = "AL" 경우 iOS 앱링크 적용 - {t} = "WL" 경우 Mobile 웹링크 적용
u2	string	1000	버튼링크 - {t} = "AL" 경우 Android 앱링크 적용 - {t} = "WL" 경우 PC 웹링크 적용
tg	string	3	아웃 링크 out디바이스 기본 브라우저 공백(기본값) : 카카오톡 인앱 브라우저 사용

msgs

array

전송결과 정보

최대 : 1,000건

순번

변수명

타입

길이

설명

state

number

상태코드

[참고] 팝빌 상태코드

sendDT

string

전송일시

형식 : yyyyMMddHHmmss

result

number

카카오 결과코드

{state} = 3 경우 카카오톡 전송결과 확인 가능

[참고] 카카오 결과코드(카카오톡)

resultDT

string

전송결과 수신일시

형식 : yyyyMMddHHmmss

contentType

string

카카오톡 유형

1알림톡

4알림톡 이미지

5알림톡 강조표기

6브랜드 메시지 텍스트

7브랜드 메시지 이미지

8브랜드 메시지 와이드 이미지

receiveNum

string

수신번호

receiveName

string

수신자명

emphasizeTitle

string

강조표기 타이틀

content

string

1300

카카오톡 내용

altSubject

string

대체문자 제목

altContent

string

2000

대체문자 내용

altContentType

number

대체문자 전송타입

4단문

6장문

altSendDT

string

대체문자 전송일시

형식 : yyyyMMddHHmmss

altResult

string

대체문자 통신사 결과코드

[참고] 통신사 결과코드(대체문자)

altResultDT

string

대체문자 전송결과 수신일시

형식 : yyyyMMddHHmmss

receiptNum

string

접수번호

requestNum

string

요청번호

interOPRefKey

string

파트너 지정키

카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

btns

array

버튼 목록

변수명	타입	길이	설명
n	string	14	버튼명
t	string	2	버튼 유형 WL웹링크 AL앱링크 MD메시지전달 DS배송조회 - 알림톡 전용 BK봇키워드 AC채널추가
u1	string	1000	버튼링크 - {t} = "AL" 경우 iOS 앱링크 적용 - {t} = "WL" 경우 Mobile 웹링크 적용
u2	string	1000	버튼링크 - {t} = "AL" 경우 Android 앱링크 적용 - {t} = "WL" 경우 PC 웹링크 적용
tg	string	3	아웃 링크 out디바이스 기본 브라우저 공백(기본값) : 카카오톡 인앱 브라우저 사용

coupon

object

쿠폰 버튼

브랜드 메시지 전송 시 반환

변수명	타입	길이	설명
title	string	15	쿠폰 제목
description	string	18	쿠폰 설명
linkMobile	string	1000	Mobile 웹링크
linkPc	string	1000	PC 웹링크
linkAndroid	string	1000	Android 앱링크
linkIos	string	1000	iOS 앱링크

응답 예시

{
    "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 - 카카오톡 전송내역 확인 (요청번호 할당)

GET https://popbill-test.linkhub.co.kr/KakaoTalk/Get/{requestNum}

GET https://popbill.linkhub.co.kr/KakaoTalk/Get/{requestNum}

파트너가 할당한 요청번호를 통해 알림톡 전송상태 및 결과를 확인합니다.

Request

요청 헤더

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

Path 파라미터

순번	변수명	타입	길이	필수	설명
	requestNum	string	36	Y	파트너가 할당한 요청번호

요청 예시

curl --request POST \
  --url 'https://{domain}/KakaoTalk/Get/{requestNum}' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번

변수명

타입

길이

설명

contentType

string

카카오톡 유형

1알림톡

4알림톡 이미지

5알림톡 강조표기

6브랜드 메시지 텍스트

7브랜드 메시지 이미지

8브랜드 메시지 와이드 이미지

templateCode

string

템플릿 코드

알림톡 전송시 사용한 코드값

plusFriendID

string

검색용 아이디

카카오톡 전송시 사용한 아이디값

targeting

string

전송대상

M전체

I채널 친구

N비채널 친구

브랜드 메시지 전송 시 반환

unsubscribeNo

string

080 수신거부 전화번호

브랜드 메시지 전송 시 반환

sendNum

string

발신번호

altUnsubscribeNo

string

대체문자 080 수신거부 전화번호

대체문자 전송 시 반환

altSubject

string

대체문자 제목

altContent

string

2000

대체문자 내용

altSendType

string

대체문자 유형

null미전송

C카카오톡과 동일 내용 전송

A대체문자 내용 전송

reserveDT

string

예약일시

형식 : yyyyMMddHHmmss

adsYN

boolean

광고메시지 전송 여부

true광고

false일반

sendCnt

string

전송건수

successCnt

string

성공건수

failCnt

string

실패건수

altCnt

string

대체문자 건수

cancelCnt

string

취소건수

btns

array

버튼 목록

최대 : 5개

변수명	타입	길이	설명
n	string	14	버튼명
t	string	2	버튼 유형 WL웹링크 AL앱링크 MD메시지전달 DS배송조회 - 알림톡 전용 BK봇키워드 AC채널추가
u1	string	1000	버튼링크 - {t} = "AL" 경우 iOS 앱링크 적용 - {t} = "WL" 경우 Mobile 웹링크 적용
u2	string	1000	버튼링크 - {t} = "AL" 경우 Android 앱링크 적용 - {t} = "WL" 경우 PC 웹링크 적용
tg	string	3	아웃 링크 out디바이스 기본 브라우저 공백(기본값) : 카카오톡 인앱 브라우저 사용

msgs

array

전송결과 정보

최대 : 1,000건

순번

변수명

타입

길이

설명

state

number

상태코드

[참고] 팝빌 상태코드

sendDT

string

전송일시

형식 : yyyyMMddHHmmss

result

number

카카오 결과코드

{state} = 3 경우 카카오톡 전송결과 확인 가능

[참고] 카카오 결과코드(카카오톡)

resultDT

string

전송결과 수신일시

형식 : yyyyMMddHHmmss

contentType

string

카카오톡 유형

1알림톡

4알림톡 이미지

5알림톡 강조표기

6브랜드 메시지 텍스트

7브랜드 메시지 이미지

8브랜드 메시지 와이드 이미지

receiveNum

string

수신번호

receiveName

string

수신자명

emphasizeTitle

string

강조표기 타이틀

content

string

1300

카카오톡 내용

altSubject

string

대체문자 제목

altContent

string

2000

대체문자 내용

altContentType

number

대체문자 전송타입

4단문

6장문

altSendDT

string

대체문자 전송일시

형식 : yyyyMMddHHmmss

altResult

string

대체문자 통신사 결과코드

[참고] 통신사 결과코드(대체문자)

altResultDT

string

대체문자 전송결과 수신일시

형식 : yyyyMMddHHmmss

receiptNum

string

접수번호

requestNum

string

요청번호

interOPRefKey

string

파트너 지정키

카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

btns

array

버튼 목록

변수명	타입	길이	설명
n	string	14	버튼명
t	string	2	버튼 유형 WL웹링크 AL앱링크 MD메시지전달 DS배송조회 - 알림톡 전용 BK봇키워드 AC채널추가
u1	string	1000	버튼링크 - {t} = "AL" 경우 iOS 앱링크 적용 - {t} = "WL" 경우 Mobile 웹링크 적용
u2	string	1000	버튼링크 - {t} = "AL" 경우 Android 앱링크 적용 - {t} = "WL" 경우 PC 웹링크 적용
tg	string	3	아웃 링크 out디바이스 기본 브라우저 공백(기본값) : 카카오톡 인앱 브라우저 사용

coupon

object

쿠폰 버튼

브랜드 메시지 전송 시 반환

변수명	타입	길이	설명
title	string	15	쿠폰 제목
description	string	18	쿠폰 설명
linkMobile	string	1000	Mobile 웹링크
linkPc	string	1000	PC 웹링크
linkAndroid	string	1000	Android 앱링크
linkIos	string	1000	iOS 앱링크

응답 예시

{
    "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"
            }
        }
    ]
}

3. Search - 전송내역 목록 조회

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

GET https://popbill.linkhub.co.kr/KakaoTalk/Search

검색조건에 해당하는 카카오톡 전송내역을 조회합니다. (조회기간 단위 : 최대 2개월)

카카오톡 접수일시로부터 6개월 이내 접수건만 조회할 수 있습니다.

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

Request

요청 헤더

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

Query 파라미터

변수명	타입	길이	필수	설명
SDate	string	8	Y	검색 시작일자 형식 : yyyyMMdd
EDate	string	8	Y	검색 종료일자 형식 : yyyyMMdd
State	string	-	Y	전송상태 (다중 선택 가능) 0전송대기 1전송중 2전송성공 3대체문자 전송성공 4전송실패 5예약취소 다중 선택시 콤마(',')로 구분. 예) 0,1
Item	string	-	N	검색대상(다중 선택 가능) ATS알림톡 BMS브랜드 메시지 다중 선택 시 콤마(',')로 구분. 예) ATS,BMS 기본값 : 전체조회
ReserveYN	string	1	N	전송유형별 조회 (택 1) 0즉시전송건 1예약전송건 기본값 : 전체조회
SenderYN	boolean	-	N	사용자권한별 조회 true팝빌회원 아이디(UserID)로 전송한 카카오톡만 조회 false전송한 카카오톡 전체 조회 : 기본값
Order	string	1	N	카카오톡 접수일시를 기준으로 하는 목록 정렬 방향 D내림차순 : 기본값 A오름차순
Page	number	-	N	목록 페이지번호 기본값 : 1
PerPage	number	-	N	페이지당 표시할 목록 건수 최대 : 1,000건 기본값 : 500건
QString	string	70	N	조회 검색어(수신자명, 수신번호) 기본값 : 전체조회
PlusFriendID	string	30	N	검색용 아이디
ContentType	string	-	N	카카오톡 유형 (다중 선택 가능) 1알림톡 4알림톡 이미지 5알림톡 강조표기 6브랜드 메시지 텍스트 7브랜드 메시지 이미지 8브랜드 메시지 와이드 이미지 다중 선택 시 콤마(',')로 구분. 예) 1,4

요청 예시

curl --request GET \
  --url 'https://{domain}/KakaoTalk/Search?SDate={Sdate}&EDate={EDate}&State={State}' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번

변수명

타입

길이

설명

code

number

API 처리에 대한 응답코드

1성공

message

string

API 처리에 대한 응답메시지

total

number

총 검색결과 건수

perPage

number

페이지 당 목록 건수

pageNum

number

페이지 번호

pageCount

number

페이지 개수

list

array

전송결과 정보

최대 : 1,000건

순번

변수명

타입

길이

설명

state

number

상태코드

[참고] 팝빌 상태코드

sendDT

string

전송일시

형식 : yyyyMMddHHmmss

result

number

카카오 결과코드

{state} = 3 경우 카카오톡 전송결과 확인 가능

[참고] 카카오 결과코드(카카오톡)

resultDT

string

전송결과 수신일시

형식 : yyyyMMddHHmmss

contentType

string

카카오톡 유형

1알림톡

4알림톡 이미지

5알림톡 강조표기

6브랜드 메시지 텍스트

7브랜드 메시지 이미지

8브랜드 메시지 와이드 이미지

receiveNum

string

수신번호

receiveName

string

수신자명

emphasizeTitle

string

강조표기 타이틀

content

string

1300

카카오톡 내용

altSubject

string

대체문자 제목

altContent

string

2000

대체문자 내용

altContentType

number

대체문자 전송타입

4단문

6장문

altSendDT

string

대체문자 전송일시

형식 : yyyyMMddHHmmss

altResult

string

대체문자 통신사 결과코드

[참고] 통신사 결과코드(대체문자)

altResultDT

string

대체문자 전송결과 수신일시

형식 : yyyyMMddHHmmss

receiptNum

string

접수번호

requestNum

string

요청번호

interOPRefKey

string

파트너 지정키

카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

btns

array

버튼 목록

변수명	타입	길이	설명
n	string	14	버튼명
t	string	2	버튼 유형 WL웹링크 AL앱링크 MD메시지전달 DS배송조회 - 알림톡 전용 BK봇키워드 AC채널추가
u1	string	1000	버튼링크 - {t} = "AL" 경우 iOS 앱링크 적용 - {t} = "WL" 경우 Mobile 웹링크 적용
u2	string	1000	버튼링크 - {t} = "AL" 경우 Android 앱링크 적용 - {t} = "WL" 경우 PC 웹링크 적용
tg	string	3	아웃 링크 out디바이스 기본 브라우저 공백(기본값) : 카카오톡 인앱 브라우저 사용

coupon

object

쿠폰 버튼

브랜드 메시지 전송 시 반환

변수명	타입	길이	설명
title	string	15	쿠폰 제목
description	string	18	쿠폰 설명
linkMobile	string	1000	Mobile 웹링크
linkPc	string	1000	PC 웹링크
linkAndroid	string	1000	Android 앱링크
linkIos	string	1000	iOS 앱링크

응답 예시

{
    "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

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

GET https://popbill.linkhub.co.kr/KakaoTalk

Request

요청 헤더

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

Query 파라미터

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

요청 예시

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

Response

응답 본문

순번	변수명	타입	길이	설명
	url	string	-	카카오톡 전송내역 팝업 URL

응답 예시

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