POPBill Developers
가이드

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

API Reference

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

SDK

다수 개발자에게 검증받은
SDK Example을 제공합니다.

추가 개발언어는 신청주시면
검토 후 지원합니다.
Webhook(웹훅)

팝빌에서 발생한 이벤트 정보를
고객사 서버로 즉시 전송합니다.

API Reference
카카오톡
Java
  • API Reference 카카오톡 Java 객체정보

    A. 객체정보

    Response

    순번변수명타입길이설명
    code long - API 처리에 대한 응답코드
    1성공
    message String - API 처리에 대한 응답메시지

    PopbillException

    순번변수명타입길이설명
    code long - API 처리 실패에 대한 오류코드
    음의 정수 8자리 숫자값 [참고] 오류코드
    message String - API 처리 실패에 대한 오류메시지

    SenderNumber

    순번변수명타입길이설명
    number String 20 발신번호
    representYN Boolean - 대표번호 지정여부
    true대표번호
    false일반번호
    state Integer 1 등록상태
    0대기
    1승인
    2취소
    memo String 200 메모

    PlusFriendID

    순번변수명타입길이설명
    plusFriendID String 30 검색용 아이디
    plusFriendName String 100 채널명
    regDT String 14 등록일시
    형식 : yyyyMMddHHmmss
    state String 1 등록상태
    • 0사용
    • 1휴면
    • 2차단
    • 3삭제
    stateDT String 14 채널 상태 일시
    형식 : yyyyMMddHHmmss

    ATSTemplate

    순번변수명타입길이설명
    templateCode String 12 템플릿 코드
    templateName String 20 템플릿 제목
    template String 1000 템플릿 내용
    plusFriendID String 30 검색용 아이디
    ads String 80 광고 메시지
    appendix String 500 부가 메시지
    btns List<KakaoButton> 버튼 목록
    최대 : 5개
    secureYN Boolean 보안템플릿 여부
    true보안템플릿
    false일반템플릿
    state String 1 템플릿 상태
    • 0임시저장
    • 1내부저장
    • 2심사중
    • 3승인
    • 4반려
    • 5정지
    • 6사용자 삭제
    • 7휴면
    • 8삭제
    stateDT String 14 템플릿 상태 일시
    형식 : yyyyMMddHHmmss

    KakaoType

    순번변수명타입길이설명
    ATS enum - 알림톡
    FTS enum - 친구톡(텍스트)
    FMS enum - 친구톡(이미지)

    KakaoReceiver

    순번변수명타입길이필수설명
    receiverNum String 20 Y 수신번호
    receiverName String 70 N 수신자명
    message String - 조건부 알림톡/친구톡 내용 (템플릿 내용의 변수 치환 필요)
    대량전송 경우 필수
    알림톡/친구톡(텍스트) : 최대 1,000자
    친구톡(이미지) : 최대 400자
    - 템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다.
    - 작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다.
    altSubject String 40 N 대체문자 제목
    대량전송 경우 사용
    메시지 길이가 90byte 이상인 경우에만 적용
    altMessage String 2000 N 대체문자 내용
    대량전송 경우 사용
    btns List<KakaoButton> N 버튼 목록
    대량전송 경우 사용
    최대 : 5개
    interOPRefKey String 20 N 파트너 지정키
    카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

    KakaoSearchResult

    순번변수명타입길이설명
    code long - API 처리에 대한 응답코드
    1성공
    message String - API 처리에 대한 응답메시지
    total String - 총 검색결과 건수
    perPage String - 페이지 당 목록 건수
    pageNum String - 페이지 번호
    pageCount String - 페이지 개수
    list List<KakaoSentDetail> 전송결과 정보
    최대 : 1,000건

    KakaoSentInfo

    순번변수명타입길이설명
    contentType Integer 1 카카오톡 유형
    • 1알림톡
    • 2친구톡 텍스트
    • 3친구톡 이미지
    • 4알림톡 이미지
    templateCode String 12 템플릿 코드
    알림톡 전송시 사용한 코드값
    plusFriendID String 30 검색용 아이디
    알림톡/친구톡 전송시 사용한 아이디값
    sendNum String 20 발신번호
    altSubject String 40 대체문자 제목
    altContent String 2000 대체문자 내용
    altSendType String 1 대체문자 유형
    null미전송
    C카카오톡과 동일 내용 전송
    A대체문자 내용 전송
    reserveDT String 14 예약일시
    형식 : yyyyMMddHHmmss
    adsYN Boolean - 광고메시지 전송여부
    true광고
    false일반
    imageURL String - 친구톡 이미지 URL
    sendCnt String - 전송건수
    successCnt String - 성공건수
    failCnt String - 실패건수
    altCnt String - 대체문자 건수
    cancelCnt String - 취소건수
    btns List<KakaoButton> 버튼 목록
    최대 : 5개
    msgs List<KakaoSentDetail> 전송결과 정보
    최대 : 1,000건

    KakaoButton

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

    KakaoSentDetail

    순번변수명타입길이설명
    state Integer 1 상태코드
    [참고] 팝빌 상태코드
    sendDT String 14 전송일시
    형식 : yyyyMMddHHmmss
    result Integer 3 카카오 결과코드
    {state} = 3 경우 카카오톡 전송결과 확인 가능
    [참고] 카카오 결과코드(카카오톡)
    resultDT String 14 전송결과 수신일시
    형식 : yyyyMMddHHmmss
    contentType Integer 1 카카오톡 유형
    • 1알림톡
    • 2친구톡 텍스트
    • 3친구톡 이미지
    • 4알림톡 이미지
    receiveNum String 20 수신번호
    receiveName String 70 수신자명
    content String 1000 알림톡/친구톡 내용
    altSubject String 40 대체문자 제목
    altContent String 2000 대체문자 내용
    altContentType Integer 1 대체문자 전송타입
    4단문
    6장문
    altSendDT String 14 대체문자 전송일시
    형식 : yyyyMMddHHmmss
    altResult Integer 3 통신사 결과코드
    [참고] 통신사 결과코드(대체문자)
    altResultDT String 14 대체문자 전송결과 수신일시
    형식 : yyyyMMddHHmmss
    receiptNum String 18 접수번호
    requestNum String 36 요청번호
    interOPRefKey String 20 파트너 지정키
    카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

    UseHistoryResult

    순번변수명타입길이설명
    code Long - API 처리에 대한 응답코드
    1성공
    total Long - 총 검색결과 건수
    perPage Long - 페이지당 목록 건수
    pageNum Long - 페이지 번호
    pageCount Long - 페이지 개수
    list List<UseHistory> 사용내역

    UseHistory

    순번변수명타입길이설명
    itemCode String 3 서비스 코드
    • 110세금계산서
    • 111홈택스수집(세금)
    • 121거래명세서
    • 122청구서
    • 123견적서
    • 124발주서
    • 125입금표
    • 126영수증
    • 140현금영수증
    • 141홈택스수집(현금)
    • 150문자(SMS)
    • 151문자(LMS)
    • 152문자(MMS)
    • 153알림톡
    • 154친구톡(텍스트)
    • 155친구톡(이미지)
    • 160팩스(일반망)
    • 161팩스(지능망)
    • 170사업자등록상태조회
    • 171기업정보조회
    • 180계좌조회
    • 182성명조회
    • 183실명조회
    txType String 2 포인트 증감 유형
    포인트 증가
    • 11포인트 충전
    • 12조정
    • 13조정
    • 19분배
    • 31환불
    • 32정액제 해지
    포인트 감소
    • 21서비스 사용
    • 22조정
    • 23조정
    • 24포인트 결제
    • 25미수금 결제
    • 26포인트 환불
    • 29회수
    • 41후불누적조정
    txPoint String 18 증감 포인트
    balance String 18 잔여포인트
    txDT String 14 포인트 증감 일시
    형식 : yyyyMMddHHmmss
    userID String 50 담당자 아이디
    userName String 100 담당자명

    PaymentHistoryResult

    순번변수명타입길이설명
    code Long - API 처리에 대한 응답코드
    1성공
    total Long - 총 검색결과 건수
    perPage Long - 페이지당 목록 건수
    pageNum Long - 페이지 번호
    pageCount Long - 페이지 개수
    list List<PaymentHistory> 결제내역

    PaymentHistory

    순번변수명타입길이설명
    productType String 3 결제 내용
    포인트
    정액제
    미수금
    productName String 30 결제 상품명
    settleType String 7 결제유형
    무통장
    신용카드
    실시간계좌이체
    settlerName String 100 담당자명
    settlerEmail String 100 담당자메일
    settleCost String 18 결제금액
    settlePoint String 18 충전포인트
    settleState int 1 결제상태
    • 1대기
    • 2승인
    • 3실패
    • 45취소
    regDT String 14 등록일시
    형식 : yyyyMMddHHmmss
    stateDT String 14 상태일시
    형식 : yyyyMMddHHmmss

    RefundHistoryResult

    순번변수명타입길이설명
    code Long - API 처리에 대한 응답코드
    1성공
    total Long - 총 검색결과 건수
    perPage Long - 페이지당 목록 건수
    pageNum Long - 페이지 번호
    pageCount Long - 페이지 개수
    list List<RefundHistory> 환불내역

    RefundHistory

    순번변수명타입길이설명
    reqDT String 14 신청일시
    형식 : yyyyMMddHHmmss
    requestPoint String 18 환불 신청포인트
    accountBank String 10 환불계좌 은행명
    accountNum String 50 환불계좌번호
    accountName String 70 환불계좌 예금주명
    state int 1 상태
    • 1 접수대기
    • 2 심사중
    • 3 입금대기
    • 4 환불완료
    • 5 취소
    reason String 200 환불사유

    RefundForm

    순번변수명타입길이필수설명
    contactName String 100 Y 담당자명
    tel String 20 Y 담당자 연락처
    requestPoint String 18 Y 환불 신청 포인트
    accountBank String 10 Y 은행명
    accountNum String 50 Y 계좌번호
    accountName String 70 Y 예금주명
    reason String 200 N 환불사유

    PaymentForm

    순번변수명타입길이필수설명
    settlerName String 100 N 담당자명
    settlerEmail String 100 N 담당자 이메일
    notifyHP String 20 N 담당자 휴대폰
    무통장 입금 승인 알림톡이 전송될 번호
    paymentName String 70 Y 입금자명
    settleCost String 18 Y 결제금액

    PaymentResponse

    순번변수명타입길이설명
    code Long - 응답코드
    message String - 응답메시지
    settleCode String 18 정산코드

    ChargeInfo

    순번변수명타입길이설명
    unitCost String 12 전송단가
    chargeMethod String 3 과금유형
    연동
    파트너
    rateSystem String 3 과금제도
    종량제

    JoinForm

    순번변수명타입길이필수설명
    ID String 50 Y 아이디
    6자 이상 50자 이하
    Password String 20 Y 비밀번호
    8자 이상 20자 이하
    영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함
    LinkID String 20 Y 파트너 링크아이디
    팝빌에서 발급한 링크아이디
    CorpNum String 10 Y 사업자번호 ('-' 제외)
    CEOName String 100 Y 대표자 성명
    CorpName String 200 Y 회사명
    Addr String 300 Y 사업장 주소
    BizType String 100 Y 업태
    BizClass String 100 Y 종목
    ContactName String 100 Y 담당자 성명
    ContactEmail String 100 Y 담당자 이메일
    ContactTEL String 20 Y 담당자 휴대폰

    CorpInfo

    순번변수명타입길이필수설명
    ceoname String 100 Y 대표자 성명
    corpName String 200 Y 회사명
    addr String 300 Y 주소
    bizType String 100 Y 업태
    bizClass String 100 Y 종목

    ContactInfo - 입력부

    순번변수명타입길이필수설명
    id String 50 Y 아이디
    6자 이상 50자 이하
    password String 20 조건부 비밀번호
    8자 이상 20자 이하
    영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함
    함수 [RegistContact - 담당자 추가]호출을 위한 필수값
    personName String 100 Y 담당자 성명
    tel String 20 Y 담당자 휴대폰
    email String 100 Y 담당자 이메일
    searchRole Integer 1 N 권한
    1개인권한
    2읽기권한
    3회사권한 : 기본값

    ContactInfo - 출력부

    순번변수명타입길이설명
    id String 50 아이디
    personName String 100 담당자 성명
    tel String 20 담당자 휴대폰
    email String 100 담당자 이메일
    regDT String 14 등록일시
    형식 : yyyyMMddHHmmss
    searchRole Integer 1 권한
    1개인권한
    2읽기권한
    3회사권한
    mgrYN Boolean - 역할
    true관리자
    false담당자
    팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
    state Integer 1 계정상태
    1사용중

    RefundResponse

    순번변수명타입길이설명
    code Integer - API 처리에 대한 응답코드
    1성공
    message String - API 처리에 대한 응답메시지
    refundCode String 18 환불코드