POPBill Developers
API Reference
  • 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

    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 1000 버튼링크
    - {t} = "AL" 경우 iOS 앱링크 적용
    - {t} = "WL" 경우 Mobile 웹링크 적용
    u2 String 1000 버튼링크
    - {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 파트너 지정키
    카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값