알림톡 전송

1. SendATS_one - 단건전송

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

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

def sendATS_one(corpNum, templateCode, snd, content, altContent, altSendType, sndDT, receiver, receiverName, requestNum = '', userID = '', btns = '')

요청

Parameters

순번 변수명 타입 길이 필수 설명

corpNum

String

팝빌회원 사업자번호 ('-' 제외)

templateCode

String

승인된 알림톡 템플릿 코드

snd

String

조건부

발신번호

대체문자 전송시 필수

팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환

content

String

1,300

알림톡 내용 (템플릿 내용의 변수 치환 필요)

템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다.

작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다.

altContent

String

2,000

대체문자 내용

메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송

altSendType

String

대체문자 유형

C 알림톡 내용 전송
A 대체문자 내용 전송

기본값 : 미전송

sndDT

String

전송 예약일시

형식 : yyyyMMddHHmmss

기본값 : 즉시전송

requestNum

String

요청번호

파트너가 접수 단위를 식별하기 위해 할당하는 관리번호

영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

userID

String

팝빌회원 아이디

btns

버튼 목록

버튼링크를 변경해야할 경우 사용

기본값 : 승인된 템플릿의 버튼 목록

KakaoButton[ ]

순번	변수명	타입	길이	필수	설명
1	`n`	String	14	Y	버튼명
2	`t`	String	2	Y	버튼유형 `WL` 웹링크 `AL` 앱링크 `DS` 배송조회 `MD` 메시지전달 `BK` 봇키워드 `AC` 채널추가
3	`u1`	String	1,000	조건부	버튼링크 {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 {t} = "WL" or "AL" 경우 필수
4	`u2`	String	1,000	조건부	버튼링크 {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 {t} = "WL" or "AL" 경우 필수

응답

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

예외

PopbillException

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

2. SendATS_multi - 대량전송

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

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

def sendATS_multi(corpNum, templateCode, snd, altSendType, sndDT, msgs, requestNum = '', userID = '', btns = '')

요청

Parameters

순번 변수명 타입 길이 필수 설명

corpNum

String

팝빌회원 사업자번호 ('-' 제외)

templateCode

String

승인된 알림톡 템플릿 코드

snd

String

조건부

발신번호

대체문자 전송시 필수

팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환

altSendType

String

대체문자 유형

C 알림톡 내용 전송
A 대체문자 내용 전송

기본값 : 미전송

sndDT

String

전송 예약일시

형식 : yyyyMMddHHmmss

기본값 : 즉시전송

msgs

1,000

전송정보

KakaoReceiver[ ]

순번 변수명 타입 길이 필수 설명

receiverNum

String

수신번호

receiverName

String

수신자명

message

String

1,300

조건부

알림톡 내용 (템플릿 내용의 변수 치환 필요)

대량전송 경우 필수

템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다.

작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다.

altMessage

String

2,000

대체문자 내용

대량전송 경우 사용

btns

버튼 목록

대량전송 경우 사용

KakaoButton[ ]

순번	변수명	타입	길이	필수	설명
1	`n`	String	14	Y	버튼명
2	`t`	String	2	Y	버튼유형 `WL` 웹링크 `AL` 앱링크 `DS` 배송조회 `MD` 메시지전달 `BK` 봇키워드 `AC` 채널추가
3	`u1`	String	1,000	조건부	버튼링크 {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 {t} = "WL" or "AL" 경우 필수
4	`u2`	String	1,000	조건부	버튼링크 {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 {t} = "WL" or "AL" 경우 필수

interOPRefKey

String

파트너 지정키

카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

requestNum

String

요청번호

파트너가 접수 단위를 식별하기 위해 할당하는 관리번호

영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

userID

String

팝빌회원 아이디

btns

버튼 목록

수신자마다 동일한 버튼을 사용하는 경우 사용

버튼링크를 변경해야할 경우 사용

기본값 : 승인된 템플릿의 버튼 목록

KakaoButton[ ]

순번	변수명	타입	길이	필수	설명
1	`n`	String	14	Y	버튼명
2	`t`	String	2	Y	버튼유형 `WL` 웹링크 `AL` 앱링크 `DS` 배송조회 `MD` 메시지전달 `BK` 봇키워드 `AC` 채널추가
3	`u1`	String	1,000	조건부	버튼링크 {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 {t} = "WL" or "AL" 경우 필수
4	`u2`	String	1,000	조건부	버튼링크 {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 {t} = "WL" or "AL" 경우 필수

응답

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

예외

PopbillException

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

3. SendATS_same - 동보전송

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

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

def sendATS_same(corpNum, templateCode, snd, content, altContent, altSendType, sndDT, msgs, requestNum = '', userID = '', btns = '')

요청

Parameters

순번 변수명 타입 길이 필수 설명

corpNum

String

팝빌회원 사업자번호 ('-' 제외)

templateCode

String

승인된 알림톡 템플릿 코드

snd

String

조건부

발신번호

대체문자 전송시 필수

팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환

content

String

1,300

알림톡 내용 (템플릿 내용의 변수 치환 필요)

템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다.

작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다.

altContent

String

2,000

대체문자 내용

메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송

altSendType

String

대체문자 유형

C 알림톡 내용 전송
A 대체문자 내용 전송

기본값 : 미전송

sndDT

String

전송 예약일시

형식 : yyyyMMddHHmmss

기본값 : 즉시전송

msgs

1,000

전송정보

최대 : 1,000개

KakaoReceiver[ ]

순번 변수명 타입 길이 필수 설명

receiverNum

String

수신번호

receiverName

String

수신자명

message

String

1,300

조건부

알림톡 내용 (템플릿 내용의 변수 치환 필요)

대량전송 경우 필수

템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다.

작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다.

altMessage

String

2,000

대체문자 내용

대량전송 경우 사용

btns

버튼 목록

대량전송 경우 사용

KakaoButton[ ]

순번	변수명	타입	길이	필수	설명
1	`n`	String	14	Y	버튼명
2	`t`	String	2	Y	버튼유형 `WL` 웹링크 `AL` 앱링크 `DS` 배송조회 `MD` 메시지전달 `BK` 봇키워드 `AC` 채널추가
3	`u1`	String	1,000	조건부	버튼링크 {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 {t} = "WL" or "AL" 경우 필수
4	`u2`	String	1,000	조건부	버튼링크 {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 {t} = "WL" or "AL" 경우 필수

interOPRefKey

String

파트너 지정키

카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

requestNum

String

요청번호

파트너가 접수 단위를 식별하기 위해 할당하는 관리번호

영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

userID

String

팝빌회원 아이디

btns

버튼 목록

버튼링크를 변경해야할 경우 사용

기본값 : 승인된 템플릿의 버튼 목록

KakaoButton[ ]

순번	변수명	타입	길이	필수	설명
1	`n`	String	14	Y	버튼명
2	`t`	String	2	Y	버튼유형 `WL` 웹링크 `AL` 앱링크 `DS` 배송조회 `MD` 메시지전달 `BK` 봇키워드 `AC` 채널추가
3	`u1`	String	1,000	조건부	버튼링크 {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 {t} = "WL" or "AL" 경우 필수
4	`u2`	String	1,000	조건부	버튼링크 {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 {t} = "WL" or "AL" 경우 필수

응답

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

예외

PopbillException

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

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

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

def cancelReserve(corpNum, receiptNum, userID = '')

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`corpNum`	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	`receiptNum`	String	18	Y	팝빌에서 할당한 접수번호 카카오톡 예약전송 요청의 반환값
3	`userID`	String	50	N	팝빌회원 아이디

응답

Response

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

예외

PopbillException

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

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

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

def cancelReserveRN(corpNum, requestNum, userID = '')

요청

Parameters

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

응답

Response

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

예외

PopbillException

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