POPBill Developers
API Reference

4. 카카오톡 전송

4.1. SendATS_one - 알림톡 단건전송

  • 승인된 템플릿의 내용을 작성하여 1건의 알림톡 전송을 팝빌에 접수합니다.
  • 전송실패시 사전에 지정한 변수 'altSendType' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
  • 승인된 템플릿과 일치하지 않는 내용(알림톡 내용, 버튼 목록)을 입력하는 경우 '전송실패' 처리됩니다.
kakaoService.sendATS_one(CorpNum, templateCode, snd, content, altSubject, altContent, altSendType, sndDT, receiver, receiverName, UserID, requestNum, btns, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
templateCode string 12 Y 승인된 알림톡 템플릿 코드
snd string 20 조건부 발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
content string 1000 Y 알림톡 내용
최대 : 1,000자
altSubject string 40 N 대체문자 제목
메시지 길이가 90byte 이상인 경우에만 적용
altContent string 2000 N 대체문자 내용
메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송
altSendType string 1 N 대체문자 유형
C알림톡 내용 전송
A대체문자 내용 전송
기본값 : 미전송
sndDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
receiver string 20 Y 수신번호
receiverName string 70 N 수신자명
UserID string 50 N 팝빌회원 아이디
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
btns KakaoButton[ ] N 버튼 목록
버튼링크를 변경해야할 경우 사용
최대 : 5개
기본값 : 승인된 템플릿의 버튼 목록
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

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

Throws

PopbillException

4.2. SendATS_multi - 알림톡 대량전송

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

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

Throws

PopbillException

4.3. SendATS_same - 알림톡 동보전송

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

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

Throws

PopbillException

4.4. SendFTS_one - 친구톡(텍스트) 단건전송

  • 텍스트로 구성된 1건의 친구톡 전송을 팝빌에 접수합니다.

    ※ 친구톡의 경우 야간 전송은 제한됩니다. (20:00 ~ 익일 08:00)

  • 전송실패시 사전에 지정한 변수 'altSendType' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
kakaoService.sendFTS_one(CorpNum, plusFriendID, snd, content, altSubject, altContent, altSendType, sndDT, receiver, receiverName, adsYN, btns, UserID, requestNum, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
PlusFriendID string 30 Y 카카오톡 채널 검색용 아이디
snd string 20 조건부 발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
content string 1000 Y 친구톡 내용
최대 : 1,000자
altSubject string 40 N 대체문자 제목
메시지 길이가 90byte 이상인 경우에만 적용
altContent string 2000 N 대체문자 내용
메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송
altSendType string 1 N 대체문자 유형
C친구톡 내용 전송
A대체문자 내용 전송
기본값 : 미전송
sndDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
receiver string 20 Y 수신번호
receiverName string 70 N 수신자명
adsYN boolean - N 광고성 메시지 여부
true광고
false일반 : 기본값
btns KakaoButton[ ] N 버튼 목록
최대 : 5개
UserID string 50 N 팝빌회원 아이디
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

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

Throws

PopbillException

4.5. SendFTS_multi - 친구톡(텍스트) 대량전송

  • 텍스트로 구성된 다수건의 친구톡 전송을 팝빌에 접수하며, 수신자 별로 개별 내용을 전송합니다. (최대 1,000건)

    ※ 친구톡의 경우 야간 전송은 제한됩니다. (20:00 ~ 익일 08:00)

  • 전송실패시 사전에 지정한 변수 'altSendType' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
kakaoService.sendFTS_multi(CorpNum, plusFriendID, snd, altSendType, sndDT, adsYN, msgs, btns, UserID, requestNum, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
plusFriendID string 30 Y 카카오톡 채널 검색용 아이디
snd string 20 조건부 발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
altSendType string 1 N 대체문자 유형
C친구톡 내용 전송
A대체문자 내용 전송
기본값 : 미전송
sndDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
adsYN boolean - N 광고성 메시지 여부
true광고
false일반 : 기본값
msgs KakaoReceiver[ ] Y 전송정보
최대 : 1,000개
btns KakaoButton[ ] N 버튼 목록
수신자마다 동일한 버튼을 사용하는 경우 사용
최대 : 5개
UserID string 50 N 팝빌회원 아이디
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

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

Throws

PopbillException

4.6. SendFTS_same - 친구톡(텍스트) 동보전송

  • 텍스트로 구성된 다수건의 친구톡 전송을 팝빌에 접수하며, 모든 수신자에게 동일 내용을 전송합니다. (최대 1,000건)

    ※ 친구톡의 경우 야간 전송은 제한됩니다. (20:00 ~ 익일 08:00)

  • 전송실패시 사전에 지정한 변수 'altSendType' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
kakaoService.sendFTS_same(CorpNum, plusFriendID, snd, content, altSubject, altContent, altSendType, sndDT, adsYN, msgs, btns, UserID, requestNum, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
plusFriendID string 30 Y 카카오톡 채널 검색용 아이디
snd string 20 조건부 발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
content string 1000 Y 친구톡 내용
최대 : 1,000자
altSubject string 40 N 대체문자 제목
메시지 길이가 90byte 이상인 경우에만 적용
altContent string 2000 N 대체문자 내용
메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송
altSendType string 1 N 대체문자 유형
C친구톡 내용 전송
A대체문자 내용 전송
기본값 : 미전송
sndDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
adsYN boolean - N 광고성 메시지 여부
true광고
false일반 : 기본값
msgs KakaoReceiver[ ] Y 전송정보
최대 : 1,000개
btns KakaoButton[ ] N 버튼 목록
최대 : 5개
UserID string 50 N 팝빌회원 아이디
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

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

Throws

PopbillException

4.7. SendFMS_one - 친구톡(이미지) 단건전송

  • 이미지가 첨부된 1건의 친구톡 전송을 팝빌에 접수합니다.

    ※ 친구톡의 경우 야간 전송은 제한됩니다. (20:00 ~ 익일 08:00)

  • 전송실패시 사전에 지정한 변수 'altSendType' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.

    ※ 대체문자의 경우, 포토문자(MMS) 형식은 지원하고 있지 않습니다.

kakaoService.sendFMS_one(CorpNum, plusFriendID, snd, content, altSubject, altContent, altSendType, sndDT, receiver, receiverName, adsYN, imageURL, FilePath, btns, UserID, requestNum, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
plusFriendID string 30 Y 카카오톡 채널 검색용 아이디
snd string 20 조건부 발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
content string 400 Y 친구톡 내용
최대 : 400자
altSubject string 40 N 대체문자 제목
메시지 길이가 90byte 이상인 경우에만 적용
altContent string 2000 N 대체문자 내용
메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송
altSendType string 1 N 대체문자 유형
C친구톡 내용 전송
A대체문자 내용 전송
기본값 : 미전송
sndDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
receiver string 20 Y 수신번호
receiverName string 70 N 수신자명
adsYN boolean - N 광고성 메시지 여부
true광고
false일반 : 기본값
imageURL string 256 N 이미지 링크 URL
친구톡 상단 이미지 클릭시 이동하는 URL
FilePath string[ ] - Y 이미지 파일 경로
전송 포맷 : JPG 파일 (.jpg, .jpeg)
용량 : 최대 500 KB
사이즈 : 가로 500px 이상, 가로 기준으로 세로 0.5~1.3배 비율 가능
btns KakaoButton[ ] N 버튼 목록
최대 : 5개
UserID string 50 N 팝빌회원 아이디
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

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

Throws

PopbillException

4.8. SendFMS_multi - 친구톡(이미지) 대량전송

  • 이미지가 첨부된 다수건의 친구톡 전송을 팝빌에 접수하며, 수신자 별로 개별 내용을 전송합니다. (최대 1,000건)

    ※ 친구톡의 경우 야간 전송은 제한됩니다. (20:00 ~ 익일 08:00)

  • 전송실패시 사전에 지정한 변수 'altSendType' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.

    ※ 대체문자의 경우, 포토문자(MMS) 형식은 지원하고 있지 않습니다.

kakaoService.sendFMS_multi(CorpNum, plusFriendID, snd, altSendType, sndDT, adsYN, imageURL, FilePath, msgs, btns, UserID, requestNum, success, error)
Parameters
순번변수명타입길이필수설명
corpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
plusFriendID string 30 Y 카카오톡 채널 검색용 아이디
snd string 20 조건부 발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
altSendType string 1 N 대체문자 유형
C친구톡 내용 전송
A대체문자 내용 전송
기본값 : 미전송
sndDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
adsYN boolean - N 광고성 메시지 여부
true광고
false일반 : 기본값
imageURL string 256 N 이미지 링크 URL
친구톡 상단 이미지 클릭시 이동하는 URL
FilePath string[ ] - Y 이미지 파일 경로
전송 포맷 : JPG 파일 (.jpg, .jpeg)
용량 : 최대 500 KB
사이즈 : 가로 500px 이상, 가로 기준으로 세로 0.5~1.3배 비율 가능
msgs KakaoReceiver[ ] Y 전송정보
최대 : 1,000개
btns KakaoButton[ ] N 버튼 목록
수신자마다 동일한 버튼을 사용하는 경우 사용
최대 : 5개
UserID string 50 N 팝빌회원 아이디
RequestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

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

Throws

PopbillException

4.9. SendFMS_same - 친구톡(이미지) 동보전송

  • 이미지가 첨부된 다수건의 친구톡 전송을 팝빌에 접수하며, 모든 수신자에게 동일 내용을 전송합니다. (최대 1,000건)

    ※ 친구톡의 경우 야간 전송은 제한됩니다. (20:00 ~ 익일 08:00)

  • 전송실패시 사전에 지정한 변수 'altSendType' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.

    ※ 대체문자의 경우, 포토문자(MMS) 형식은 지원하고 있지 않습니다.

kakaoService.sendFMS_same(CorpNum, plusFriendID, snd, content, altSubject, altContent, altSendType, sndDT, adsYN, imageURL, FilePath, msgs, btns, UserID, requestNum, success, error)
Parameters
순번변수명타입길이필수설명
corpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
plusFriendID string 30 Y 카카오톡 채널 검색용 아이디
snd string 20 조건부 발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
content string 400 Y 친구톡 내용
최대 : 400자
altSubject string 40 N 대체문자 제목
메시지 길이가 90byte 이상인 경우에만 적용
altContent string 2000 N 대체문자 내용
메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송
altSendType string 1 N 대체문자 유형
C친구톡 내용 전송
A대체문자 내용 전송
기본값 : 미전송
sndDT string 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
adsYN boolean - N 광고성 메시지 여부
true광고
false일반 : 기본값
imageURL string 256 N 이미지 링크 URL
친구톡 상단 이미지 클릭시 이동하는 URL
FilePath string[ ] - Y 이미지 파일 경로
전송 포맷 : JPG 파일 (.jpg, .jpeg)
용량 : 최대 500 KB
사이즈 : 가로 500px 이상, 가로 기준으로 세로 0.5~1.3배 비율 가능
msgs KakaoReceiver[ ] Y 전송정보
최대 : 1,000개
btns KakaoButton[ ] N 버튼 목록
최대 : 5개
UserID string 50 N 팝빌회원 아이디
requestNum string 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

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

Throws

PopbillException

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

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

Response

Throws

PopbillException

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

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

Response

Throws

PopbillException

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

  • 팝빌에서 반환받은 접수번호로 접수 건을 식별하여 수신번호에 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
kakaoService.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

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

  • 파트너가 할당한 요청번호로 접수 건을 식별하여 수신번호에 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
kakaoService.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