Index

1. 발신번호 사전등록

1.1. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL

ㆍ 문자 발신번호 관리 팝업 URL을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

def getSenderNumberMgtURL(CorpNum, UserID):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

1.2. GetSenderNumberList - 발신번호 목록 확인

ㆍ 팝빌에 등록된 문자 발신번호 목록을 반환합니다.

def getSenderNumberList(CorpNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

SenderNumber[]

Throws

PopbillException

2. 문자전송

접수번호(recieptNum)

  • 작업(접수) 단위를 나타내는 고유한 식별정보로 문자 전송 함수 호출시 팝빌로부터 반환받는 값
  • 예약접수 건을 취소하거나, 전송내역 및 실패사유를 확인하기 위한 값

cf. 다건접수(대량/동보) 경우에도 하나의 접수번호만을 반환

2.1. SendSMS - 단문 전송

ㆍ 단문(SMS) 메시지를 전송합니다.

ㆍ 메시지 길이가 90byte 이상인 경우, 길이를 초과하는 메시지 내용은 자동으로 제거됩니다.

ㆍ 팝빌에 등록되지 않은 발신번호로 메시지를 전송하는 경우 발신번호 미등록 오류로 처리됩니다.

def sendSMS(CorpNum, Sender, Receiver, ReceiverName, Contents, reserveDT, adsYN=False, UserID=None, SenderName=None, RequestNum=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Sender str 20 O 발신번호
3 Receiver str 20 O 수신번호
4 ReceiverName str 70 O 수신자명
5 Contents str 90 O 메시지 내용
- 한글,한자,특수문자 2byte / 영문,숫자 1byte
6 reserveDT str 14 O 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
7 adsYN bool - - 광고메시지 전송여부
[참고] "광고메시지 전송방법 안내" - http://blog.linkhub.co.kr/2642/
8 UserID str 50 - 팝빌회원 아이디
9 SenderName str 70 - 발신자명
10 RequestNum str 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

str - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.2. SendSMS - 단문 전송 (대량전송)

ㆍ 단문(SMS) 메시지를 전송합니다. (최대 1000건)

ㆍ 메시지 길이가 90byte 이상인 경우, 길이를 초과하는 메시지 내용은 자동으로 제거됩니다.

ㆍ 팝빌에 등록되지 않은 발신번호로 메시지를 전송하는 경우 발신번호 미등록 오류로 처리됩니다.

def sendSMS_multi(CorpNum, Sender, Contents, Messages, reserveDT, adsYN=False, UserID=None, RequestNum=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Sender str 20 O [동보] 발신번호, 전송정보에 발신번호 없는 경우 적용
3 Contents str 90 O [동보] 메시지 내용, 전송정보에 메시지 내용 없는 경우 적용
- 한글,한자,특수문자 2byte / 영문,숫자 1byte
4 Messages MessageReceiver[] 1000 O [배열] 전송 정보 (최대 1,000건)
5 reserveDT str 14 O 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
6 adsYN bool - - 광고메시지 전송여부
[참고] "광고메시지 전송방법 안내" - http://blog.linkhub.co.kr/2642/
7 UserID str 50 - 팝빌회원 아이디
8 RequestNum str 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

str - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.3. SendLMS - 장문 전송

ㆍ 장문(LMS) 메시지를 전송합니다.

ㆍ 메시지 길이가 2000 byte 이상인 경우, 길이를 초과하는 메시지 내용은 자동으로 제거됩니다.

ㆍ 팝빌에 등록되지 않은 발신번호로 메시지를 전송하는 경우 발신번호 미등록 오류로 처리됩니다.

def sendLMS(CorpNum, Sender, Receiver, ReceiverName, Subject, Contents, reserveDT, adsYN=False, UserID=None, SenderName=None, RequestNum=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Sender str 20 O 발신번호
3 Receiver str 20 O 수신번호
4 ReceiverName str 70 O 수신자명
5 Subject str 40 O 메시지 제목
6 Contents str 90 O 메시지 내용
- 한글,한자,특수문자 2byte / 영문,숫자 1byte
7 reserveDT str 14 O 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
8 adsYN bool - - 광고메시지 전송여부
[참고] "광고메시지 전송방법 안내" - http://blog.linkhub.co.kr/2642/
9 UserID str 50 - 팝빌회원 아이디
10 SenderName str 70 - 발신자명
11 RequestNum str 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

str - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.4. SendLMS - 장문 전송 (대량전송)

ㆍ 장문(LMS) 메시지를 전송합니다. (최대 1000건)

ㆍ 메시지 길이가 2000 byte 이상인 경우, 길이를 초과하는 메시지 내용은 자동으로 제거됩니다.

ㆍ 팝빌에 등록되지 않은 발신번호로 메시지를 전송하는 경우 발신번호 미등록 오류로 처리됩니다.

def sendLMS_multi(CorpNum, Sender, Subject, Contents, Messages, reserveDT, adsYN=False, UserID=None, RequestNum=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Sender str 20 O [동보] 발신번호, 전송정보에 발신번호 없는 경우 적용
3 Subject str 40 O [동보] 메시지 제목, 전송정보에 메시지 제목 없는 경우 적용
4 Contents str 90 O [동보] 메시지 내용, 전송정보에 메시지 내용 없는 경우 적용
- 한글,한자,특수문자 2byte / 영문,숫자 1byte
5 Messages MessageReceiver[] 1000 O [배열] 전송 정보 (최대 1,000건)
6 reserveDT str 14 O 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
7 adsYN bool - - 광고메시지 전송여부
[참고] "광고메시지 전송방법 안내" - http://blog.linkhub.co.kr/2642/
8 UserID str 50 - 팝빌회원 아이디
9 RequestNum str 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

str - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.5. SendMMS - 포토문자 전송

ㆍ 포토(MMS) 메시지를 전송합니다.

ㆍ 이미지 파일 포맷/규격 : 최대 300Kbyte(JPEG), 가로/세로 1000px 이하 권장

ㆍ 메시지 길이가 2000 byte 이상인 경우, 길이를 초과하는 메시지 내용은 자동으로 제거됩니다.

ㆍ 팝빌에 등록되지 않은 발신번호로 메시지를 전송하는 경우 발신번호 미등록 오류로 처리됩니다.

def sendMMS(CorpNum, Sender, Receiver, ReceiverName, Subject, Contents, filePath, reserveDT, adsYN=False, UserID=None, SenderName=None, RequestNum=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Sender str 20 O 발신번호
3 Receiver str 20 O 수신번호
4 ReceiverName str 70 O 수신자명
5 Subject str 40 O 메시지 제목
6 Contents str 90 O 메시지 내용
- 한글,한자,특수문자 2byte / 영문,숫자 1byte
7 filePath str - O 전송파일 경로
8 reserveDT str 14 O 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
9 adsYN bool - - 광고메시지 전송여부
[참고] "광고메시지 전송방법 안내" - http://blog.linkhub.co.kr/2642/
10 UserID str 50 - 팝빌회원 아이디
11 senderName str 70 - 발신자명
12 RequestNum str 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

str - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.6. SendMMS - 포토문자 전송 (대량전송)

ㆍ 포토(MMS) 메시지를 전송합니다. (최대 1000건)

ㆍ 이미지 파일 포맷/규격 : 최대 300Kbyte(JPEG), 가로/세로 1000px 이하 권장

ㆍ 메시지 길이가 2000 byte 이상인 경우, 길이를 초과하는 메시지 내용은 자동으로 제거됩니다.

ㆍ 팝빌에 등록되지 않은 발신번호로 메시지를 전송하는 경우 발신번호 미등록 오류로 처리됩니다.

def sendMMS_Multi(CorpNum, Sender, Subject, Contents, Messages, FilePath, reserveDT, adsYN=False, UserID=None, RequestNum=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Sender str 20 O [동보] 발신번호, 전송정보에 발신번호 없는 경우 적용
3 Subject str 40 O [동보] 메시지 제목, 전송정보에 메시지 제목 없는 경우 적용
4 Contents str 90 O [동보] 메시지 내용, 전송정보에 메시지 내용 없는 경우 적용
- 한글,한자,특수문자 2byte / 영문,숫자 1byte
5 Messages MessageReceiver[] 1000 O [배열] 전송 정보 (최대 1,000건)
7 FilePath str - O 전송파일 경로
8 reserveDT str 14 O 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
9 adsYN bool - - 광고메시지 전송여부
[참고] "광고메시지 전송방법 안내" - http://blog.linkhub.co.kr/2642/
10 UserID str 50 - 팝빌회원 아이디
11 RequestNum str 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

str - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.7. SendXMS - 단문/장문 자동인식 전송

ㆍ 메시지 내용의 길이(90byte)에 따라 단문/장문(SMS/LMS)을 자동인식하여 전송합니다.

ㆍ 팝빌에 등록되지 않은 발신번호로 메시지를 전송하는 경우 발신번호 미등록 오류로 처리됩니다.

def sendXMS(CorpNum, Sender, Receiver, ReceiverName, Subject, Contents, reserveDT, adsYN=False, UserID=None, SenderName=None, RequestNum=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Sender str 20 O 발신번호
3 Receiver str 20 O 수신번호
4 ReceiverName str 70 O 수신자명
5 Subject str 40 O 메시지 제목
6 Contents str 90 O 메시지 내용
- 한글,한자,특수문자 2byte / 영문,숫자 1byte
7 reserveDT str 14 O 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
8 adsYN bool - - 광고메시지 전송여부
[참고] "광고메시지 전송방법 안내" - http://blog.linkhub.co.kr/2642/
9 UserID str 50 - 팝빌회원 아이디
10 SenderName str 70 - 발신자명
11 RequestNum str 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

str - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.8. SendXMS - 단문/장문 자동인식 전송 (대량전송)

ㆍ 메시지 내용의 길이(90byte)에 따라 단문/장문(SMS/LMS)을 자동인식하여 전송합니다. (최대 1000건)

ㆍ 팝빌에 등록되지 않은 발신번호로 메시지를 전송하는 경우 발신번호 미등록 오류로 처리됩니다.

def sendXMS_multi(CorpNum, Sender, Subject, Contents, Messages, reserveDT, adsYN=False, UserID=None, RequestNum=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Sender str 20 O [동보] 발신번호, 전송정보에 발신번호 없는 경우 적용
3 Subject str 40 O [동보] 메시지 제목, 전송정보에 메시지 제목 없는 경우 적용
4 Contents str 90 O [동보] 메시지 내용, 전송정보에 메시지 내용 없는 경우 적용
- 한글,한자,특수문자 2byte / 영문,숫자 1byte
5 Messages MessageReceiver[] 1000 O [배열] 전송 정보 (최대 1,000건)
6 reserveDT str 14 O 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
7 adsYN bool - - 광고메시지 전송여부
[참고] "광고메시지 전송방법 안내" - http://blog.linkhub.co.kr/2642/
8 UserID str 50 - 팝빌회원 아이디
9 RequestNum str 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

str - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.9. CancelReserve - 예약전송 취소

ㆍ 예약문자 전송을 취소합니다.

ㆍ 예약취소는 예약시간 10분전까지 가능합니다.

def cancelReserve(CorpNum, ReceiptNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ReceiptNum str 18 O 예약문자 전송요청시 발급받은 접수번호
3 UserID str 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

2.10. CancelReserveRN - 예약전송 취소 (요청번호 할당)

ㆍ 예약문자 전송을 취소합니다.

ㆍ 예약취소는 예약시간 10분전까지 가능합니다.

def cancelReserveRN(CorpNum, RequestNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 RequestNum str 36 O 예약문자 전송요청시 할당한 전송요청번호
3 UserID str 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

3. 정보확인

3.1. GetMessages - 전송내역 확인

ㆍ 문자 전송상태 및 결과정보를 확인합니다.

def getMessages(CorpNum, ReceiptNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ReceiptNum str 18 O 문자 전송요청시 발급받은 접수번호
3 UserID str 50 - 팝빌회원 아이디

Return

SentMessage[]

Throws

PopbillException

3.2. GetMessagesRN - 전송내역 확인 (요청번호 할당)

ㆍ 문자 전송상태 및 결과정보를 확인합니다.

def getMessagesRN(CorpNum, RequestNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 RequestNum str 36 O 문자 전송요청시 할당한 전송요청번호
3 UserID str 50 - 팝빌회원 아이디

Return

SentMessage[]

Throws

PopbillException

3.3. GetStates - 전송내역 요약정보 확인

ㆍ 문자 전송상태 및 결과정보에 대한 요약정보를 확인합니다.

def getStates(Corpnum, reciptNumList, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 receiptNumList list 18 O [배열] 문자전송 접수번호 배열 (최대 1,000건)
3 UserID str 50 - 팝빌회원 아이디

Return

MessageBriefInfo[]

Throws

PopbillException

3.4. Search - 전송내역 목록 조회

ㆍ 검색조건에 해당하는 문자 전송내역 목록을 조회합니다. (최대 검색기간 : 6개월 이내)

def search(CorpNum, SDate, EDate, State, Item, ReserveYN, SenderYN, Page, PerPage, Order, UserID=None, Qstr=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 SDate str 8 O 시작일자, 날짜형식(yyyyMMdd)
3 EDate str 8 O 종료일자, 날짜형식(yyyyMMdd)
4 State list - O [배열] 전송상태 [ 1-대기 / 2-성공 / 3-실패 / 4-취소 ]
5 Item list - O [배열] 검색대상 [ SMS-단문 / LMS-장문 / MMS-포토 ]
6 ReserveYN bool - O 예약여부 [ False-전체조회, True-예약전송건 조회 ]
7 SenderYN bool - O 개인조회 여부 [ False-전체조회, True-개인조회 ]
8 Page int - O 페이지번호, 기본값 '1'
9 PerPage int - O 페이지당 검색개수, 기본값 500, 최대 1000
10 Order str 1 O 정렬 방향, 기본값 'D' [ D-내림차순 / A-오름차순 ]
11 UserID str 50 - 팝빌회원 아이디
12 Qstr str - - 발신자명 또는 수신자명 검색조회, 공백처리시 전체조회

Return

MSGSearchResult[]

Throws

PopbillException

3.5. GetSentListURL - 문자 전송내역 팝업 URL

ㆍ 문자 전송내역 팝업 URL을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

def getSentListURL(CorpNum, UserID):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

3.6. GetAutoDenyList - 080 수신거부 목록 확인

ㆍ 080 수신거부 목록을 반환합니다.

def getAutoDenyList(CorpNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

AutoDeny[]

Throws

PopbillException

4. 포인트 관리

4.1. GetBalance - 연동회원 잔여포인트 확인

ㆍ연동회원의 잔여포인트를 확인합니다.

def getBalance(CorpNum):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

float - 연동회원 잔여포인트

Throws

PopbillException

4.2. GetChargeURL - 연동회원 포인트 충전 팝업 URL

ㆍ연동회원 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getChargeURL(CorpNum, UserID):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

4.3. GetPartnerBalance - 파트너 잔여포인트 확인

ㆍ파트너의 잔여포인트를 확인합니다.

def getPartnerBalance(CorpNum):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

float - 파트너 잔여포인트

Throws

PopbillException

4.4. GetPartnerURL - 파트너 포인트충전 팝업 URL

ㆍ파트너 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getPartnerURL(CorpNum, TOGO):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 TOGO str - O "CHRG" 입력

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

4.5. GetUnitCost - 발행 단가 확인

ㆍ문자 전송시 과금되는 포인트 단가를 확인합니다.

def getUnitCost(CorpNum, MsgType):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MsgType str - O 문자전송 유형 : SMS / LMS / MMS 중 택 1
└ SMS = 단문, LMS = 장문, MMS = 포토문자

Return

float - 문자 전송 단가

Throws

PopbillException

4.6. GetChargeInfo - 과금정보 확인

ㆍ팝빌 문자 API 서비스 과금정보를 확인합니다.

def getChargeInfo(CorpNum, MsgType, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MsgType str - O 문자전송 유형 : SMS / LMS / MMS 중 택 1
└ SMS = 단문, LMS = 장문, MMS = 포토문자
3 UserID str 50 - 팝빌회원 아이디

Return

ChargeInfo

Throws

PopbillException

5. 회원정보

5.1. CheckIsMember - 연동회원 가입여부 확인

ㆍ사업자번호를 조회하여 연동회원 가입여부를 확인합니다.

def checkIsMember(CorpNum):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

Response

Throws

PopbillException

5.2. CheckID - 아이디 중복 확인

ㆍ사용하고자 하는 아이디의 중복여부를 확인합니다.

def checkID(checkID):

Parameters

순번 변수명 타입 길이 필수 설명
1 CheckID str 10 O 중복여부를 확인할 아이디

Return

Response

Throws

PopbillException

5.3. JoinMember - 연동회원 신규가입

ㆍ사용자를 연동회원으로 가입처리합니다.

def joinMember(JoinInfo):

Parameters

순번 변수명 타입 길이 필수 설명
1 JoinInfo JoinForm - O 연동회원 객체정보

Return

Response

Throws

PopbillException

5.4. GetAccessURL - 팝빌 로그인 팝업 URL

ㆍ팝빌 사이트에 로그인 상태로 접근할 수 있는 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getAccessURL(CorpNum, UserID):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

5.5. GetCorpInfo - 회사정보 확인

ㆍ연동회원의 회사정보를 확인합니다.

def getCorpInfo(CorpNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

CorpInfo

Throws

PopbillException

5.6. UpdateCorpInfo - 회사정보 수정

ㆍ연동회원의 회사정보를 수정합니다.

def updateCorpInfo(CorpNum, CorpInfo, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 CorpInfo CorpInfo - O 회사 객체정보
3 UserID str 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

5.7. RegistContact - 담당자 추가

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정)를 추가합니다.

def registContact(CorpNum, ContactInfo, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ContactInfo ContactInfo - O 담당자 객체정보
3 UserID str 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

5.8. ListContact - 담당자 목록 확인

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 목록을 확인합니다.

def listContact(CorpNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

ContactInfo[ ]

Throws

PopbillException

5.9. UpdateContact - 담당자 정보 수정

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 정보를 수정합니다.

def updateContact(CorpNum, ContactInfo, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ContactInfo ContactInfo - O 담당자 객체정보
3 UserID str 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

A. 객체정보

A.1. Response

순번 변수명 항목명 타입 길이 비고
1 code 코드 int - API 처리에 대한 응답 상태코드
2 message 메시지 str - API 처리에 대한 응답 메시지

A.2. PopbillException

순번 변수명 항목명 타입 길이 비고
1 code 코드 int - API 처리 실패에 대한 오류코드(-로 시작하는 8자리 숫자값)
2 message 메시지 str - API 처리 실패에 대한 오류메시지

A.3. SenderNumber

순번 변수명 항목명 타입 길이 비고
1 number 발신번호 str 20
2 representYN 대표번호 지정여부 bool -
3 state 등록일시 int 1 등록상태 [ 0-대기 / 1-승인 / 2-취소 ]

A.4. MessageReceiver

순번 변수명 항목명 타입 길이 필수 비고
1 sender 발신번호 str 20 O
2 senderName 발신자명 str 70 -
3 receiver 수신번호 str 20 O
4 receiverName 수신자명 str 70 -
5 content 메시지 내용 str 단문 90
장문 2000
단위 : byte
O 한글,한자,특수문자 2byte / 영문,숫자 1byte
6 subject 메시지 제목 str 40 - 장문/포토문자 전송에만 메시지 제목 사용 가능

A.5. MSGSearchResult

순번 변수명 항목명 타입 길이 비고
1 code 요청에 대한 응답코드 int -
2 message 요청에 대한 응답메시지 str -
3 total 총 검색결과 건수 int -
4 perPage 페이지당 검색개수 int -
5 pageNum 페이지 번호 int -
6 pageCount 페이지 개수 int -
7 list 전송결과 정보 List<SentMessage> [리스트] 최대 1,000개, 전송내역 확인(GetMessages API) 응답전문의 구성과 동일

A.6. SentMessage

순번 변수명 항목명 타입 길이 비고
1 subject 메시지 제목 str 40
2 content 메시지 내용 str 단문 90
장문 2000
단위 : byte
3 sendNum 발신번호 str 20
4 senderName 발신자명 str 70
5 receiveNum 수신번호 str 20
6 receiveName 수신자명 str 70
7 receiptDT 접수일시 str 14
8 sendDT 전송일시 str 14
9 resultDT 전송결과 수신일시 str 14
10 reserveDT 예약일시 str 14
11 state 전송 상태코드 str 1 [부록] "전송 코드 테이블"
12 result 전송 결과코드 str 3
13 type 메시지 타입 str 3
14 tranNet 전송처리 이동통신사명 str 3
15 receiptNum 접수번호 str 18
16 requestNum 요청번호 str 36

A.7. MessageBriefInfo

순번 변수명 항목명 타입 길이 비고
1 sn 일련번호 str -
2 rNum 접수번호 str 18
3 stat 전송 상태코드 str 1 [부록] "전송 코드 테이블"
4 sDT 전송일시 str -
5 rDT 전송결과 수신일시 str -
6 rlt 전송 결과코드 str 3 [부록] "전송 코드 테이블"
7 net 전송 이동통신사명 str -
8 srt 구 전송결과 코드 str -

A.8 AutoDeny

순번 변수명 항목명 타입 길이 비고
1 number 수신거부번호 str 20
2 regDT 등록일시 str 14

A.9. ChargeInfo

순번 변수명 항목명 타입 길이 비고
1 unitCost 전송단가 str - 전송단가 반환
2 chargeMethod 과금유형 str - 일반, 연동, 파트너 중 반환
3 rateSystem 과금제도 str - 종량제 반환

A.10. JoinForm

순번 변수명 항목명 타입 길이 필수 비고
1 ID 아이디 str 50 O 6자 이상 50자 미만
2 PWD 비밀번호 str 20 O 6자 이상 20자 미만
3 LinkID 파트너 링크아이디 str 20 O 파트너 신청시 메일로 발급받은 링크아이디
4 CorpNum 사업자번호 str 10 O 사업자번호 (하이픈 '-' 제외 10 자리)
5 CEOName 대표자 성명 str 100 O
6 CorpName 상호 str 200 O
7 Addr 사업장 주소 str 300 O
8 BizType 업태 str 100 O
9 BizClass 종목 str 100 O
10 ContactName 담당자 성명 str 100 O
11 ContactEmail 담당자 이메일 str 100 O
12 ContactTEL 담당자 연락처 str 20 O
13 ContactHP 담당자 휴대폰번호 str 20 -
14 ContactFAX 담당자 팩스번호 str 20 -

A.11. CorpInfo

순번 변수명 항목명 타입 길이 필수 비고
1 ceoname 대표자 성명 str 100 O
2 corpName 상호 str 200 O
3 addr 주소 str 300 O
4 bizType 업태 str 100 O
5 bizClass 종목 str 100 O

A.12. ContactInfo

순번 변수명 항목명 타입 길이 필수 비고
1 id 아이디 str 50 O 6자 이상 50자 미만
2 pwd 비밀번호 str 20 O 6자 이상 20자 미만
3 personName 담당자 성명 str 100 O
4 tel 담당자 연락처 str 20 -
5 hp 담당자 휴대폰번호 str 20 -
6 fax 담당자 팩스번호 str 20 -
7 email 담당자 이메일 str 100 O
8 regDT 등록일시 str 14 -
9 searchAllAllowYN 담당자 조회권한 설정 bool - O 회사조회(True) : 모든 담당자의 문자 전송내역 조회가능
개인조회(False) : 해당 담당자 계정으로 전송한 문자 전송내역 조회가능
10 mgrYN 관리자 여부 bool - O True-관리자 / False-사용자
11 state 상태 int 1 - 0–승인대기 / 1–사용중