POPBill Developers
API Reference

2. 문자전송

2.1. SendSMS - 단문 전송

  • 최대 90byte의 단문(SMS) 메시지 1건 전송을 팝빌에 접수합니다.
messageService.sendSMS(CorpNum, Sender, Receiver, ReceiverName, Contents, reserveDT, adsYN, SenderName, requestNum, success, error)
발신번호 등록
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
Sender string 20 Y 발신번호
Receiver string 20 Y 수신번호
ReceiverName string 70 N 수신자명
Contents string 90 Y 메시지 내용
한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte
reserveDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
adsYN boolean - N 광고메시지 전송여부
true광고
false일반 : 기본값
SenderName string 70 N 발신자명
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

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

Throws

PopbillException

2.2. SendSMS_multi - 단문 전송 (동보/대량전송)

  • 최대 90byte의 단문(SMS) 메시지 다수건 전송을 팝빌에 접수합니다. (최대 1,000건)
  • 모든 수신자에게 동일한 내용을 전송하거나(동보전송), 수신자마다 개별 내용을 전송할 수 있습니다(대량전송).
messageService.sendSMS_multi(CorpNum, Sender, Contents, Messages, reserveDT, adsYN, requestNum, success, error)
발신번호 등록
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
Sender string 20 Y 발신번호
동보전송 경우 사용
Contents string 90 조건부 메시지 내용
동보전송 경우 필수
한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte
Messages Message[ ] Y 전송정보
최대 : 1,000개
reserveDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
adsYN boolean - N 광고메시지 전송여부
true광고
false일반 : 기본값
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

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

Throws

PopbillException

2.3. SendLMS - 장문 전송

  • 최대 2,000byte의 장문(LMS) 메시지 1건 전송을 팝빌에 접수합니다.
messageService.sendLMS(CorpNum, Sender, Receiver, ReceiverName, Subject, Contents, reserveDT, adsYN, SenderName, requestNum, success, error)
발신번호 등록
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
Sender string 20 Y 발신번호
Receiver string 20 Y 수신번호
ReceiverName string 70 N 수신자명
Subject string 40 N 메시지 제목
기본값 : 팝빌에서 설정한 제목 사용
Contents string 2000 Y 메시지 내용
한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte
reserveDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
adsYN boolean - N 광고메시지 전송여부
true광고
false일반 : 기본값
SenderName string 70 N 발신자명
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
success unction - Y 성공에 대한 콜백 함수
error unction - Y 실패에 대한 콜백 함수
Return

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

Throws

PopbillException

2.4. SendLMS_multi - 장문 전송 (동보/대량전송)

  • 최대 2,000byte의 장문(LMS) 메시지 다수건 전송을 팝빌에 접수합니다. (최대 1,000건)
  • 모든 수신자에게 동일한 내용을 전송하거나(동보전송), 수신자마다 개별 내용을 전송할 수 있습니다(대량전송).
messageService.sendLMS_multi(CorpNum, Sender, Subject, Contents, Messages, reserveDT, adsYN, requestNum, success, error)
발신번호 등록
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
Sender string 20 N 발신번호
동보전송 경우 사용
Subject string 40 N 메시지 제목
동보전송 경우 사용
기본값 : 팝빌에서 설정한 제목 사용
Contents string 2000 조건부 메시지 내용
동보전송 경우 필수
한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte
Messages Message[ ] Y 전송정보
최대 : 1,000개
reserveDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
adsYN boolean - N 광고메시지 전송여부
true광고
false일반 : 기본값
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

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

Throws

PopbillException

2.5. SendMMS - 포토문자 전송

  • 최대 2,000byte의 메시지와 이미지로 구성된 포토문자(MMS) 1건 전송을 팝빌에 접수합니다.

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

messageService.sendMMS(CorpNum, Sender, Receiver, ReceiverName, Subject, Contents, FilePaths, reserveDT, adsYN, requestNum, success, error)
발신번호 등록
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
Sender string 20 Y 발신번호
Receiver string 20 Y 수신번호
ReceiverName string 70 N 수신자명
Subject string 40 N 메시지 제목
기본값 : 팝빌에서 설정한 제목 사용
Contents string 2000 Y 메시지 내용
한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte
FilePaths object 1 Y 전송할 이미지 파일 경로
reserveDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
adsYN boolean - N 광고메시지 전송여부
true광고
false일반 : 기본값
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

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

Throws

PopbillException

2.6. SendMMS_multi - 포토문자 전송 (동보/대량전송)

  • 최대 2,000byte의 메시지와 이미지로 구성된 포토문자(MMS) 다수건 전송을 팝빌에 접수합니다. (최대 1,000건)

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

  • 모든 수신자에게 동일한 내용을 전송하거나(동보전송), 수신자마다 개별 내용을 전송할 수 있습니다(대량전송).
messageService.sendMMS_multi(CorpNum, Sender, Subject, Contents, Messages, FilePaths, reserveDT, adsYN, requestNum, success, error)
발신번호 등록
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
Sender string 20 Y 발신번호
동보전송 경우 사용
Subject string 40 N 메시지 제목
동보전송 경우 사용
기본값 : 팝빌에서 설정한 제목 사용
Contents string 2000 조건부 메시지 내용
동보전송 경우 필수
한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte
Messages Message[ ] Y 전송정보
최대 : 1,000개
FilePaths object 1 Y 전송할 이미지 파일 경로
reserveDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
adsYN boolean - N 광고메시지 전송여부
true광고
false일반 : 기본값
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

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

Throws

PopbillException

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

  • 메시지 길이(90byte)에 따라 단문/장문(SMS/LMS)을 자동으로 인식하여 1건의 메시지를 전송을 팝빌에 접수합니다.
messageService.sendXMS(CorpNum, Sender, Receiver, ReceiverName, Subject, Contents, reserveDT, adsYN, SenderName, requestNum, success, error)
발신번호 등록
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
Sender string 20 Y 발신번호
Receiver string 20 Y 수신번호
ReceiverName string 70 N 수신자명
Subject string 40 N 메시지 제목
기본값 : 팝빌에서 설정한 제목 사용
Contents string 2000 Y 메시지 내용
한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte
reserveDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
adsYN boolean - N 광고메시지 전송여부
true광고
false일반 : 기본값
senderName string 70 N 발신자명
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

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

Throws

PopbillException

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

  • 메시지 길이(90byte)에 따라 단문/장문(SMS/LMS)을 자동으로 인식하여 다수건의 메시지 전송을 팝빌에 접수합니다. (최대 1,000건)
  • 모든 수신자에게 동일한 내용을 전송하거나(동보전송), 수신자마다 개별 내용을 전송할 수 있습니다(대량전송).
messageService.sendXMS_multi(CorpNum, Sender, Subject, Contents, Messages, reserveDT, adsYN, requestNum, success, error)
발신번호 등록
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
Sender string 20 Y 발신번호
동보전송 경우 사용
Subject string 40 N 메시지 제목
동보전송 경우 사용
Contents string 2000 조건부 메시지 내용
동보전송 경우 필수
한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte
Messages Message[ ] Y 전송정보
최대 : 1,000개
reserveDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
adsYN boolean - N 광고메시지 전송여부
true광고
false일반 : 기본값
RequestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

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

Throws

PopbillException

2.9. CancelReserve - 예약전송 전체 취소

  • 팝빌에서 반환받은 접수번호로 예약된 문자를 전송 취소합니다. (예약시간 10분 전까지 가능)
messageService.cancelReserve(CorpNum, ReceiptNum, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
ReceiptNum string 18 Y 예약문자 전송요청시 팝빌로부터 반환 받은 접수번호
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException

2.10. CancelReservebyRCV - 예약전송 부분 취소

  • 팝빌에서 반환받은 접수번호로 접수 건을 식별하여 수신번호에 예약된 문자를 전송 취소합니다. (예약시간 10분 전까지 가능)
messageService.cancelReservebyRCV(CorpNum, ReceiptNum, ReceiveNum, UserId, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
ReceiptNum string 18 Y 예약문자 전송요청시 팝빌로부터 반환 받은 접수번호
ReceiveNum string 20 Y 예약문자 전송요청시 팝빌로 요청한 수신번호
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException

2.11. CancelReserveRN - 예약전송 전체 취소 (요청번호)

  • 파트너가 할당한 요청번호로 예약된 문자를 전송 취소합니다. (예약시간 10분 전까지 가능)
messageService.cancelReserveRN(CorpNum, RequestNum, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
RequestNum string 36 Y 예약문자 전송요청시 파트너가 할당한 요청번호
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException

2.12. CancelReserveRNbyRCV - 예약전송 부분 취소 (요청번호)

  • 파트너가 할당한 요청번호로 접수 건을 식별하여 수신번호에 예약된 문자를 전송 취소합니다. (예약시간 10분 전까지 가능)
messageService.cancelReserveRNbyRCV(CorpNum, RequestNum, ReceiveNum, UserId, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
RequestNum string 36 Y 예약문자 전송요청시 파트너가 할당한 요청번호
ReceiveNum string 20 Y 예약문자 전송요청시 팝빌로 요청한 수신번호
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException