A. 객체정보
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Integer | - |
API 처리에 대한 응답코드
1성공
|
|
| message | String | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Integer | - |
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
|
ATSTemplate
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| templateCode | String | 12 | 템플릿 코드 | |
| templateName | String | 20 | 템플릿 제목 | |
| template | String | 1000 | 템플릿 내용 | |
| plusFriendID | String | 30 | 검색용 아이디 | |
| ads | String | 80 | 광고 메시지 | |
| appendix | String | 500 | 부가 메시지 | |
| btns | KakaoButton[ ] |
버튼 목록
최대 : 5개
|
||
KakaoReceiver
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| receiverNum | String | 20 | Y | 수신번호 | |
| receiverName | String | 70 | N | 수신자명 | |
| message | String | - | 조건부 |
알림톡/친구톡 내용
대량전송 경우 필수
알림톡/친구톡(텍스트) : 최대 1,000자 친구톡(이미지) : 최대 400자 |
|
| altMessage | String | 2000 | N |
대체문자 내용
대량전송 경우 사용
|
|
| btns | KakaoButton[ ] | N |
버튼 목록
대량전송 경우 사용
최대 : 5개 |
||
| interOPRefKey | String | 20 | N |
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
|
KakaoSearchResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Integer | - |
API 처리에 대한 응답코드
1성공
|
|
| message | String | - | API 처리에 대한 응답메시지 | |
| total | Integer | - | 총 검색결과 건수 | |
| perPage | Integer | - | 페이지당 목록 건수 | |
| pageNum | Integer | - | 페이지 번호 | |
| pageCount | Integer | - | 페이지 개수 | |
| list | KakaoSentDetail[ ] |
전송결과 정보
최대 : 1,000건
|
||
KakaoSentInfo
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| contentType | Integer | 1 |
카카오톡 유형
|
|
| templateCode | String | 12 |
템플릿 코드
알림톡 전송시 사용한 코드값
|
|
| plusFriendID | String | 30 |
검색용 아이디
알림톡/친구톡 전송시 사용한 아이디값
|
|
| sendNum | String | 20 | 발신번호 | |
| 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 | KakaoButton[ ] |
버튼 목록
최대 : 5개
|
||
| msgs | 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 |
카카오톡 유형
|
|
| receiveNum | String | 20 | 수신번호 | |
| receiveName | String | 70 | 수신자명 | |
| content | String | 1000 | 알림톡/친구톡 내용 | |
| 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 |
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
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 | 조건부 | 비밀번호 | |
| personName | String | 100 | Y | 담당자 성명 | |
| tel | String | 20 | Y | 담당자 휴대폰 | |
| String | 100 | Y | 담당자 이메일 | ||
| searchRole | String | 1 | N |
담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값
|
ContactInfo - 출력부
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| id | String | 50 | 아이디 | |
| personName | String | 100 | 담당자 성명 | |
| tel | String | 20 | 담당자 휴대폰 | |
| String | 100 | 담당자 이메일 | ||
| regDT | String | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
| searchRole | Integer | 1 |
담당자 권한
1개인권한
2읽기권한
3회사권한
|
|
| mgrYN | Boolean | - |
관리자 여부
true관리자
false담당자
팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
|
|
| state | Integer | 1 |
계정상태
1사용중
|