Index

1. 카카오톡 채널 관리

1.1. GetPlusFriendMgtURL - 카카오톡 채널 관리 팝업 URL

ㆍ카카오톡 채널을 등록하고 내역을 확인하는 카카오톡 채널 관리 페이지 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getPlusFriendMgtURL(CorpNum, UserID):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

1.2. ListPlusFriendID - 카카오톡 채널 목록 확인

ㆍ팝빌에 등록한 연동회원의 카카오톡 채널 목록을 확인합니다.

def listPlusFriendID(CorpNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

PlusFriendID[ ]

Throws

PopbillException

2. 발신번호 관리

2.1. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL

ㆍ발신번호를 등록하고 내역을 확인하는 카카오톡 발신번호 관리 페이지 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getSenderNumberMgtURL(CorpNum, UserID):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

2.2. GetSenderNumberList - 발신번호 목록 확인

ㆍ팝빌에 등록한 연동회원의 카카오톡 발신번호 목록을 확인합니다.

def getSenderNumberList(CorpNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

SenderNumber[ ]

Throws

PopbillException

3. 알림톡 템플릿 관리

3.1. GetATSTemplateMgtURL - 알림톡 템플릿 관리 팝업 URL

ㆍ알림톡 템플릿을 신청하고 승인심사 결과를 확인하며 등록 내역을 확인하는 알림톡 템플릿 관리 페이지 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getATSTemplateMgtURL(CorpNum, UserID):
유의사항

ㆍ승인된 알림톡 템플릿은 수정이 불가하고, 변경이 필요한 경우 새롭게 템플릿 신청을 해야합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

3.2. GetATSTemplate - 알림톡 템플릿 정보 확인

ㆍ승인된 알림톡 템플릿의 정보를 확인합니다.

def getATSTemplate(CorpNum, templateCode, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 templateCode str 12 O 템플릿 코드
3 UserID str 50 - 팝빌회원 아이디

Return

ATSTemplate

Throws

PopbillException

3.2. ListATSTemplate - 알림톡 템플릿 목록 확인

ㆍ승인된 알림톡 템플릿 목록을 확인합니다.

def listATSTemplate(CorpNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

ATSTemplate[ ]

Throws

PopbillException

4. 카카오톡 전송

접수번호(recieptNum)

  • 작업(접수) 단위를 나타내는 고유한 식별정보로 알림톡/친구톡 전송 함수 호출시 팝빌로부터 반환받는 값
  • 예약접수 건을 취소하거나, 전송내역 및 실패사유를 확인하기 위한 값

cf. 다건접수(대량/동보) 경우에도 하나의 접수번호만을 반환

4.1. SendATS - 알림톡 단건전송

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

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

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

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 TemplateCode str 12 O 승인된 알림톡 템플릿 코드
└ 함수 [3.1. GetATSTemplateMgtURL - 알림톡 템플릿 관리 팝업 URL] 또는 [3.3. ListATSTemplate - 알림톡 템플릿 목록 확인] 호출하여 확인 가능
3 Sender str 20 O 발신번호
└ 함수 [2.1. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [2.2. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 오류 메시지 반환
4 Content str 1000 O 알림톡 내용 (최대 1,000자)
※ 승인된 알림톡 템플릿 내용과 다른 내용이 입력되는 경우 '전송실패' 처리
5 AltContent str 2000 - {@no.6 AltSendType} = "A" 일 경우, 대체문자로 전송할 내용 입력 (최대 2,000byte)
└ 팝빌이 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송처리
6 AltSendType str 1 - 대체문자 유형 : "" / "C" / "A" 중 택 1
└ "" = 미전송, C = 알림톡과 동일 내용 전송, A = {@no.5 AltContent}에 입력한 내용 전송
7 SndDT str 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
8 Receiver str 20 O 수신번호
9 ReceiverName str 70 - 수신자명
10 UserID str 50 - 팝빌회원 아이디
11 RequestNum str 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 할당한 식별번호
└ 영문, 숫자, 하이픈('-') 사용하여 고유값 부여
12 ButtonList KakaoButton[ ] 5 - [리스트] 버튼 목록(최대 5개)
※ 미입력시 {@no.2 templateCode} 값에 해당하는 버튼 정보 자동 입력

Return

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

Throws

PopbillException

4.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):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 TemplateCode str 12 O 승인된 알림톡 템플릿 코드
└ 함수 [3.1. GetATSTemplateMgtURL - 알림톡 템플릿 관리 팝업 URL] 또는 [3.3. ListATSTemplate - 알림톡 템플릿 목록 확인] 호출하여 확인 가능
3 Sender str 20 O 발신번호
└ 함수 [2.1. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [2.2. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 오류 메시지 반환
4 Content str 1000 - 알림톡 내용 (최대 1,000자)
※ 승인된 알림톡 템플릿 내용과 다른 내용이 입력되는 경우 '전송실패' 처리
5 AltContent str 2000 - {@no.6 AltSendType} = "A" 일 경우, 대체문자로 전송할 내용 입력 (최대 2,000byte)
└ 팝빌이 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송처리
6 AltSendType str 1 - 대체문자 유형 : "" / "C" / "A" 중 택 1
└ "" = 미전송, C = 알림톡과 동일 내용 전송, A = {@no.8 KakaoReceiver[ ]의 altMessage}에 입력한 내용 전송
7 SndDT str 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
8 KakaoMessages KakaoReceiver[ ] 1000 O [리스트] 전송 정보 (최대 1,000건)
9 UserID str 50 - 팝빌회원 아이디
10 RequestNum str 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 할당한 식별번호
└ 영문, 숫자, 하이픈('-') 사용하여 고유값 부여
11 ButtonList KakaoButton[ ] 5 - [리스트] 버튼 목록(최대 5개)
※ 미입력시 {@no.2 templateCode} 값에 해당하는 버튼 정보 자동 입력

Return

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

Throws

PopbillException

4.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):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 TemplateCode str 12 O 승인된 알림톡 템플릿 코드
└ 함수 [3.1. GetATSTemplateMgtURL - 알림톡 템플릿 관리 팝업 URL] 또는 [3.3. ListATSTemplate - 알림톡 템플릿 목록 확인] 호출하여 확인 가능
3 Sender str 20 O 발신번호
└ 함수 [2.1. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [2.2. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 오류 메시지 반환
4 Content str 1000 O 동보전송할 알림톡 내용 (최대 1,000자)
5 AltContent str 2000 - {@no.6 AltSendType} = "A" 일 경우, 동보전송할 대체문자 내용 (최대 2000byte)
└ 팝빌이 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송처리
6 AltSendType str 1 - 대체문자 유형 : "" / "C" / "A" 중 택 1
└ "" = 미전송, C = 알림톡과 동일 내용 전송, A = {@no.8 KakaoReceiver[ ]의 altMessage}에 입력한 내용 전송
7 SndDT str 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
8 KakaoMessages KakaoReceiver[ ] 1000 O [리스트] 전송 정보 (최대 1,000건)
9 UserID str 50 - 팝빌회원 아이디
10 RequestNum str 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 할당한 식별번호
└ 영문, 숫자, 하이픈('-') 사용하여 고유값 부여
11 ButtonList KakaoButton[ ] 5 - [리스트] 버튼 목록(최대 5개)
※ 미입력시 {@no.2 templateCode} 값에 해당하는 버튼 정보 자동 입력

Return

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

Throws

PopbillException

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

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

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

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

def sendFTS(CorpNum, PlusFriendID, Sender, Content, AltContent, AltSendType, SndDT, Receiver, ReceiverName, KakaoButtons, AdsYN=False, UserID=None, RequestNum=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 PlusFriendID str 30 O 팝빌에 등록된 카카오톡 채널명
3 Sender str 20 O 발신번호
└ 함수 [2.1. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [2.2. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 오류 메시지 반환
4 Content str 1000 O 친구톡 내용 (최대 1,000자)
5 AltContent str 2000 - {@no.6 AltSendType} = "A" 일 경우, 대체문자로 전송할 내용 입력 (최대 2,000byte)
└ 팝빌이 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송처리
6 AltSendType str 1 - 대체문자 유형 : "" / "C" / "A" 중 택 1
└ "" = 미전송, C = 친구톡과 동일 내용 전송, A = {@no.5 AltContent}에 입력한 내용 전송
7 SndDT str 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
8 Receiver str 20 O 수신번호
9 ReceiverName str 70 - 수신자명
10 KakaoButtons KakaoButton[ ] 5 - [리스트] 버튼 목록(최대 5개)
11 AdsYN bool - - 광고성 메시지 여부 : True / False 중 택 1
└ True = 광고, False = 일반
※ 미입력시 기본값 False 처리
12 UserID str 50 - 팝빌회원 아이디
13 RequestNum str 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 할당한 식별번호
└ 영문, 숫자, 하이픈('-') 사용하여 고유값 부여

Return

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

Throws

PopbillException

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

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

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

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

def sendFTS_multi(CorpNum, PlusFriendID, Sender, Content, AltContent, AltSendType, SndDT, KakaoMessages, KakaoButtons, AdsYN=False, UserID=None, RequestNum=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 PlusFriendID str 30 O 팝빌에 등록된 카카오톡 채널명
3 Sender str 20 O 발신번호
└ 함수 [2.1. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [2.2. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 오류 메시지 반환
4 Content str 1000 - 친구톡 내용 (최대 1,000자)
5 AltContent str 2000 - {@no.6 AltSendType} = "A" 일 경우, 대체문자로 전송할 내용 입력 (최대 2,000byte)
└ 팝빌이 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송처리
6 AltSendType str 1 - 대체문자 유형 : "" / "C" / "A" 중 택 1
└ "" = 미전송, C = 친구톡과 동일 내용 전송, A = {@no.6 KakaoReceiver[ ]의 altMessage}에 입력한 내용 전송
7 SndDT str 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
8 KakaoMessages KakaoReceiver[ ] 1000 O [리스트] 전송 정보 (최대 1,000건)
9 KakaoButtons KakaoButton[ ] 5 - [리스트] 버튼 목록 (최대 5개)
10 AdsYN bool - - 광고성 메시지 여부 : True / False 중 택 1
└ True = 광고, False = 일반
※ 미입력시 기본값 False 처리
11 UserID str 50 - 팝빌회원 아이디
12 RequestNum str 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 할당한 식별번호
└ 영문, 숫자, 하이픈('-') 사용하여 고유값 부여

Return

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

Throws

PopbillException

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

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

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

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

def sendFTS_same(CorpNum, PlusFriendID, Sender, Content, AltContent, AltSendType, SndDT, KakaoMessages, KakaoButtons, AdsYN=False, UserID=None, RequestNum=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 PlusFriendID str 30 O 팝빌에 등록된 카카오톡 채널명
3 Sender str 20 O 발신번호
└ 함수 [2.1. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [2.2. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 오류 메시지 반환
4 Content str 1000 O 동보전송할 친구톡 내용 (최대 1,000자)
5 AltContent str 2000 - {@no.6 AltSendType} = "A" 일 경우, 동보전송할 대체문자 내용 (최대 2000byte)
└ 팝빌이 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송처리
6 AltSendType str 1 - 대체문자 유형 : "" / "C" / "A" 중 택 1
└ "" = 미전송, C = 친구톡과 동일 내용 전송, A = {@no.8 KakaoReceiver[ ]의 altMessage}에 입력한 내용 전송
7 SndDT str 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
8 KakaoMessages KakaoReceiver[ ] 1000 O [리스트] 전송 정보 (최대 1,000건)
9 KakaoButtons KakaoButton[ ] 5 - [리스트] 버튼 목록 (최대 5개)
10 AdsYN bool - - 광고성 메시지 여부 : True / False 중 택 1
└ True = 광고, False = 일반
※ 미입력시 기본값 False 처리
11 UserID str 50 - 팝빌회원 아이디
12 RequestNum str 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 할당한 식별번호
└ 영문, 숫자, 하이픈('-') 사용하여 고유값 부여

Return

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

Throws

PopbillException

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

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

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

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

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

def sendFMS(CorpNum, PlusFriendID, Sender, Content, AltContent, AltSendType, SndDT, FilePath, ImageURL, Receiver, ReceiverName, KakaoButtons, AdsYN=False, UserID=None, RequestNum=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 PlusFriendID str 30 O 팝빌에 등록된 카카오톡 채널명
3 Sender str 20 O 발신번호
└ 함수 [2.1. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [2.2. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 오류 메시지 반환
4 Content str 400 O 친구톡 내용 (최대 400자)
5 AltContent str 2000 - {@no.6 AltSendType} = "A" 일 경우, 대체문자로 전송할 내용 입력 (최대 2,000byte)
└ 팝빌이 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송처리
6 AltSendType str 1 - 대체문자 유형 : "" / "C" / "A" 중 택 1
└ "" = 미전송, C = 친구톡과 동일 내용 전송, A = {@no.5 AltContent}에 입력한 내용 전송
7 SndDT str 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
8 FilePath str - O 친구톡에 첨부할 이미지 파일 경로
※ 이미지 파일 규격: 전송 포맷 – JPG 파일 (.jpg, .jpeg), 용량 – 최대 500 Kbyte, 크기 – 가로 500px 이상, 가로 기준으로 세로 0.5~1.3배 비율 가능
9 ImageURL str 256 - 친구톡에 첨부된 이미지 링크 URL
└ 수신자가 친구톡 상단 이미지 클릭시 호출되는 URL
※ 미입력시 첨부된 이미지를 링크 기능 없이 표시
10 Receiver str 20 O 수신번호
11 ReceiverName str 70 - 수신자명
12 KakaoButtons KakaoButton[ ] 5 - [리스트] 버튼 목록 (최대 5개)
13 AdsYN bool - - 광고성 메시지 여부 : True / False 중 택 1
└ True = 광고, False = 일반
※ 미입력시 기본값 False 처리
14 UserID str 50 - 팝빌회원 아이디
15 RequestNum str 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 할당한 식별번호
└ 영문, 숫자, 하이픈('-') 사용하여 고유값 부여

Return

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

Throws

PopbillException

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

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

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

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

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

def sendFMS_multi(CorpNum, PlusFriendID, Sender, Content, AltContent, AltSendType, SndDT, FilePath, ImageURL, KakaoMessages, KakaoButtons, AdsYN=False, UserID=None, RequestNum=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 PlusFriendID str 30 O 팝빌에 등록된 카카오톡 채널명
3 Sender str 20 O 발신번호
└ 함수 [2.1. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [2.2. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 오류 메시지 반환
4 Content str 400 O 친구톡 내용 (최대 400자)
5 AltContent str 2000 - {@no.6 AltSendType} = "A" 일 경우, 대체문자로 전송할 내용 입력 (최대 2,000byte)
└ 팝빌이 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송처리
6 AltSendType str 1 - 대체문자 유형 : "" / "C" / "A" 중 택 1
└ "" = 미전송, C = 친구톡과 동일 내용 전송, A = {@no.10 KakaoReceiver[ ]의 altMessage}에 입력한 내용 전송
7 SndDT str 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
8 FilePath str - O 친구톡에 첨부할 이미지 파일 경로
※ 이미지 파일 규격: 전송 포맷 – JPG 파일 (.jpg, .jpeg), 용량 – 최대 500 Kbyte, 크기 – 가로 500px 이상, 가로 기준으로 세로 0.5~1.3배 비율 가능
9 ImageURL str 256 - 친구톡에 첨부된 이미지 링크 URL
└ 수신자가 친구톡 상단 이미지 클릭시 호출되는 URL
※ 미입력시 첨부된 이미지를 링크 기능 없이 표시
10 KakaoMessages KakaoReceiver[ ] 1000 O [리스트] 전송 정보 (최대 1,000건)
11 KakaoButtons KakaoButton[ ] 5 - [리스트] 버튼 목록 (최대 5개)
12 AdsYN bool - - 광고성 메시지 여부 : True / False 중 택 1
└ True = 광고, False = 일반
※ 미입력시 기본값 False 처리
13 UserID str 50 - 팝빌회원 아이디
14 RequestNum str 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 할당한 식별번호
└ 영문, 숫자, 하이픈('-') 사용하여 고유값 부여

Return

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

Throws

PopbillException

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

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

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

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

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

def sendFMS_same(CorpNum, PlusFriendID, Sender, Content, AltContent, AltSendType, SndDT, FilePath, ImageURL, KakaoMessages, KakaoButtons, AdsYN=False, UserID=None, RequestNum=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 PlusFriendID str 30 O 팝빌에 등록된 카카오톡 채널명
3 Sender str 20 O 발신번호
└ 함수 [2.1. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [2.2. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 오류 메시지 반환
4 Content str 400 O 동보전송할 친구톡 내용 (최대 400자)
5 AltContent str 2000 - {@no.6 AltSendType} = "A" 일 경우, 동보전송할 대체문자 내용 (최대 2000byte)
└ 팝빌이 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송처리
6 AltSendType str 1 - 대체문자 유형 : "" / "C" / "A" 중 택 1
└ "" = 미전송, C = 친구톡과 동일 내용 전송, A = {@no.10 KakaoReceiver[ ]의 altMessage}에 입력한 내용 전송
7 SndDT str 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
8 FilePath str - O 친구톡에 첨부할 이미지 파일 경로
※ 이미지 파일 규격: 전송 포맷 – JPG 파일 (.jpg, .jpeg), 용량 – 최대 500 Kbyte, 크기 – 가로 500px 이상, 가로 기준으로 세로 0.5~1.3배 비율 가능
9 ImageURL str 256 - 친구톡에 첨부된 이미지 링크 URL
└ 수신자가 친구톡 상단 이미지 클릭시 호출되는 URL
※ 미입력시 첨부된 이미지를 링크 기능 없이 표시
10 KakaoMessages KakaoReceiver[ ] 1000 O [리스트] 전송 정보 (최대 1,000건)
11 KakaoButtons KakaoButton[ ] 5 - [리스트] 버튼 목록 (최대 5개)
12 AdsYN bool - - 광고성 메시지 여부 : True / False 중 택 1
└ True = 광고, False = 일반
※ 미입력시 기본값 False 처리
13 UserID str 50 - 팝빌회원 아이디
14 RequestNum str 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 할당한 식별번호
└ 영문, 숫자, 하이픈('-') 사용하여 고유값 부여

Return

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

Throws

PopbillException

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

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

def cancelReserve(CorpNum, ReceiptNum, UserID=None):

Parameters

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

Return

Response

Throws

PopbillException

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

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

def cancelReserveRN(CorpNum, RequestNum, UserID=None):

Parameters

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

Return

Response

Throws

PopbillException

5. 정보확인

5.1. GetMessages - 알림톡/친구톡 전송내역 확인 (접수번호)

ㆍ팝빌에서 반환받은 접수번호를 통해 알림톡/친구톡 전송상태 및 결과를 확인합니다.

def getMessages(CorpNum, ReceiptNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ReceiptNum str 18 O 카카오톡 전송 접수시 팝빌로부터 반환받은 접수번호
3 UserID str 50 - 팝빌회원 아이디

Return

KakaoSentInfo

Throws

PopbillException

5.2. GetMessagesRN - 알림톡/친구톡 전송내역 확인 (전송요청번호)

ㆍ파트너가 할당한 전송요청 번호를 통해 알림톡/친구톡 전송상태 및 결과를 확인합니다.

def getMessagesRN(CorpNum, RequestNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 RequestNum str 36 O 카카오톡 전송 접수시 파트너가 할당한 전송요청 번호
3 UserID str 50 - 팝빌회원 아이디

Return

KakaoSentInfo

Throws

PopbillException

5.3. Search - 전송내역 목록 조회

ㆍ파트너가 지정한 검색조건에 해당하는 카카오톡 전송내역을 조회합니다. (최대 검색기간 : 6개월)

※ 1년 이상된 전송내역은 지원하지 않습니다.

def search(CorpNum, SDate, EDate, State, Item, ReserveYN, SenderYN, Page, PerPage, Order, UserID, Qstr=None):

ㆍ페이지 관련 항목(Page, PerPage, Order)을 활용하여 카카오톡 전송내역 목록을 구현할 수 있습니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 SDate str 8 O 조회 기간의 시작일자 (형식 : yyyyMMdd)
3 EDate str 8 O 조회 기간의 종료일자 (형식 : yyyyMMdd)
4 State list - - [리스트] 전송상태 : "0" / "1" / "2" / "3" / "4" / "5" 중 선택 (다중 선택 가능)
└ 0 = 전송대기, 1 = 전송중, 2 = 전송성공, 3 = 대체문자 전송, 4 = 전송실패, 5 = 전송취소
※ 미입력시 전체조회
5 Item list - - [리스트] 검색대상 : "ATS" / "FTS" / "FMS" 중 선택 (다중 선택 가능)
└ ATS = 알림톡, FTS = 친구톡(텍스트), FMS = 친구톡(이미지)
※ 미입력시 전체조회
6 ReserveYN str - - 전송유형별 조회 : "" / "0" / "1" 중 택 1
└ "" = 전체, 0 = 즉시전송건, 1 = 예약전송건
7 SenderYN bool - - 사용자권한별 조회 : True / False 중 택 1
└ True = 해당 담당자 계정으로 접수한 카카오톡만 조회 (개인권한), False = 접수한 카카오톡 전체 조회 (관리자권한)
※ 미입력시 기본값 False 처리
8 Page int - - 목록 페이지번호 (기본값 1)
9 PerPage int - - 페이지당 표시할 목록 개수 (기본값 500, 최대 1,000)
10 Order str 1 - 알림톡/친구톡 접수일시를 기준으로 하는 목록 정렬 방향 : "D" / "A" 중 택 1
└ D = 내림차순(기본값), A = 오름차순
11 UserID str 50 - 팝빌회원 아이디
12 Qstr str - - 조회하고자 하는 수신자명
※ 미입력시 전체조회

Return

KakaoSearchResult

Throws

PopbillException

5.4. GetSentListURL - 카카오톡 전송내역 팝업 URL

ㆍ팝빌 사이트와 동일한 카카오톡 전송내역을 확인하는 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getSentListURL(CorpNum, UserID):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

6. 포인트 관리

6.1. GetBalance - 연동회원 잔여포인트 확인

ㆍ연동회원의 잔여포인트를 확인합니다.

def getBalance(CorpNum):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

float - 연동회원 잔여포인트

Throws

PopbillException

6.2. GetChargeURL - 연동회원 포인트 충전 팝업 URL

ㆍ연동회원 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getChargeURL(CorpNum, UserID):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

6.3. GetPaymentURL - 연동회원 포인트 결재내역 URL

ㆍ연동회원 포인트 결재내역 확인을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getPaymentURL(CorpNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

6.4. GetUseHistoryURL - 연동회원 포인트 사용내역 URL

ㆍ연동회원 포인트 사용내역 확인을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getUseHistoryURL(CorpNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

6.5. GetPartnerBalance - 파트너 잔여포인트 확인

ㆍ파트너의 잔여포인트를 확인합니다.

def getPartnerBalance(CorpNum):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

float - 파트너 잔여포인트

Throws

PopbillException

6.6. GetPartnerURL - 파트너 포인트충전 팝업 URL

ㆍ파트너 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getPartnerURL(CorpNum, TOGO):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 TOGO str - O "CHRG" 입력

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

6.7. GetUnitCost - 전송 단가 확인

ㆍ카카오톡 전송시 과금되는 포인트 단가를 확인합니다.

def getUnitCost(CorpNum, MsgType, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MsgType str - O 카카오톡 전송유형 : ATS / FTS / FMS 중 택 1
└ ATS = 알림톡, FTS = 친구톡(텍스트) , FMS = 친구톡(이미지)
3 UserID str 50 - 팝빌회원 아이디

Return

float - 카카오톡 전송 단가

Throws

PopbillException

6.8. GetChargeInfo - 과금정보 확인

ㆍ팝빌 카카오톡 API 서비스 과금정보를 확인합니다.

def getChargeInfo(CorpNum, MsgType, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MsgType str - O 카카오톡 전송유형 : ATS / FTS / FMS 중 택 1
└ ATS = 알림톡, FTS = 친구톡(텍스트) , FMS = 친구톡(이미지)
3 UserID str 50 - 팝빌회원 아이디

Return

ChargeInfo

Throws

PopbillException

7. 회원정보

7.1. CheckIsMember - 연동회원 가입여부 확인

ㆍ사업자번호를 조회하여 연동회원 가입여부를 확인합니다.

def checkIsMember(CorpNum):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

Response

Throws

PopbillException

7.2. CheckID - 아이디 중복 확인

ㆍ사용하고자 하는 아이디의 중복여부를 확인합니다.

def checkID(checkID):

Parameters

순번 변수명 타입 길이 필수 설명
1 CheckID str 20 O 중복여부를 확인할 아이디

Return

Response - code : 0 (미사용중) / code : 1 (사용중)

Throws

PopbillException

7.3. JoinMember - 연동회원 신규가입

ㆍ사용자를 연동회원으로 가입처리합니다.

def joinMember(JoinInfo):

Parameters

순번 변수명 타입 길이 필수 설명
1 JoinInfo JoinForm - O 연동회원 객체정보

Return

Response

Throws

PopbillException

7.4. GetAccessURL - 팝빌 로그인 팝업 URL

ㆍ팝빌 사이트에 로그인 상태로 접근할 수 있는 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getAccessURL(CorpNum, UserID):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

7.5. GetCorpInfo - 회사정보 확인

ㆍ연동회원의 회사정보를 확인합니다.

def getCorpInfo(CorpNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

CorpInfo

Throws

PopbillException

7.6. UpdateCorpInfo - 회사정보 수정

ㆍ연동회원의 회사정보를 수정합니다.

def updateCorpInfo(CorpNum, CorpInfo, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 CorpInfo CorpInfo - O 회사 객체정보
3 UserID str 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

7.7. RegistContact - 담당자 추가

ㆍ연동회원 사업자번호에 담당자(팝빌 로그인 계정)를 추가합니다.

def registContact(CorpNum, ContactInfo, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ContactInfo ContactInfo - O 담당자 객체정보
3 UserID str 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

7.8. GetContactInfo - 담당자 정보 확인

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 정보를 확인합니다.

def getContactInfo(CorpNum, ContactID, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ContactID str 50 O 담당자 아이디
3 UserID str 50 - 팝빌회원 아이디

Return

ContactInfo

Throws

PopbillException

7.9. ListContact - 담당자 목록 확인

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 목록을 확인합니다.

def listContact(CorpNum, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID str 50 - 팝빌회원 아이디

Return

ContactInfo[ ]

Throws

PopbillException

7.10. UpdateContact - 담당자 정보 수정

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 정보를 수정합니다.

def updateContact(CorpNum, ContactInfo, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ContactInfo ContactInfo - O 담당자 객체정보
3 UserID str 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

A. 객체정보

A.1. Response

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

A.2. PopbillException

순번 변수명 항목명 타입 길이 비고
1 code 코드 int - API 처리 실패에 대한 오류코드("-"로 시작하는 8자리 숫자값)
[참고] 오류코드
2 message 메시지 str - API 처리 실패에 대한 오류메시지

A.3. SenderNumber

순번 변수명 항목명 타입 길이 비고
1 number 발신번호 str 20
2 representYN 대표번호 지정여부 bool - True : (대표번호) / False : (일반번호) 중 반환
3 state 등록상태 int 1 0 : (대기) / 1 : (승인) / 2 : (취소) 중 반환
4 memo 메모 str -

A.4. PlusFriendID

순번 변수명 항목명 타입 길이 비고
1 plusFriendID 카카오톡 채널 검색용 아이디 str -
2 plusFriendName 카카오톡 채널 이름 str -
3 regDT 등록일시 str 14 팝빌에 카카오톡 채널 등록한 일시 (형식 : yyyyMMddHHmmss)

A.5. ATSTemplate

순번 변수명 항목명 타입 길이 비고
1 templateCode 템플릿 코드 str 12
2 templateName 템플릿 제목 str 20
3 template 템플릿 내용 str 1000
4 plusFriendID 카카오톡 채널 검색용 아이디 str 30
5 btns 버튼 목록 KakaoButton[ ] [리스트] 최대 5개

A.6. KakaoReceiver

순번 변수명 항목명 타입 길이 필수 비고
1 rcv 수신번호 str 20 O
2 rcvnm 수신자명 str 70 -
3 msg 알림톡/친구톡 내용 str 1000/400 - 알림톡/친구톡(텍스트) 전송시 최대 1,000자 / 친구톡(이미지) 전송시 최대 400자
4 altmsg 대체문자 내용 str 2000 -
5 btns 버튼 목록 KakaoButton[ ] - [리스트] 최대 5개
6 interOPRefKey 파트너 지정 키 str 20 - 알림톡 / 친구톡 대량 / 동보전송시 파트너가 개별건마다 입력할 수 있는 값

A.7. KakaoSearchResult

순번 변수명 항목명 타입 길이 비고
1 code 코드 int - API 처리에 대한 응답코드
2 message 메시지 str - API 처리에 대한 응답메시지
3 total 총 검색결과 건수 int -
4 perPage 페이지 당 목록 개수 int -
5 pageNum 페이지 번호 int -
6 pageCount 페이지 개수 int -
7 list 전송결과 정보 KakaoSentDetail[ ] [리스트] 최대 1,000개

A.8. KakaoSentInfo

순번 변수명 항목명 타입 길이 비고
1 contentType 카카오톡 유형 int - 1 : (알림톡) / 2 : (친구톡 텍스트) / 3 : (친구톡 이미지) 중 반환
2 templateCode 템플릿 코드 str - 알림톡 전송시 사용한 코드값
3 plusFriendID 카카오톡 채널 검색용 아이디 str - 알림톡/친구톡 전송시 사용한 아이디값
4 sendNum 발신번호 str 20
5 altContent [동보] 대체문자 내용 str 2000
6 altSendType 대체문자 유형 str - "" / "C" / "A" 중 반환
└ "" = 미전송, C = 알림톡 또는 친구톡 내용으로 전송, A = 대체문자 내용으로 전송
※ 대체문자의 경우, 포토문자(MMS) 형식은 지원하고 있지 않습니다.
7 reserveDT 예약일시 str -
8 adsYN 광고전송 여부 bool - True : (광고) / False : (일반) 중 반환
9 imageURL 친구톡 이미지 URL str -
10 sendCnt 전송건수 str -
11 successCnt 성공건수 str -
12 failCnt 실패건수 str -
13 altCnt 대체문자 건수 str -
14 cancelCnt 취소건수 str -
15 btns 버튼 목록 KakaoButton[ ] [리스트] 최대 5개
16 msgs 전송결과 정보 KakaoSentDetail[ ] [리스트] 최대 1,000개

A.9. KakaoButton

순번 변수명 항목명 타입 길이 비고
1 n 버튼명 str 14
2 t 버튼유형 str 2 "DS" : (배송조회 - 알림톡 전용) / "WL" : (웹링크) / "AL" : (앱링크) / "MD" : (메시지전달) / "BK" : (봇키워드) 중 반환
3 u1 버튼링크1 str 256 {@no.2 t} = "AL"일 경우 iOS 앱링크 적용
{@no.2 t} = "WL"일 경우 Mobile 웹링크 적용
4 u2 버튼링크2 str 256 {@no.2 t} = "AL"일 경우 Android 앱링크 적용
{@no.2 t} = "WL"일 경우 PC 웹링크 적용

A.10. KakaoSentDetail

순번 변수명 항목명 타입 길이 비고
1 state 전송상태 코드 int 1 알림톡/친구톡 전송 작업 상태를 확인하는 값
[참고] 전송 상태 및 결과 코드
2 sendDT 전송일시 str -
3 result 전송결과 코드 int 3 {@no.1 state} = 3 인 경우, 전송 성공여부를 확인하는 값
[참고] 전송 상태 및 결과 코드
4 resultDT 전송결과 수신일시 str -
5 contentType 카카오톡 유형 int - 1 : (알림톡) / 2 : (친구톡 텍스트) / 3 : (친구톡 이미지) 중 반환
6 receiveNum 수신번호 str -
7 receiveName 수신자명 str -
8 content 알림톡/친구톡 내용 str -
9 altContent 대체문자 내용 str -
10 altContentType 대체문자 전송타입 int - 4 : (단문) / 6 : (장문) 중 반환
11 altSendDT 대체문자 전송일시 str -
12 altResult 대체문자 전송결과 코드 int 3 [참고] 전송 상태 및 결과 코드
13 altResultDT 대체문자 전송결과 수신일시 str -
14 receiptNum 접수번호 str 18
15 requestNum 요청번호 str 36
16 interOPRefKey 파트너 지정 키 str 20 알림톡/친구톡 대량/동보전송시 파트너가 입력한 값

A.11. ChargeInfo

순번 변수명 항목명 타입 길이 비고
1 unitCost 전송단가 str -
2 chargeMethod 과금유형 str - "연동" / "파트너" 중 반환
3 rateSystem 과금제도 str - "종량제" 반환

A.12. JoinForm

순번 변수명 항목명 타입 길이 필수 비고
1 ID 아이디 str 50 O 6자 이상 50자 미만
2 Password 비밀번호 str 20 O 8자 이상 20자 이하
└ 영문, 숫자, 특수문자 조합
3 LinkID 파트너 링크아이디 str 20 O 연동신청시 팝빌에서 발급받은 링크아이디
4 CorpNum 사업자번호 str 10 O 하이픈 '-' 제외 10자리 숫자값
5 CEOName 대표자 성명 str 100 O
6 CorpName 회사명 str 200 O
7 Addr 사업장 주소 str 300 O
8 BizType 업태 str 100 O
9 BizClass 종목 str 100 O
10 ContactName 담당자 성명 str 100 O
11 ContactEmail 담당자 이메일 str 100 O
12 ContactTEL 담당자 연락처(전화번호) str 20 O
13 ContactHP 담당자 휴대폰번호 str 20 -
14 ContactFAX 담당자 팩스번호 str 20 -

A.13. CorpInfo

순번 변수명 항목명 타입 길이 필수 비고
1 ceoname 대표자 성명 str 100 O
2 corpName 회사명 str 200 O
3 addr 주소 str 300 O
4 bizType 업태 str 100 O
5 bizClass 종목 str 100 O

A.14. ContactInfo

순번 변수명 항목명 타입 길이 필수 비고
1 id 아이디 str 50 O 6자 이상 50자 미만
2 Password 비밀번호 str 20 8자 이상 20자 이하
└ 영문, 숫자, 특수문자 조합
3 personName 담당자 성명 str 100 O
4 tel 담당자 연락처(전화번호) str 20 O
5 hp 담당자 휴대폰번호 str 20 -
6 fax 담당자 팩스번호 str 20 -
7 email 담당자 이메일 str 100 O
8 regDT 등록일시 str 14 X
9 searchRole 담당자 조회권한 설정 int - - 1 / 2 / 3 중 입력 또는 반환
└ 1 : 개인권한 / 2 : 읽기권한 / 3 : 회사권한
※ 미입력시 기본값 1 처리
10 mgrYN 관리자 여부 bool - X True : (관리자) / False : (일반사용자) 중 반환
※ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
11 state 계정상태 int 1 X 0 : (승인대기 - 관리자의 승인 후 이용가능) / 1 : (사용중) 중 반환