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 | 메모 |
MessageReceiver
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| rcv | String | 20 | Y | 수신번호 | |
| rcvnm | String | 70 | N | 수신자명 | |
| snd | String | 20 | Y |
발신번호
대량전송 경우 사용
|
|
| sndnm | String | 70 | N |
발신자명
대량전송 경우 사용
|
|
| msg | String | - | 조건부 |
메시지 내용
대량전송 경우 필수
단문 : 90byte 이하, 장문 : 2,000byte 이하 한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte |
|
| sjt | String | 40 | N |
메시지 제목
대량전송 경우 사용
메시지 길이가 90byte 이상인 경우에만 적용 기본값 : 팝빌에서 설정한 제목 사용
|
MSGSearchResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Integer | - |
API 처리에 대한 응답코드
1성공
|
|
| message | String | - | API 처리에 대한 응답메시지 | |
| total | Integer | - | 총 검색결과 건수 | |
| perPage | Integer | - | 페이지당 목록 건수 | |
| pageNum | Integer | - | 페이지 번호 | |
| pageCount | Integer | - | 페이지 개수 | |
| list | SentMessage[ ] |
전송결과 정보
최대 : 1,000개
|
||
SentMessage
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| subject | String | 40 | 메시지 제목 | |
| content | String | - |
메시지 내용
단문 : 90byte 이하, 장문 : 2,000byte 이하
한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte |
|
| sendNum | String | 20 | 발신번호 | |
| senderName | String | 70 | 발신자명 | |
| receiveNum | String | 20 | 수신번호 | |
| receiveName | String | 70 | 수신자명 | |
| receiptDT | String | 14 |
접수일시
형식 : yyyyMMddHHmmss
|
|
| sendDT | String | 14 |
전송일시
형식 : yyyyMMddHHmmss
|
|
| resultDT | String | 14 |
전송결과 수신일시
형식 : yyyyMMddHHmmss
|
|
| reserveDT | String | 14 |
예약일시
형식 : yyyyMMddHHmmss
|
|
| state | String | 1 | 팝빌 상태코드 | |
| result | String | 3 | 통신사 결과코드 | |
| type | String | 3 | 메시지 타입 | |
| tranNet | String | 3 | 전송처리 이동통신사명 | |
| receiptNum | String | 18 | 접수번호 | |
| requestNum | String | 36 | 요청번호 |
AutoDeny
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| number | String | 20 | 수신거부번호 | |
| regDT | String | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
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사용중
|