POPBill Developers
연동신청
  • 가이드 0
  • 레퍼런스 0
  • 오류코드 0
카카오톡
  • 전자세금계산서
  • 현금영수증
  • 전자명세서
  • 홈택스수집(세금)
  • 홈택스수집(현금)
  • 사업자등록상태조회
  • 기업정보조회
  • 계좌조회
  • 예금주조회
  • 카카오톡
  • 문자
  • 팩스
.NET Core
  • Java
  • PHP
  • .NET
  • .NET Core
  • Node.js
  • Python
  • Ruby
  • ASP
  • Delphi
  • PowerBuilder
  • Visual Basic
  • MS Access
SDK 레퍼런스

알림톡

1. GetATSTemplateMgtURL - 템플릿 등록 팝업 URL

string GetATSTemplateMgtURL(string CorpNum, string UserID)
요청
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
UserID string 50 N 팝빌회원 아이디
응답

string - 요청에 대한 응답 URL

예외
PopbillException

2. GetATSTemplate - 템플릿 정보 확인

  • 알림톡 템플릿 정보를 확인합니다.
ATSTemplate GetATSTemplate(string CorpNum, string templateCode, string UserID = null)
요청
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
templateCode string 12 Y 템플릿 코드
UserID string 50 N 팝빌회원 아이디
응답
ATSTemplate
예외
PopbillException

3. ListATSTemplate - 템플릿 목록 확인

  • 승인된 알림톡 템플릿 목록을 확인합니다.
List<ATSTemplate> ListATSTemplate(string CorpNum, string UserID = null)
요청
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
UserID string 50 N 팝빌회원 아이디
응답
List<ATSTemplate>
예외
PopbillException

4. SendATS - 단건전송

  • 승인된 템플릿의 내용을 작성하여 1건의 알림톡 전송을 팝빌에 접수합니다.
  • 전송실패시 사전에 지정한 변수 'altSendType' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
  • 승인된 템플릿과 일치하지 않는 내용(알림톡 내용, 버튼 목록)을 입력하는 경우 '전송실패' 처리됩니다.
  • 팝빌 서비스의 안정적인 제공을 위하여 동시호출이 제한될 수 있습니다.
    동시에 1,000건 이상 요청하는 경우 동보전송 또는 대량전송으로 이용하시는 것을 권장합니다.
string SendATS(string CorpNum, string templateCode, string snd, string receiveNum, string receiveName, string msg, string altmsg = null, string altSendType = null, DateTime? sndDT = null, string requestNum = null, List<KakaoButton> buttons = null, string altSubject = null, string emphasizeTitle = null, string UserID = null)
요청
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
templateCode string 12 Y 승인된 알림톡 템플릿 코드
snd string 20 조건부 발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
receiveNum string 20 Y 수신번호
receiveName string 70 N 수신자명
msg string 1000 Y 알림톡 내용 (템플릿 내용의 변수 치환 필요)
최대 : 1,000자
- 템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다.
- 작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다.
altMsg string 2000 N 대체문자 내용
메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송
altSendType string 1 N 대체문자 유형
C알림톡 내용 전송
A대체문자 내용 전송
기본값 : 미전송
sndDT DateTime? 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
buttons List<KakaoButton> N 버튼 목록
버튼링크를 변경해야할 경우 사용
최대 : 5개
기본값 : 승인된 템플릿의 버튼 목록
altSubject string 40 N 대체문자 제목
메시지 길이가 90byte 이상인 경우에만 적용
emphasizeTitle string 50 N 강조표기 타이틀
알림톡 템플릿 유형이 '강조표기형' 인 경우에만 적용
- 템플릿 예시 : 주문하신 #{상품}이 도착했습니다.
- 작성 예시 : 주문하신 노트북이 도착했습니다.
기본값 : 승인된 템플릿의 강조표기 타이틀
UserID string 50 N 팝빌회원 아이디
응답

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

예외
PopbillException

5. SendATS - 대량전송

  • 승인된 템플릿의 내용을 작성하여 다수건의 알림톡 전송을 팝빌에 접수하며, 수신자 별로 개별 내용을 전송합니다. (최대 1,000건)
  • 전송실패시 사전에 지정한 변수 'altSendType' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
  • 승인된 템플릿과 일치하지 않는 내용(알림톡 내용, 버튼 목록)을 입력하는 경우 '전송실패' 처리됩니다.
string SendATS(string CorpNum, string templateCode, string snd, List<KakaoReceiver> receivers, string altSendType = null, DateTime? sndDT = null, string requestNum = null, List<KakaoButton> buttons = null, string UserID = null)
요청
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
templateCode string 12 Y 승인된 알림톡 템플릿 코드
snd string 20 조건부 발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
receivers List<KakaoReceiver> Y 전송정보
최대 : 1,000개
altSendType string 1 N 대체문자 유형
C알림톡 내용 전송
A대체문자 내용 전송
기본값 : 미전송
sndDT DateTime? 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
buttons List<KakaoButton> N 버튼 목록
수신자마다 동일한 버튼을 사용하는 경우 사용
버튼링크를 변경해야할 경우 사용
최대 : 5개
기본값 : 승인된 템플릿의 버튼 목록
UserID string 50 N 팝빌회원 아이디
응답

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

예외
PopbillException

6. SendATS - 동보전송

  • 승인된 템플릿 내용을 작성하여 다수건의 알림톡 전송을 팝빌에 접수하며, 모든 수신자에게 동일 내용을 전송합니다. (최대 1,000건)
  • 전송실패시 사전에 지정한 변수 'altSendType' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
  • 승인된 템플릿과 일치하지 않는 내용(알림톡 내용, 버튼 목록)을 입력하는 경우 '전송실패' 처리됩니다.
string SendATS(string CorpNum, string templateCode, string snd, string content, string altContent, List<KakaoReceiver> receivers, string altSendType = null, DateTime? sndDT = null, string requestNum = null, List<KakaoButton> buttons = null, string altSubject = null, string emphasizeTitle = null, string UserID = null)
요청
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
templateCode string 12 Y 승인된 알림톡 템플릿 코드
snd string 20 조건부 발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
content string 1000 Y 알림톡 내용 (템플릿 내용의 변수 치환 필요)
최대 : 1,000자
- 템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다.
- 작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다.
altContent string 2000 N 대체문자 내용
메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송
receivers List<KakaoReceiver> Y 전송정보
최대 : 1,000개
altSendType string 1 N 대체문자 유형
C알림톡 내용 전송
A대체문자 내용 전송
기본값 : 미전송
sndDT DateTime? 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
buttons List<KakaoButton> N 버튼 목록
버튼링크를 변경해야할 경우 사용
최대 : 5개
기본값 : 승인된 템플릿의 버튼 목록
altSubject string 40 N 대체문자 제목
메시지 길이가 90byte 이상인 경우에만 적용
emphasizeTitle string 50 N 강조표기 타이틀
알림톡 템플릿 유형이 '강조표기형' 인 경우에만 적용
- 템플릿 예시 : 주문하신 #{상품}이 도착했습니다.
- 작성 예시 : 주문하신 노트북이 도착했습니다.
기본값 : 승인된 템플릿의 강조표기 타이틀
UserID string 50 N 팝빌회원 아이디
응답

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

예외
PopbillException

7. CancelReserve - 예약전송 취소 (접수번호)

  • 팝빌에서 반환받은 접수번호로 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
Response CancelReserve(string CorpNum, string receiptNum, string UserID = null)
요청
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
receiptNum string 18 Y 팝빌에서 할당한 접수번호
카카오톡 예약전송 요청의 반환값
UserID string 50 N 팝빌회원 아이디
응답
Response
예외
PopbillException

8. CancelReservebyRCV - 예약전송 부분 취소 (접수번호)

  • 팝빌에서 반환받은 접수번호로 접수 건을 식별하여 수신번호에 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
Response CancelReservebyRCV(string CorpNum, string receiptNum, string receiveNum, string UserID = null)
요청
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
receiptNum string 18 Y 팝빌에서 할당한 접수번호
카카오톡 예약전송 요청의 반환값
receiveNum string 20 Y 예약전송 수신번호
UserID string 50 N 팝빌회원 아이디
응답
Response
예외
PopbillException

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

  • 파트너가 할당한 요청번호로 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
Response CancelReserveRN(string CorpNum, string requestNum, string UserID = null)
요청
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
requestNum string 36 Y 파트너가 할당한 요청번호
UserID string 50 N 팝빌회원 아이디
응답
Response
예외
PopbillException

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

  • 파트너가 할당한 요청번호로 접수 건을 식별하여 수신번호에 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
Response CancelReserveRNbyRCV(string CorpNum, string requestNum, string receiveNum, string UserID = null)
요청
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
requestNum string 36 Y 파트너가 할당한 요청번호
receiveNum string 20 Y 예약전송 수신번호
UserID string 50 N 팝빌회원 아이디
응답
Response
예외
PopbillException