A. 객체정보
Response
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | long | - | API 처리에 대한 응답코드 | |
message | String | - | API 처리에 대한 응답메시지 |
PopbillException
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | long | - |
API 처리 실패에 대한 오류코드("-"로 시작하는 8자리 숫자값)
└ [참고] 오류코드 |
|
message | String | - | API 처리 실패에 대한 오류메시지 |
SenderNumber
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
number | String | 20 | 발신번호 | |
representYN | Boolean | - |
대표번호 지정여부 : true / false 중 반환
└ true : 대표번호 └ false : 일반번호 |
|
state | Integer | 1 |
등록상태 : 0 / 1 / 2 중 반환
└ 0 : 대기 └ 1 : 승인 └ 2 : 취소 |
|
memo | String | 200 | 메모 |
PlusFriendID
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
plusFriendID | String | 30 | 검색용 아이디 | |
plusFriendName | String | 100 | 채널명 | |
regDT | String | 14 | 등록일시 (형식 : yyyyMMddHHmmss) | |
state | String | 1 |
채널 상태 : "0" / "1" / "2" / "3" 중 반환
└ 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 중 반환
└ true : 보안템플릿 └ false : 일반템플릿 |
||
state | String | 1 |
템플릿 상태
|
|
stateDT | String | 14 |
템플릿 상태 일시
└ 팝빌에 카카오톡 템플릿 상태를 확인할 일시 (형식 : yyyyMMddHHmmss) |
KakaoType
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
ATS | enum | - | 알림톡 | |
FTS | enum | - | 친구톡(텍스트) | |
FMS | enum | - | 친구톡(이미지) |
KakaoReceiver
순번 | 변수명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|
receiverNum | String | 20 | △ |
수신번호
└ 대량/동보전송시 필수 |
|
receiverName | String | 70 | - | 수신자명 | |
message | String | 1000 400 |
△ |
알림톡/친구톡 내용
└ 대량/동보전송시 필수 └ 알림톡/친구톡(텍스트) : 최대 1,000자 └ 친구톡(이미지) : 최대 400자 |
|
altSubject | String | 40 | - |
대체문자 제목
※ 메시지 길이가 90byte 이상인 경우에만 적용 |
|
altMessage | String | 2000 | - | 대체문자 내용 | |
btns | List<KakaoButton> | - | 버튼 목록 (최대 5개) | ||
interOPRefKey | String | 20 | - |
메시지 식별번호
└ 1건의 접수에 포함된 개별 메시지를 식별하기 위한 관리번호 |
KakaoSearchResult
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | long | - | API 처리에 대한 응답코드 | |
message | String | - | API 처리에 대한 응답메시지 | |
total | String | - | 총 검색결과 건수 | |
perPage | String | - | 페이지 당 목록 개수 | |
pageNum | String | - | 페이지 번호 | |
pageCount | String | - | 페이지 개수 | |
list | List<KakaoSentDetail> | 전송결과 정보 (최대 1,000개) |
KakaoSentInfo
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
contentType | Integer | 1 |
카카오톡 유형
└ 1 : (알림톡) / 2 : (친구톡 텍스트) / 3 : (친구톡 이미지) 중 반환 |
|
templateCode | String | 12 |
템플릿 코드
└ 알림톡 전송시 사용한 코드값 |
|
plusFriendID | String | 30 |
검색용 아이디
└ 알림톡/친구톡 전송시 사용한 아이디값 |
|
sendNum | String | 20 | 발신번호 | |
altSubject | String | 40 | [동보] 대체문자 제목 | |
altContent | String | 2000 | [동보] 대체문자 내용 | |
altSendType | String | 1 |
대체문자 유형 : null / "C" / "A" 중 반환
└ null = 미전송, C = 알림톡 또는 친구톡 내용으로 전송, A = 대체문자 내용으로 전송 ※ 대체문자의 경우, 포토문자(MMS) 형식은 지원하고 있지 않습니다. |
|
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 | 버튼유형 | |
u1 | String | 256 |
버튼링크
└ {t} = "AL"일 경우 iOS 앱링크 적용 └ {t} = "WL"일 경우 Mobile 웹링크 적용 |
|
u2 | String | 256 |
버튼링크
└ {t} = "AL"일 경우 Android 앱링크 적용 └ {t} = "WL"일 경우 PC 웹링크 적용 |
KakaoSentDetail
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
state | Integer | 1 |
알림톡/친구톡 전송 작업 상태를 확인하는 값
└ [참고] 전송 상태 및 결과 코드 |
|
sendDT | String | 14 | 전송일시 (형식 : yyyyMMddHHmmss) | |
result | Integer | 3 |
{state} = 3 인 경우, 전송 성공여부를 확인하는 값
└ [참고] 전송 상태 및 결과 코드 |
|
resultDT | String | 14 | 전송결과 수신일시 (형식 : yyyyMMddHHmmss) | |
contentType | Integer | 1 |
카카오톡 유형
└ 1 : (알림톡) / 2 : (친구톡 텍스트) / 3 : (친구톡 이미지) 중 반환 |
|
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 처리에 대한 응답코드 | |
total | Long | - | 총 검색결과 건수 | |
perPage | Long | - | 페이지당 검색개수 | |
pageNum | Long | - | 페이지 번호 | |
pageCount | Long | - | 페이지 개수 | |
list | List<UseHistory> | 사용내역 |
UseHistory
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
itemCode | String | 3 | 서비스 코드
|
|
txType | String | 2 | 포인트 증감 유형
포인트 증가
포인트 감소
|
|
txPoint | String | 18 | 증감 포인트 | |
balance | String | 18 | 잔여포인트 | |
txDT | String | 14 | 포인트 증감 일시 (형식 : yyyyMMddHHmmss) | |
userID | String | 50 | 담당자 아이디 | |
userName | String | 100 | 담당자명 |
PaymentHistoryResult
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | Long | - | API 처리에 대한 응답코드 | |
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 / 4 / 5 중 반환
└ 1 : 대기 └ 2 : 승인 └ 3 : 실패 └ 4,5 : 취소 |
|
regDT | String | 14 | 등록일시 (형식 : yyyyMMddHHmmss) | |
stateDT | String | 14 | 상태일시 (형식 : yyyyMMddHHmmss) |
RefundHistoryResult
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | Long | - | API 처리에 대한 응답코드 | |
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 | O | 담당자명 | |
tel | String | 20 | O | 담당자 연락처 | |
requestPoint | String | 18 | O | 환불 신청 포인트 | |
accountBank | String | 10 | O | 은행명 | |
accountNum | String | 50 | O | 계좌번호 | |
accountName | String | 70 | O | 예금주명 | |
reason | String | 200 | - | 환불사유 |
PaymentForm
순번 | 변수명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|
settlerName | String | 100 | - | 담당자명 | |
settlerEmail | String | 100 | - | 담당자 이메일 | |
notifyHP | String | 20 | - |
담당자 휴대폰
└ 무통장 입금 승인 알림톡이 전송될 번호 |
|
paymentName | String | 70 | O | 입금자명 | |
settleCost | String | 18 | O | 결제금액 |
PaymentResponse
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | Long | - | 응답코드 | |
message | String | - | 응답메시지 | |
settleCode | String | 18 | 정산코드 |
ChargeInfo
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
unitCost | String | 12 | 전송단가 | |
chargeMethod | String | 3 | 과금유형 : "연동" / "파트너" 중 반환 | |
rateSystem | String | 3 | 과금제도 : "종량제" 반환 |
JoinForm
순번 | 변수명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|
ID | String | 50 | O |
아이디
└ 6자 이상 50자 이하 |
|
Password | String | 20 | O |
비밀번호
└ 8자 이상 20자 이하 └ 영문, 숫자, 특수문자 조합 |
|
LinkID | String | 20 | O |
파트너 링크아이디
└ 연동신청시 팝빌에서 발급받은 링크아이디 |
|
CorpNum | String | 10 | O |
사업자번호
└ 하이픈 '-' 제외 10자리 숫자값 |
|
CEOName | String | 100 | O | 대표자 성명 | |
CorpName | String | 200 | O | 회사명 | |
Addr | String | 300 | O | 사업장 주소 | |
BizType | String | 100 | O | 업태 | |
BizClass | String | 100 | O | 종목 | |
ContactName | String | 100 | O | 담당자 성명 | |
ContactEmail | String | 100 | O | 담당자 이메일 | |
ContactTEL | String | 20 | O | 담당자 휴대폰 |
CorpInfo
순번 | 변수명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|
ceoname | String | 100 | O | 대표자 성명 | |
corpName | String | 200 | O | 회사명 | |
addr | String | 300 | O | 주소 | |
bizType | String | 100 | O | 업태 | |
bizClass | String | 100 | O | 종목 |
ContactInfo
순번 | 변수명 | 타입 | 길이 | 필수 | 비고 |
---|---|---|---|---|---|
id | String | 50 | O |
아이디
└ 6자 이상 50자 이하 |
|
Password | String | 20 | △ |
비밀번호
└ 8자 이상 20자 이하 └ 영문, 숫자, 특수문자 조합 |
|
personName | String | 100 | O | 담당자 성명 | |
tel | String | 20 | O | 담당자 휴대폰 | |
String | 100 | O | 담당자 이메일 | ||
regDT | String | 14 | X | 등록일시 (형식 : yyyyMMddHHmmss) | |
searchRole | Integer | 1 | - |
담당자 권한 : 1 / 2 / 3 중 반환
└ 1 : 개인권한 └ 2 : 읽기권한 └ 3 : 회사권한 |
|
mgrYN | Boolean | - | X |
관리자 여부 : true / false 중 반환
└ true : 관리자 └ false : 담당자 └ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능 |
|
state | Integer | 1 | X |
계정상태 : 1 반환
└ 1 : 사용중 |
RefundResponse
순번 | 변수명 | 타입 | 길이 | 비고 |
---|---|---|---|---|
code | Integer | - | API 처리에 대한 응답코드 | |
message | String | - | API 처리에 대한 응답메시지 | |
refundCode | String | 18 | 환불코드 |