4. 카카오톡 전송

4.1. SendATS - 알림톡 전송

승인된 템플릿의 내용을 작성하여 알림톡 전송을 팝빌에 접수합니다.(최대 1,000건)
모든 수신자에게 동일한 내용을 전송하거나(동보전송), 수신자마다 개별 내용을 전송할 수 있습니다(대량전송).
전송실패시 사전에 지정한 변수 'altSendType' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
승인된 템플릿과 일치하지 않는 내용(알림톡 내용, 버튼 목록)을 입력하는 경우 '전송실패' 처리됩니다.

Function SendATS(CorpNum, templateCode, senderNum, content, altContent, altSendType, reserveDT, receiverList, requestNum, UserID, btnList, altSubject)

Parameters

변수명	타입	길이	필수	설명
CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
templateCode	String	12	Y	승인된 알림톡 템플릿 코드
senderNum	String	20	조건부	발신번호 대체문자 전송시 필수 팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
content	String	1000	조건부	알림톡 내용 (템플릿 내용의 변수 치환 필요) 단건전송, 동보전송 경우 필수 최대 : 1,000자 - 템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다. - 작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다.
altContent	String	2000	N	대체문자 내용 단건전송, 동보전송 경우 사용 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송
altSendType	String	1	N	대체문자 유형 C알림톡 내용 전송 A대체문자 내용 전송 기본값 : 미전송
reserveDT	String	14	N	전송 예약일시 형식 : yyyyMMddHHmmss 기본값 : 즉시전송
receiverList	KakaoReceiver( )		Y	전송정보 최대 : 1,000개
requestNum	String	36	N	요청번호 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
UserID	String	50	N	팝빌회원 아이디
btnList	KakaoButton( )		N	버튼 목록 단건전송, 동보전송 경우 사용 버튼링크를 변경해야할 경우 사용 최대 : 5개 기본값 : 승인된 템플릿의 버튼 목록
altSubject	String	40	N	대체문자 제목 단건전송, 동보전송 경우 사용 메시지 길이가 90byte 이상인 경우에만 적용

Return

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

Throws

Err

4.2. SendFTS - 친구톡 텍스트 전송

텍스트로 구성된 1건의 친구톡 전송을 팝빌에 접수합니다.
모든 수신자에게 동일한 내용을 전송하거나(동보전송), 수신자마다 개별 내용을 전송할 수 있습니다(대량전송). (최소 1건, 최대 1,000건)
※ 친구톡의 경우 야간 전송은 제한됩니다. (20:00 ~ 익일 08:00)
전송실패시 사전에 지정한 변수 'altSendType' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.

Function SendFTS(CorpNum, plusFriendID, snd, content, altContent, altSendType, sndDT, adsYN, receiverList, btnList, requestNum, UserID, altSubject)

Parameters

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

Return

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

Throws

Err

4.3. SendFMS - 친구톡 이미지 전송

이미지가 첨부된 친구톡 전송을 팝빌에 접수합니다.
모든 수신자에게 동일한 내용을 전송하거나(동보전송), 수신자마다 개별 내용을 전송할 수 있습니다(대량전송). (최소 1건, 최대 1,000건)
※ 친구톡의 경우 야간 전송은 제한됩니다. (20:00 ~ 익일 08:00)
전송실패시 사전에 지정한 변수 'altSendType' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
※ 대체문자의 경우, 포토문자(MMS) 형식은 지원하고 있지 않습니다.

Function SendFMS(CorpNum, plusFriendID, snd, content, altContent, altSendType, sndDT, adsYN, receiverList, btnList, filePath, imageURL, requestNum, UserID, altSubject)

Parameters

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

Return

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

Throws

Err

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

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

Function CancelReserve(CorpNum, ReceiptNum, UserID)

Parameters

변수명	타입	길이	필수	설명
CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
ReceiptNum	String	18	Y	카카오톡 예약전송 접수시 팝빌로부터 반환받은 접수번호
UserID	String	50	N	팝빌회원 아이디

Return

Response

Throws

Err

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

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

Function CancelReserveRN(CorpNum, RequestNum, UserID)

Parameters

변수명	타입	길이	필수	설명
CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
RequestNum	String	36	Y	카카오톡 예약전송 접수시 파트너가 할당한 요청번호
UserID	String	50	N	팝빌회원 아이디

Return

Response

Throws

Err