API Reference 현금영수증 Ruby 부가기능
4.1. SendEmail - 메일 재전송
- 현금영수증과 관련된 안내 메일을 재전송 합니다.
def sendEmail(corpNum, mgtKey, receiverMail, userID = '')
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
String |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
mgtKey |
String |
24 |
Y |
이메일 재전송할 현금영수증 문서번호 |
|
receiverMail |
String |
- |
Y |
수신자 이메일주소 |
|
userID |
String |
50 |
N |
팝빌회원 아이디 |
Return
Response
Throws
PopbillException
4.2. SendSMS - 문자 재전송
- 현금영수증과 관련된 안내 SMS(단문) 문자를 재전송하는 함수로, 팝빌 사이트 [문자·팩스] > [문자] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.
- 메시지는 최대 90byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송합니다. (한글 최대 45자)
def sendSMS(corpNum, mgtKey, senderNum, receiverNum, contents, userID = '')
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
String |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
mgtKey |
String |
24 |
Y |
파트너가 할당한 문서번호 |
|
senderNum |
String |
- |
Y |
발신번호 |
|
receiverNum |
String |
- |
Y |
수신번호 |
|
contents |
String |
90 |
Y |
메시지 내용
최대 90 byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송
|
|
userID |
String |
50 |
N |
팝빌회원 아이디 |
Return
Response
Throws
PopbillException
4.3. SendFAX - 팩스 전송
- 현금영수증을 팩스로 전송하는 함수로, 팝빌 사이트 [문자·팩스] > [팩스] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.
def sendFax(corpNum, mgtKey, senderNum, receiverNum, userID = '')
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
String |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
mgtKey |
String |
24 |
Y |
파트너가 할당한 문서번호 |
|
senderNum |
String |
- |
Y |
발신번호 |
|
receiverNum |
String |
- |
Y |
수신번호 |
|
userID |
String |
50 |
N |
팝빌회원 아이디 |
Return
Response
Throws
PopbillException
4.4. AssignMgtKey - 문서번호 할당
- 팝빌 사이트를 통해 발행하여 문서번호가 할당되지 않은 현금영수증에 문서번호를 할당합니다.
def assignMgtKey(corpNum, itemKey, mgtKey, userID = '')
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
String |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
itemKey |
String |
24 |
Y |
팝빌에서 현금영수증 관리 목적으로 할당한 식별번호
|
|
mgtKey |
String |
24 |
Y |
파트너가 할당한 문서번호 |
|
userID |
String |
50 |
N |
팝빌회원 아이디 |
Return
Response
Throws
PopbillException
4.5. ListEmailConfig - 현금영수증 알림메일 발송설정 조회
- 현금영수증 관련 메일 항목에 대한 발송설정을 확인합니다.
def listEmailConfig(corpNum, userID ='')
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
String |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
userID |
String |
50 |
N |
팝빌회원 아이디 |
Return
EmailSendConfig[ ]
Throws
PopbillException
4.6. UpdateEmailConfig - 현금영수증 알림메일 발송설정 수정
- 현금영수증 관련 메일 항목에 대한 발송설정을 수정합니다.
def updateEmailConfig(corpNum, emailType, sendYN, userID = '')
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
String |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
emailType |
String |
9 |
Y |
발송 메일 유형
CSH_ISSUE
고객에게 현금영수증이 발행 되었음을 알려주는 메일
|
|
sendYN |
Boolean |
- |
Y |
전송 여부 |
|
userID |
String |
50 |
N |
팝빌회원 아이디 |
Return
Response
Throws
PopbillException
