A. 객체정보
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리에 대한 응답코드
1성공
|
|
| message | str | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
|
|
| message | str | - | API 처리 실패에 대한 오류메시지 |
SenderNumber
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| number | str | 20 | 발신번호 | |
| representYN | bool | - |
대표번호 지정여부
True대표번호
False일반번호
|
|
| state | int | 1 |
등록상태
0대기
1승인
2취소
|
|
| memo | str | 200 | 메모 |
PlusFriendID
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| plusFriendID | str | 30 | 검색용 아이디 | |
| plusFriendName | str | 100 | 채널명 | |
| regDT | str | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
| state | str | 1 |
등록상태
|
|
| stateDT | str | 14 |
채널 상태 일시
형식 : yyyyMMddHHmmss
|
ATSTemplate
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| templateCode | str | 12 | 템플릿 코드 | |
| templateName | str | 20 | 템플릿 제목 | |
| template | str | 1000 | 템플릿 내용 | |
| plusFriendID | str | 30 | 검색용 아이디 | |
| ads | str | 80 | 광고 메시지 | |
| appendix | str | 500 | 부가 메시지 | |
| btns | KakaoButton[] |
버튼 목록
최대 : 5개
|
||
| secureYN | bool |
보안템플릿 여부
True보안템플릿
False일반템플릿
|
||
| state | str | 1 |
템플릿 상태
|
|
| stateDT | str | 14 |
템플릿 상태 일시
형식 : yyyyMMddHHmmss
|
|
KakaoType
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| ATS | enum | - | 알림톡 | |
| FTS | enum | - | 친구톡(텍스트) | |
| FMS | enum | - | 친구톡(이미지) |
KakaoReceiver
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| receiverNum | str | 20 | Y | 수신번호 | |
| receiverName | str | 70 | N | 수신자명 | |
| message | str | - | 조건부 |
알림톡/친구톡 내용
대량전송 경우 필수
알림톡/친구톡(텍스트) : 최대 1,000자 친구톡(이미지) : 최대 400자 |
|
| altSubject | str | 40 | N |
대체문자 제목
대량전송 경우 사용
메시지 길이가 90byte 이상인 경우에만 적용 |
|
| altMessage | str | 2000 | N |
대체문자 내용
대량전송 경우 사용
|
|
| btns | KakaoButton[] | N |
버튼 목록
대량전송 경우 사용
최대 : 5개 |
||
| interOPRefKey | str | 20 | N |
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
|
KakaoSearchResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리에 대한 응답코드
1성공
|
|
| message | str | - | API 처리에 대한 응답메시지 | |
| total | str | - | 총 검색결과 건수 | |
| perPage | str | - | 페이지 당 목록 건수 | |
| pageNum | str | - | 페이지 번호 | |
| pageCount | str | - | 페이지 개수 | |
| list | KakaoSentDetail[] |
전송결과 정보
최대 : 1,000건
|
||
KakaoSentInfo
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| contentType | int | 1 |
카카오톡 유형
|
|
| templateCode | str | 12 |
템플릿 코드
알림톡 전송시 사용한 코드값
|
|
| plusFriendID | str | 30 |
검색용 아이디
알림톡/친구톡 전송시 사용한 아이디값
|
|
| sendNum | str | 20 | 발신번호 | |
| altSubject | str | 40 | 대체문자 제목 | |
| altContent | str | 2000 | 대체문자 내용 | |
| altSendType | str | 1 |
대체문자 유형
None미전송
C카카오톡과 동일 내용 전송
A대체문자 내용 전송
|
|
| reserveDT | str | 14 |
예약일시
형식 : yyyyMMddHHmmss
|
|
| adsYN | bool | - |
광고메시지 전송여부
True광고
False일반
|
|
| imageURL | str | - | 친구톡 이미지 URL | |
| sendCnt | str | - | 전송건수 | |
| successCnt | str | - | 성공건수 | |
| failCnt | str | - | 실패건수 | |
| altCnt | str | - | 대체문자 건수 | |
| cancelCnt | str | - | 취소건수 | |
| btns | KakaoButton[] |
버튼 목록
최대 : 5개
|
||
| msgs | KakaoSentDetail[] |
전송결과 정보
최대 : 1,000건
|
||
KakaoButton
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| n | str | 14 | 버튼명 | |
| t | str | 2 |
버튼 유형
|
|
| u1 | str | 256 |
버튼링크
- {t} = "AL" 경우 iOS 앱링크 적용 - {t} = "WL" 경우 Mobile 웹링크 적용 |
|
| u2 | str | 256 |
버튼링크
- {t} = "AL" 경우 Android 앱링크 적용 - {t} = "WL" 경우 PC 웹링크 적용 |
KakaoSentDetail
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| state | int | 1 | 팝빌 상태코드 | |
| sendDT | str | 14 |
전송일시
형식 : yyyyMMddHHmmss
|
|
| result | int | 3 |
통신사 결과코드
{state} = 3 경우 카카오톡 전송결과 확인 가능
|
|
| resultDT | str | 14 |
전송결과 수신일시
형식 : yyyyMMddHHmmss
|
|
| contentType | int | 1 |
카카오톡 유형
|
|
| receiveNum | str | 20 | 수신번호 | |
| receiveName | str | 70 | 수신자명 | |
| content | str | 1000 | 알림톡/친구톡 내용 | |
| altSubject | str | 40 | 대체문자 제목 | |
| altContent | str | 2000 | 대체문자 내용 | |
| altContentType | int | 1 |
대체문자 전송타입
4단문
6장문
|
|
| altSendDT | str | 14 |
대체문자 전송일시
형식 : yyyyMMddHHmmss
|
|
| altResult | int | 3 | 대체문자 통신사 결과코드 | |
| altResultDT | str | 14 |
대체문자 전송결과 수신일시
형식 : yyyyMMddHHmmss
|
|
| receiptNum | str | 18 | 접수번호 | |
| requestNum | str | 36 | 요청번호 | |
| interOPRefKey | str | 20 |
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
UseHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리에 대한 응답코드
1성공
|
|
| total | int | - | 총 검색결과 건수 | |
| perPage | int | - | 페이지당 목록 건수 | |
| pageNum | int | - | 페이지 번호 | |
| pageCount | int | - | 페이지 개수 | |
| list | UseHistory[] | 사용내역 | ||
UseHistory
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| itemCode | str | 3 |
서비스 코드
|
|
| txType | str | 2 |
포인트 증감 유형
포인트 증가
포인트 감소
|
|
| txPoint | str | 18 | 증감 포인트 | |
| balance | str | 18 | 잔여포인트 | |
| txDT | str | 14 |
포인트 증감 일시
형식 : yyyyMMddHHmmss
|
|
| userID | str | 50 | 담당자 아이디 | |
| userName | str | 100 | 담당자명 |
PaymentHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리에 대한 응답코드
1성공
|
|
| total | int | - | 총 검색결과 건수 | |
| perPage | int | - | 페이지당 목록 건수 | |
| pageNum | int | - | 페이지 번호 | |
| pageCount | int | - | 페이지 개수 | |
| list | PaymentHistory[] | 결제내역 | ||
PaymentHistory
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| productType | str | 3 |
결제 내용
포인트
정액제
미수금
|
|
| productName | str | 30 | 결제 상품명 | |
| settleType | str | 7 |
결제유형
무통장
신용카드
실시간계좌이체
|
|
| settlerName | str | 100 | 담당자명 | |
| settlerEmail | str | 100 | 담당자메일 | |
| settleCost | str | 18 | 결제금액 | |
| settlePoint | str | 18 | 충전포인트 | |
| settleState | int | 1 |
결제상태
|
|
| regDT | str | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
| stateDT | str | 14 |
상태일시
형식 : yyyyMMddHHmmss
|
RefundHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리에 대한 응답코드
1성공
|
|
| total | int | - | 총 검색결과 건수 | |
| perPage | int | - | 페이지당 목록 건수 | |
| pageNum | int | - | 페이지 번호 | |
| pageCount | int | - | 페이지 개수 | |
| list | RefundHistory[] | 환불내역 | ||
RefundHistory
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| reqDT | str | 14 |
신청일시
형식 : yyyyMMddHHmmss
|
|
| requestPoint | str | 18 | 환불 신청포인트 | |
| accountBank | str | 10 | 환불계좌 은행명 | |
| accountNum | str | 50 | 환불계좌번호 | |
| accountName | str | 70 | 환불계좌 예금주명 | |
| state | int | 1 |
상태
|
|
| reason | str | 200 | 환불사유 |
RefundForm
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| ContactName | str | 100 | Y | 담당자명 | |
| tel | str | 20 | Y | 담당자 연락처 | |
| RequestPoint | str | 18 | Y | 환불 신청 포인트 | |
| AccountBank | str | 10 | Y | 은행명 | |
| AccountNum | str | 50 | Y | 계좌번호 | |
| AccountName | str | 70 | Y | 예금주명 | |
| Reason | str | 200 | N | 환불사유 |
PaymentForm
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| settlerName | str | 100 | N | 담당자명 | |
| settlerEmail | str | 100 | N | 담당자 이메일 | |
| notifyHP | str | 20 | N |
담당자 휴대폰
무통장 입금 승인 알림톡이 전송될 번호
|
|
| paymentName | str | 70 | Y | 입금자명 | |
| settleCost | str | 18 | Y | 결제금액 |
PaymentResponse
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - | 응답코드 | |
| message | str | - | 응답메시지 | |
| settleCode | str | 18 | 정산코드 |
ChargeInfo
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| unitCost | str | 12 | 전송단가 | |
| chargeMethod | str | 3 |
과금유형
연동
파트너
|
|
| rateSystem | str | 3 |
과금제도
종량제
|
JoinForm
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| ID | str | 50 | Y |
아이디
6자 이상 50자 이하
|
|
| Password | str | 20 | Y |
비밀번호
8자 이상 20자 이하
영문, 숫자, 특수문자(~!@#$%^&*()_+) 조합 |
|
| LinkID | str | 20 | Y |
파트너 링크아이디
팝빌에서 발급한 링크아이디
|
|
| CorpNum | str | 10 | Y | 사업자번호 ('-' 제외) | |
| CEOName | str | 100 | Y | 대표자 성명 | |
| CorpName | str | 200 | Y | 회사명 | |
| Addr | str | 300 | Y | 사업장 주소 | |
| BizType | str | 100 | Y | 업태 | |
| BizClass | str | 100 | Y | 종목 | |
| ContactName | str | 100 | Y | 담당자 성명 | |
| ContactEmail | str | 100 | Y | 담당자 이메일 | |
| ContactTEL | str | 20 | Y | 담당자 휴대폰 |
CorpInfo
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| ceoname | str | 100 | Y | 대표자 성명 | |
| corpName | str | 200 | Y | 회사명 | |
| addr | str | 300 | Y | 주소 | |
| bizType | str | 100 | Y | 업태 | |
| bizClass | str | 100 | Y | 종목 |
ContactInfo - 입력부
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| id | str | 50 | Y |
아이디
6자 이상 50자 이하
|
|
| password | str | 20 | 조건부 | 비밀번호 | |
| personName | str | 100 | Y | 담당자 성명 | |
| tel | str | 20 | Y | 담당자 휴대폰 | |
| str | 100 | Y | 담당자 이메일 | ||
| searchRole | int | 1 | N |
담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값
|
ContactInfo - 출력부
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| id | str | 50 | 아이디 | |
| personName | str | 100 | 담당자 성명 | |
| tel | str | 20 | 담당자 휴대폰 | |
| str | 100 | 담당자 이메일 | ||
| regDT | str | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
| searchRole | int | 1 |
담당자 권한
1개인권한
2읽기권한
3회사권한
|
|
| mgrYN | bool | - |
관리자 여부
True관리자
False담당자
팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
|
|
| state | int | 1 |
계정상태
1사용중
|
RefundResponse
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | int | - |
API 처리에 대한 응답코드
1성공
|
|
| message | str | - | API 처리에 대한 응답메시지 | |
| refundCode | str | 18 | 환불코드 |