4. 카카오톡 전송

4.1. SendATS - 알림톡 단건전송

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

function SendATS(CorpNum : String; TemplateCode : String; SenderNum : String; Altsendtype : String; ReserveDT: String; ReceiverNum : String; ReceiverName : String; ATSMsg : String; ATSAltSjt : String ; ATSAltMsg : String; Buttons : TSendKakaoButtonList; UserID : String = ''; requestNum : String = '') : String;

Parameters

변수명	타입	길이	필수	설명
CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
TemplateCode	String	12	Y	승인된 알림톡 템플릿 코드
SenderNum	String	20	조건부	발신번호 대체문자 전송시 필수 팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
Altsendtype	String	1	N	대체문자 유형 C알림톡 내용 전송 A대체문자 내용 전송 기본값 : 미전송
ReserveDT	String	14	N	전송 예약일시 형식 : yyyyMMddHHmmss 기본값 : 즉시전송
ReceiverNum	String	20	Y	수신번호
ReceiverName	String	70	N	수신자명
ATSMsg	String	1000	Y	알림톡 내용 최대 : 1,000자
ATSAltSjt	String	40	N	대체문자 제목 메시지 길이가 90byte 이상인 경우에만 적용
ATSAltMsg	String	2000	N	대체문자 내용 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송
Buttons	TSendKakaoButtonList		N	버튼 목록 버튼링크를 변경해야할 경우 사용 최대 : 5개 기본값 : 승인된 템플릿의 버튼 목록
UserID	String	50	N	팝빌회원 아이디
requestNum	String	36	N	요청번호 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

Return

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

Throws

EPopbillException

4.2. SendATS - 알림톡 (동보전송/대량전송)

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

function SendATS(CorpNum : String; TemplateCode : String; SenderNum : String; Content : String; AltSubject : String; AltContent : String; Altsendtype : String; ReserveDT : String; Receivers : TSendKakaoReceiverList; Buttons : TSendKakaoButtonList; UserID : String = ''; requestNum : String = '') : String;

Parameters

변수명	타입	길이	필수	설명
CorpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
TemplateCode	String	12	Y	승인된 알림톡 템플릿 코드
SenderNum	String	20	조건부	발신번호 대체문자 전송시 필수 팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
Content	String	1000	조건부	알림톡 내용 동보전송 경우 필수 최대 : 1,000자
AltSubject	String	40	N	대체문자 제목 동보전송 경우 사용 메시지 길이가 90byte 이상인 경우에만 적용
AltContent	String	2000	N	대체문자 내용 동보전송 경우 사용 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송
Altsendtype	String	1	N	대체문자 유형 C알림톡 내용 전송 A대체문자 내용 전송 기본값 : 미전송
ReserveDT	String	14	N	전송 예약일시 형식 : yyyyMMddHHmmss 기본값 : 즉시전송
Receivers	TSendKakaoReceiverList		Y	전송정보 최대 : 1,000개
Buttons	TSendKakaoButtonList		N	버튼 목록 동보전송 경우 사용 버튼링크를 변경해야할 경우 사용 최대 : 5개 기본값 : 승인된 템플릿의 버튼 목록
UserID	String	50	N	팝빌회원 아이디
requestNum	String	36	N	요청번호 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

Return

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

Throws

EPopbillException

4.3. SendFTS - 친구톡(텍스트) 단건전송

텍스트로 구성된 1건의 친구톡 전송을 팝빌에 접수합니다.
※ 친구톡의 경우 야간 전송은 제한됩니다. (20:00 ~ 익일 08:00)
전송실패시 사전에 지정한 변수 'Altsendtype' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.

function SendFTS(CorpNum : String; PlusFriendID : String; SenderNum : String; Altsendtype : String; ReserveDT : String; AdsYN : Boolean; ReceiverNum : String; ReceiverName : String; FTSMsg : String; FTSAltSjt : String; FTSAltMsg : String; Buttons : TSendKakaoButtonList; UserID : String = ''; requestNum : String = '') : String;

Parameters

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

Return

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

Throws

EPopbillException

4.4. SendFTS - 친구톡 (텍스트) (동보전송/대량전송)

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

function SendFTS(CorpNum : String; PlusFriendID : String; SenderNum : String; Content : String; AltContent : String; Altsendtype : String; ReserveDT : String; AdsYN : Boolean; Receivers : TSendKakaoReceiverList; Buttons : TSendKakaoButtonList; UserID : String = ''; requestNum : String = '') : String;

Parameters

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

Return

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

Throws

EPopbillException

4.5. SendFMS - 친구톡(이미지) 단건전송

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

function SendFMS(CorpNum : String; PlusFriendID : String; SenderNum : String; Altsendtype : String; ReserveDT : String; AdsYN : Boolean; ReceiverNum : String; ReceiverName : String; FTSMsg : String; FTSAltSjt : String; FTSAltMsg : String; FMSFilePath : String; ImageURL : String; Buttons : TSendKakaoButtonList; UserID : String = ''; requestNum : String = '') : String;

Parameters

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

Return

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

Throws

EPopbillException

4.6. SendFMS - 친구톡 이미지 (동일내용 대량전송)

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

function SendFMS(CorpNum : String; PlusFriendID : String; SenderNum : String; Content : String; AltSubject : String; AltContent : String; Altsendtype : String; ReserveDT : String; AdsYN : Boolean; Receivers : TSendKakaoReceiverList; FMSFilePath : String; ImageURL : String; Buttons : TSendKakaoButtonList; UserID : String = ''; requestNum : String = '') : String;

Parameters

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

Return

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

Throws

EPopbillException

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

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

function CancelReserve(CorpNum : String; receiptNum : String; UserID : String = '') : TResponse;

Parameters

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

Return

TResponse

Throws

EPopbillException

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

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

function CancelReserveRN(CorpNum : String; requestNum : String; UserID : String = '') : TResponse;

Parameters

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

Return

TResponse

Throws

EPopbillException