부가기능

1. SendEmail - 메일 재전송

현금영수증과 관련된 안내 메일을 재전송 합니다.

def sendEmail(CorpNum, MgtKey, ReceiverEmail, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	MgtKey	str	24	Y	메일 재전송할 현금영수증 문서번호
3	ReceiverEmail	str	-	Y	수신자 메일주소
4	UserID	str	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	int	-	API 처리에 대한 응답코드 1 성공
2	message	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

2. SendSMS - 문자 재전송

현금영수증과 관련된 안내 SMS(단문) 문자를 재전송하는 함수로, 팝빌 사이트 [ 문자 > 결과 > 전송결과 ] 메뉴에서 전송결과를 확인할 수 있습니다.

• 메시지는 최대 90byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송합니다. (한글 최대 45자)

def sendSMS(CorpNum, MgtKey, Sender, Receiver, Contents, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	MgtKey	str	24	Y	파트너가 할당한 문서번호
3	Sender	str	-	Y	발신번호
4	Receiver	str	-	Y	수신번호
5	Contents	str	90	Y	메시지 내용 → 최대 90 byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송
6	UserID	str	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	int	-	API 처리에 대한 응답코드 1 성공
2	message	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

3. SendFAX - 팩스 전송

현금영수증을 팩스로 전송하는 함수로, 팝빌 사이트 [ 팩스 > 결과 > 전송결과 ] 메뉴에서 전송결과를 확인할 수 있습니다.

def sendFAX(CorpNum, MgtKey, Sender, Receiver, UserID=None)

API 호출 시 포인트가 차감됩니다.

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	MgtKey	str	24	Y	파트너가 할당한 문서번호
3	Sender	str	-	Y	발신번호
4	Receiver	str	-	Y	수신번호
5	UserID	str	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	int	-	API 처리에 대한 응답코드 1 성공
2	message	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

4. AssignMgtKey - 문서번호 할당

팝빌 사이트를 통해 발행하여 문서번호가 할당되지 않은 현금영수증에 문서번호를 할당합니다.

def assignMgtKey(CorpNum, ItemKey, MgtKey, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	itemKey	str	18	Y	팝빌에서 현금영수증 관리 목적으로 할당한 식별번호 → [Search – 목록 조회]를 통하여 CashbillInfo의 변수 'itemKey'를 확인
3	MgtKey	str	24	Y	파트너가 할당한 문서번호
4	UserID	str	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	int	-	API 처리에 대한 응답코드 1 성공
2	message	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

5. ListEmailConfig - 알림메일 발송설정 조회

현금영수증 관련 메일 항목에 대한 발송설정을 확인합니다.

def listEmailConfig(CorpNum, UserID=None)

요청

Parameters

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

응답

list[EmailSendConfig]

순번	변수명	타입	길이	설명
1	emailType	str	9	메일 전송 유형 CSH_ISSUE 고객에게 현금영수증이 발행 되었음을 알려주는 메일
2	sendYN	bool	-	전송 여부 True 전송 False 미전송

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

6. UpdateEmailConfig - 알림메일 발송설정 수정

현금영수증 관련 메일 항목에 대한 발송설정을 수정합니다.

def updateEmailConfig(Corpnum, EmailType, SendYN, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	Corpnum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	EmailType	str	-	Y	메일 전송 유형 CSH_ISSUE 고객에게 현금영수증이 발행 되었음을 알려주는 메일
3	SendYN	bool	-	Y	전송 여부
4	UserID	str	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	int	-	API 처리에 대한 응답코드 1 성공
2	message	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지