알림톡 전송

1. SendATS - 단건전송

승인된 템플릿의 내용을 작성하여 1건의 알림톡 전송을 팝빌에 접수합니다.

• 전송실패시 사전에 지정한 변수 ‘AltSendType’ 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
• 승인된 템플릿과 일치하지 않는 내용(알림톡 내용, 버튼 목록)을 입력하는 경우 ‘전송실패’ 처리됩니다.
• 팝빌 서비스의 안정적인 제공을 위하여 동시호출이 제한될 수 있습니다.
  동시에 1,000건 이상 요청하는 경우 동보전송 또는 대량전송으로 이용하시는 것을 권장합니다.

def sendATS(CorpNum, TemplateCode, Sender, Content, AltContent, AltSendType, SndDT, Receiver, ReceiverName, UserID=None, RequestNum=None, ButtonList=None, AltSubject=None, EmphasizeTitle=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	TemplateCode	str	12	Y	승인된 알림톡 템플릿 코드
3	Sender	str	20	조건부	발신번호 → 대체문자 전송시 필수 팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
4	Content	str	1,300	Y	알림톡 내용 (템플릿 내용의 변수 치환 필요) → 템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다. 작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다.
5	AltContent	str	2,000	N	대체문자 내용 → 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송
6	AltSendType	str	1	N	대체문자 유형 C 알림톡 내용 전송 A 대체문자 내용 전송 ※ 기본값 : 미전송
7	SndDT	str	14	N	전송 예약일시 → 형식 : yyyyMMddHHmmss ※ 기본값 : 즉시전송
8	Receiver	str	20	Y	수신번호
9	ReceiverName	str	70	N	수신자명
10	UserID	str	50	N	팝빌회원 아이디
11	RequestNum	str	36	N	요청번호 → 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
12	ButtonList	KakaoButton[ ]	5	N	버튼 목록 → 버튼링크를 변경해야할 경우 사용 ※ 기본값 : 승인된 템플릿의 버튼 목록
KakaoButton[ ] 순번 변수명 타입 길이 필수 설명 1 n str 14 Y 버튼명 2 t str 2 Y 버튼유형 WL 웹링크 AL 앱링크 TN 전화걸기 DS 배송조회 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 str 1,000 조건부 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 → {t} = "WL" or "AL" 경우 필수 4 u2 str 1,000 조건부 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 → {t} = "WL" or "AL" 경우 필수 5 tg str 3 N 아웃 링크 out 디바이스 기본 브라우저 ※ 기본값 : 카카오톡 인앱 브라우저 사용 6 telNum str 14 조건부 전화걸기 번호 → 숫자, 하이픈(-)만 입력 가능 → {t} = "TN" 경우 필수
13	AltSubject	str	64	N	대체문자 제목 → 대체문자 내용이 90byte 초과한 경우에만 적용 단위 : byte
14	EmphasizeTitle	str	50	N	강조표기 타이틀 → 알림톡 템플릿 유형이 '강조표기형' 인 경우에만 적용 템플릿 예시 : 주문하신 #{상품}이 도착했습니다. 작성 예시 : 주문하신 노트북이 도착했습니다. ※ 기본값 : 승인된 템플릿의 강조표기 타이틀

응답

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

예외

PopbillException

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

2. SendATS_multi - 대량전송

승인된 템플릿의 내용을 작성하여 다수건의 알림톡 전송을 팝빌에 접수하며, 수신자 별로 개별 내용을 전송합니다. (최대 1,000건)

• 전송실패시 사전에 지정한 변수 ‘AltSendType’ 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
• 승인된 템플릿과 일치하지 않는 내용(알림톡 내용, 버튼 목록)을 입력하는 경우 ‘전송실패’ 처리됩니다.

def sendATS_multi(CorpNum, TemplateCode, Sender, Content, AltContent, AltSendType, SndDT, KakaoMessages, UserID=None, RequestNum=None, ButtonList=None, AtlSubject=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	TemplateCode	str	12	Y	승인된 알림톡 템플릿 코드
3	Sender	str	20	조건부	발신번호 → 대체문자 전송시 필수 팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
4	Content	str	1,300	N	알림톡 내용 (템플릿 내용의 변수 치환 필요) → 수신자마다 동일한 알림톡 내용을 전송하는 경우 사용 템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다. 작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다.
5	AltContent	str	2,000	N	대체문자 내용 → 수신자마다 동일한 대체문자 내용을 전송하는 경우 사용 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송
6	AltSendType	str	1	N	대체문자 유형 C 알림톡 내용 전송 A 대체문자 내용 전송 ※ 기본값 : 미전송
7	SndDT	str	14	N	전송 예약일시 → 형식 : yyyyMMddHHmmss ※ 기본값 : 즉시전송
8	KakaoMessages	KakaoReceiver[ ]	1,000	Y	전송정보
KakaoReceiver[ ] 순번 변수명 타입 길이 필수 설명 1 rcv str 20 Y 수신번호 2 rcvnm str 70 N 수신자명 3 msg str 1,300 조건부 알림톡 내용 (템플릿 내용의 변수 치환 필요) → 대량전송 경우 필수 템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다. 작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다. 4 altsjt str 64 N 대체문자 제목 → 대량전송 경우 사용 메시지 길이가 90byte 초과한 경우에만 적용 단위 : byte 5 altmsg str 2,000 조건부 대체문자 내용 → 대량전송 경우 사용 6 btns KakaoButton[ ] 5 N 버튼 목록 → 대량전송 경우 사용 KakaoButton[ ] 순번 변수명 타입 길이 필수 설명 1 n str 14 Y 버튼명 2 t str 2 Y 버튼유형 WL 웹링크 AL 앱링크 TN 전화걸기 DS 배송조회 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 str 1,000 조건부 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 → {t} = "WL" or "AL" 경우 필수 4 u2 str 1,000 조건부 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 → {t} = "WL" or "AL" 경우 필수 5 tg str 3 N 아웃 링크 out 디바이스 기본 브라우저 ※ 기본값 : 카카오톡 인앱 브라우저 사용 6 telNum str 14 조건부 전화걸기 번호 → 숫자, 하이픈(-)만 입력 가능 → {t} = "TN" 경우 필수 7 interOPRefKey str 20 N 파트너 지정키 → 카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값 8 emphasizeTitle str 50 N 강조표기 타이틀 → 알림톡 템플릿 유형이 '강조표기형' 인 경우에만 적용 템플릿 예시 : 주문하신 #{상품}이 도착했습니다. 작성 예시 : 주문하신 노트북이 도착했습니다. ※ 기본값 : 승인된 템플릿의 강조표기 타이틀
9	UserID	str	50	N	팝빌회원 아이디
10	RequestNum	str	36	N	요청번호 → 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
11	ButtonList	KakaoButton[ ]	5	N	버튼 목록 → 수신자마다 동일한 버튼을 사용하는 경우 사용 버튼링크를 변경해야할 경우 사용 ※ 기본값 : 승인된 템플릿의 버튼 목록
KakaoButton[ ] 순번 변수명 타입 길이 필수 설명 1 n str 14 Y 버튼명 2 t str 2 Y 버튼유형 WL 웹링크 AL 앱링크 TN 전화걸기 DS 배송조회 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 str 1,000 조건부 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 → {t} = "WL" or "AL" 경우 필수 4 u2 str 1,000 조건부 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 → {t} = "WL" or "AL" 경우 필수 5 tg str 3 N 아웃 링크 out 디바이스 기본 브라우저 ※ 기본값 : 카카오톡 인앱 브라우저 사용 6 telNum str 14 조건부 전화걸기 번호 → 숫자, 하이픈(-)만 입력 가능 → {t} = "TN" 경우 필수
12	AltSubject	str	64	N	대체문자 제목 → 수신자마다 동일한 대체문자 제목을 전송하는 경우 사용 메시지 길이가 90byte 초과한 경우에만 적용 단위 : byte

응답

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

예외

PopbillException

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

3. SendATS_same - 동보전송

승인된 템플릿 내용을 작성하여 다수건의 알림톡 전송을 팝빌에 접수하며, 모든 수신자에게 동일 내용을 전송합니다. (최대 1,000건)

• 전송실패시 사전에 지정한 변수 ‘AltSendType’ 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
• 승인된 템플릿과 일치하지 않는 내용(알림톡 내용, 버튼 목록)을 입력하는 경우 ‘전송실패’ 처리됩니다.

def sendATS_same(CorpNum, TemplateCode, Sender, Content, AltContent, AltSendType, SndDT, KakaoMessages, UserID=None, RequestNum=None, ButtonList=None, AltSubject=None, EmphasizeTitle=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	TemplateCode	str	12	Y	승인된 알림톡 템플릿 코드
3	Sender	str	20	조건부	발신번호 → 대체문자 전송시 필수 팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
4	Content	str	1,300	Y	알림톡 내용 (템플릿 내용의 변수 치환 필요) → 템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다. 작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다.
5	AltContent	str	2,000	N	대체문자 내용 → 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송
6	AltSendType	str	1	N	대체문자 유형 C 알림톡 내용 전송 A 대체문자 내용 전송 ※ 기본값 : 미전송
7	SndDT	str	14	N	전송 예약일시 → 형식 : yyyyMMddHHmmss ※ 기본값 : 즉시전송
8	KakaoMessages	KakaoReceiver[ ]	1,000	Y	전송정보
KakaoReceiver[ ] 순번 변수명 타입 길이 필수 설명 1 rcv str 20 Y 수신번호 2 rcvnm str 70 N 수신자명 3 msg str 1,300 조건부 알림톡 내용 (템플릿 내용의 변수 치환 필요) → 대량전송 경우 필수 템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다. 작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다. 4 altsjt str 64 N 대체문자 제목 → 대량전송 경우 사용 메시지 길이가 90byte 초과한 경우에만 적용 단위 : byte 5 altmsg str 2,000 조건부 대체문자 내용 → 대량전송 경우 사용 6 btns KakaoButton[ ] 5 N 버튼 목록 → 대량전송 경우 사용 KakaoButton[ ] 순번 변수명 타입 길이 필수 설명 1 n str 14 Y 버튼명 2 t str 2 Y 버튼유형 WL 웹링크 AL 앱링크 TN 전화걸기 DS 배송조회 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 str 1,000 조건부 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 → {t} = "WL" or "AL" 경우 필수 4 u2 str 1,000 조건부 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 → {t} = "WL" or "AL" 경우 필수 5 tg str 3 N 아웃 링크 out 디바이스 기본 브라우저 ※ 기본값 : 카카오톡 인앱 브라우저 사용 6 telNum str 14 조건부 전화걸기 번호 → 숫자, 하이픈(-)만 입력 가능 → {t} = "TN" 경우 필수 7 interOPRefKey str 20 N 파트너 지정키 → 카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값 8 emphasizeTitle str 50 N 강조표기 타이틀 → 알림톡 템플릿 유형이 '강조표기형' 인 경우에만 적용 템플릿 예시 : 주문하신 #{상품}이 도착했습니다. 작성 예시 : 주문하신 노트북이 도착했습니다. ※ 기본값 : 승인된 템플릿의 강조표기 타이틀
9	UserID	str	50	N	팝빌회원 아이디
10	RequestNum	str	36	N	요청번호 → 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
11	ButtonList	KakaoButton[ ]	5	N	버튼 목록 → 버튼링크를 변경해야할 경우 사용 ※ 기본값 : 승인된 템플릿의 버튼 목록
KakaoButton[ ] 순번 변수명 타입 길이 필수 설명 1 n str 14 Y 버튼명 2 t str 2 Y 버튼유형 WL 웹링크 AL 앱링크 TN 전화걸기 DS 배송조회 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 str 1,000 조건부 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 → {t} = "WL" or "AL" 경우 필수 4 u2 str 1,000 조건부 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 → {t} = "WL" or "AL" 경우 필수 5 tg str 3 N 아웃 링크 out 디바이스 기본 브라우저 ※ 기본값 : 카카오톡 인앱 브라우저 사용 6 telNum str 14 조건부 전화걸기 번호 → 숫자, 하이픈(-)만 입력 가능 → {t} = "TN" 경우 필수
12	AltSubject	str	64	N	대체문자 제목 → 대체문자 내용이 90byte 초과한 경우에만 적용 단위 : byte
13	EmphasizeTitle	str	50	N	강조표기 타이틀 → 알림톡 템플릿 유형이 '강조표기형' 인 경우에만 적용 템플릿 예시 : 주문하신 #{상품}이 도착했습니다. 작성 예시 : 주문하신 노트북이 도착했습니다. ※ 기본값 : 승인된 템플릿의 강조표기 타이틀

응답

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

예외

PopbillException

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

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

팝빌에서 반환받은 접수번호로 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)

def cancelReserve(CorpNum, ReceiptNum, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ReceiptNum	str	18	Y	팝빌에서 할당한 접수번호 → 카카오톡 예약전송 요청의 반환값
3	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. CancelReservebyRCV - 예약전송 부분 취소 (접수번호)

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

def cancelReservebyRCV(CorpNum, ReceiptNum, ReceiveNum, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ReceiptNum	str	18	Y	팝빌에서 할당한 접수번호 → 카카오톡 예약전송 요청의 반환값
3	ReceiveNum	str	20	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 처리 실패에 대한 오류메시지

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

파트너가 할당한 요청번호로 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)

def cancelReserveRN(CorpNum, RequestNum, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	RequestNum	str	36	Y	파트너가 할당한 요청번호
3	UserID	str	50	N	팝빌회원 아이디

응답

Response

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

예외

PopbillException

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

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

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

def cancelReserveRNbyRCV(CorpNum, RequestNum, ReceiveNum, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	RequestNum	str	36	Y	파트너가 할당한 요청번호
3	ReceiveNum	str	20	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 처리 실패에 대한 오류메시지