Index

1. 카카오톡 채널 관리

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

ㆍ 카카오톡 채널 관리 팝업 URL을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

function GetPlusFriendMgtURL($CorpNum, $UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

ㆍ 팝빌에 등록된 카카오톡 채널 목록을 반환합니다.

function ListPlusFriendID($CorpNum)

Parameters

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

Return

PlusFriend[]

Throws

PopbillException

2. 발신번호 관리

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

ㆍ 카카오톡 발신번호 관리 팝업 URL을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

function GetSenderNumberMgtURL($CorpNum, $UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

ㆍ 팝빌에 등록된 카카오톡 발신번호 목록을 반환합니다.

function GetSenderNumberList($CorpNum)

Parameters

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

Return

SenderNumber[]

Throws

PopbillException

3. 알림톡 템플릿 관리

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

ㆍ 알림톡 템플릿 관리 팝업 URL을 반환합니다.

ㆍ 해당 페이지에서 템플릿 신청, 템플릿 조회, 승인심사 결과확인이 가능합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

function GetATSTemplateMgtURL($CorpNum, $UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

ㆍ (주)카카오로부터 심사후 승인된 알림톡 템플릿 목록을 반환합니다.

ㆍ 반환되는 항목 중 템플릿 코드(templateCode)를 확인하여 알림톡 전송 함수 호출시 기재합니다.

function ListATSTemplate($CorpNum)

Parameters

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

Return

ATSTemplate[]

Throws

PopbillException

4. 카카오톡 전송

접수번호(recieptNum)

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

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

4.1. SendATS - 알림톡 전송

ㆍ 알림톡을 전송 합니다. (최대 1000건)

ㆍ 사전에 승인된 템플릿의 내용과 알림톡 전송 내용이 다를경우 전송실패 처리됩니다.

ㆍ 팝빌에 등록되지 않은 발신번호로 알림톡 메시지를 전송하는 경우 발신번호 미등록 오류로 처리됩니다.

ㆍ 대체문자란 알림톡 전송실패시 문자(메시지 길이에 따라 SMS/LMS)로 메시지를 전송하는 기능입니다.

function SendATS($CorpNum, $TemplateCode, $Sender, $Content, $AltContent, $AltSendType, $Messages = array(), $ReserveDT = null, $UserID = null, $RequestNum = null, $Buttons = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 TemplateCode String 12 O 알림톡 템플릿코드
템플릿 코드는 ListATSTemplate API 또는 GetATSTemplateMgtURL API 에서 확인 가능합니다.
3 Sender String 20 O 발신번호
4 Content String 1000 - 알림톡 내용 (최대 1,000자)
5 AltContent String 2000 - 대체문자 내용 (최대 2000byte)
6 AltSendType String 1 - 대체문자 유형 [ 공백-미전송, C-알림톡내용, A-대체문자내용 중 택1 ]
7 Messages KakaoReceiver[] 1000 O [배열] 전송 정보 (최대 1,000건)
8 ReserveDT String 14 - 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
9 UserID String 50 - 팝빌회원 아이디
10 RequestNum String 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성
11 Buttons KakaoButton[] 5 - [배열] 버튼 목록(최대 5개)

Return

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

Throws

PopbillException

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

ㆍ 친구톡(텍스트)을 전송 합니다. (최대 1000건)

ㆍ 친구톡의 경우 심야 전송(20:00~08:00)이 제한됩니다.

ㆍ 팝빌에 등록되지 않은 발신번호로 친구톡 메시지를 전송하는 경우 발신번호 미등록 오류로 처리됩니다.

ㆍ 대체문자란 친구톡 전송실패시 문자(메시지 길이에 따라 SMS/LMS)로 메시지를 전송하는 기능입니다.

function SendFTS($CorpNum, $PlusFriendID, $Sender, $Content, $AltContent, $AltSendType, $AdsYN, $Messages = array(), $Btns = array(), $ReserveDT = null, $UserID = null, $RequestNum = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 PlusFriendID String 30 O 팝빌에 등록된 카카오톡 채널 아이디
3 Sender String 20 O 발신번호
4 Content String 1000 - 친구톡 내용 (최대 1,000자)
5 AltContent String 2000 - 대체문자 내용 (최대 2000byte)
6 AltSendType String 1 - 대체문자 유형 [ 공백-미전송, C-친구톡내용, A-대체문자내용 중 택1 ]
7 AdsYN Boolean - - 광고 전송여부
8 Messages KakaoReceiver[] 1000 O [배열] 전송 정보 (최대 1,000건)
9 Btns KakaoButton[] 5 - [배열] 버튼 목록(최대 5개)
10 ReserveDT String 14 - 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
11 UserID String 50 - 팝빌회원 아이디
12 RequestNum String 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

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

Throws

PopbillException

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

ㆍ 친구톡(이미지)을 전송 합니다. (최대 1000건)

ㆍ 친구톡의 경우 심야 전송(20:00~08:00)이 제한됩니다.

ㆍ 팝빌에 등록되지 않은 발신번호로 친구톡 메시지를 전송하는 경우 발신번호 미등록 오류로 처리됩니다.

ㆍ 대체문자란 친구톡 전송실패시 문자(메시지 길이에 따라 SMS/LMS)로 메시지를 전송하는 기능입니다.

ㆍ [이미지 파일규격] 전송 포맷 : JPG 파일 (.jpg, .jpeg), 용량 제한 : 최대 500KByte, 이미지 높이/너비 비율 : 1.333 이하, 1/2 이상

function SendFMS($CorpNum, $PlusFriendID, $Sender, $Content, $AltContent, $AltSendType, $AdsYN, $Messages = array(), $Btns = array(), $ReserveDT = null, $FilePaths = array(), $ImageURL = null, $UserID = null, $RequestNum = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 PlusFriendID String 30 O 팝빌에 등록된 카카오톡 채널 아이디
3 Sender String 20 O 발신번호
4 Content String 400 - 친구톡 내용 (최대 400자)
5 AltContent String 2000 - 대체문자 내용 (최대 2000byte)
6 AltSendType String 1 - 대체문자 유형 [ 공백-미전송, C-친구톡내용, A-대체문자내용 중 택1 ]
7 AdsYN Boolean - - 광고 전송여부
8 Messages KakaoReceiver[] 1000 O [배열] 전송 정보 (최대 1,000건)
9 Btns KakaoButton[] 5 - [배열] 버튼 목록(최대 5개)
10 ReserveDT String 14 - 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
11 FilePaths String - O 친구톡 이미지 파일 경로
12 ImageURL String 256 - 친구톡 이미지 링크 URL
- 수신자가 친구톡 상단 이미지 선택시 호출되는 URL
- 공백 처리시 친구톡 이미지 파일만 전송
13 UserID String 50 - 팝빌회원 아이디
14 RequestNum String 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

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

Throws

PopbillException

4.4. CancelReserve - 예약전송 취소

ㆍ 카카오톡 예약전송을 취소합니다.

ㆍ 예약취소는 예약시간 10분전까지 가능합니다.

function CancelReserve($CorpNum, $ReceiptNum, $UserID = null)

Parameters

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

Return

Response

Throws

PopbillException

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

ㆍ 카카오톡 예약전송을 취소합니다.

ㆍ 예약취소는 예약시간 10분전까지 가능합니다.

function CancelReserveRN($CorpNum, $RequestNum, $UserID = null)

Parameters

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

Return

Response

Throws

PopbillException

5. 정보확인

5.1. GetMessages - 알림톡/친구톡 전송내역 확인

ㆍ 알림톡/친구톡 전송상태 및 결과정보를 확인합니다.

function GetMessages($CorpNum, $ReceiptNum, $UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ReceiptNum String 18 O 알림톡/친구톡 전송요청시 발급받은 접수번호
3 UserID String 50 - 팝빌회원 아이디

Return

KakaoSentInfo[]

Throws

PopbillException

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

ㆍ 알림톡/친구톡 전송상태 및 결과정보를 확인합니다.

function GetMessagesRN($CorpNum, $RequestNum, $UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 RequestNum String 36 O 알림톡/친구톡 전송요청시 할당한 전송요청번호
3 UserID String 50 - 팝빌회원 아이디

Return

KakaoSentInfo[]

Throws

PopbillException

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

ㆍ 검색조건에 해당하는 카카오톡 전송내역 목록을 조회합니다. (최대 검색기간 : 6개월 이내)

function Search($CorpNum, $SDate, $EDate, $State = array(), $Item = array(), $ReserveYN = '', $SenderYN = false, $Page, $PerPage, $Order, $UserID = null, $QString = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 SDate String 8 O 시작일자, 날짜형식(yyyyMMdd)
3 EDate String 8 O 종료일자, 날짜형식(yyyyMMdd)
4 State Array - - [배열] 전송상태 [ 0-대기 / 1-전송중 / 2-성공 / 3-대체 / 4-실패 / 5-취소 ]
5 Item Array - - [배열] 검색대상 [ ATS-알림톡 / FTS-친구톡 / FMS-친구톡 이미지 ]
6 ReserveYN String - - 공백-전체조회 / 0-즉시전송 조회 / 1-예약전송 조회
7 SenderYN Boolean - - 개인조회 여부 [ false-전체조회, true-개인조회 ]
8 Page Integer - - 페이지번호, 기본값 '1'
9 PerPage Integer - - 페이지당 검색개수, 기본값 500, 최대 1000
10 Order String 1 - 정렬 방향, 기본값 'D' [ D-내림차순, A-오름차순 중 택1 ]
11 UserID String 50 - 팝빌회원 아이디
12 QString String - - 수신자명 조회, 공백시 전체조회

Return

KakaoSearchResult[]

Throws

PopbillException

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

ㆍ 카카오톡 전송내역 팝업 URL을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

function GetSentListURL($CorpNum, $UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

6. 포인트 관리

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

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

function GetBalance($CorpNum)

Parameters

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

Return

String - 연동회원 잔여포인트

Throws

PopbillException

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

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

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

function GetChargeURL($CorpNum, $UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

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

function GetPartnerBalance($CorpNum)

Parameters

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

Return

String - 파트너 잔여포인트

Throws

PopbillException

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

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

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

function GetPartnerURL($CorpNum, $TOGO)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

6.5. GetUnitCost - 발행 단가 확인

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

function GetUnitCost($CorpNum, $MessageType)

Parameters

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

Return

String - 카카오톡 전송 단가

Throws

PopbillException

6.6. GetChargeInfo - 과금정보 확인

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

function GetChargeInfo($CorpNum, $MessageType, $UserID = null)

Parameters

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

Return

ChargeInfo

Throws

PopbillException

7. 회원정보

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

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

function CheckIsMember($CorpNum, $LinkID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 LinkID String - O 연동신청시 팝빌에서 발급받은 링크아이디

Return

Response

Throws

PopbillException

7.2. CheckID - 아이디 중복 확인

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

function CheckID($ID)

Parameters

순번 변수명 타입 길이 필수 설명
1 ID String 10 O 중복여부를 확인할 아이디

Return

Response

Throws

PopbillException

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

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

function JoinMember($JoinForm)

Parameters

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

Return

Response

Throws

PopbillException

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

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

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

function GetAccessURL($CorpNum, $UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

7.5. GetCorpInfo - 회사정보 확인

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

function GetCorpInfo($CorpNum, $UserID = null)

Parameters

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

Return

CorpInfo

Throws

PopbillException

7.6. UpdateCorpInfo - 회사정보 수정

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

function UpdateCorpInfo($CorpNum, $CorpInfo, $UserID = null)

Parameters

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

Return

Response

Throws

PopbillException

7.7. RegistContact - 담당자 추가

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

function RegistContact($CorpNum, $ContactInfo, $UserID = null)

Parameters

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

Return

Response

Throws

PopbillException

7.8. ListContact - 담당자 목록 확인

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

function ListContact($CorpNum, $UserID = null)

Parameters

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

Return

ContactInfo[ ]

Throws

PopbillException

7.9. UpdateContact - 담당자 정보 수정

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

function UpdateContact($CorpNum, $ContactInfo, $UserID)

Parameters

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

Return

Response

Throws

PopbillException

A. 객체정보

A.1. Response

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

A.2. PopbillException

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

A.3. SenderNumber

순번 변수명 항목명 타입 길이 비고
1 number 발신번호 String 20
2 representYN 대표번호 지정여부 Boolean -
3 state 등록일시 Integer 1 등록상태 [ 0-대기 / 1-승인 / 2-취소 ]

A.4. PlusFriend

순번 변수명 항목명 타입 길이 비고
1 plusFriendID 카카오톡 채널 아이디 String -
2 plusFriendName 카카오톡 채널 이름 String -
3 regDT 등록일시 String -

A.5. ATSTemplate

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

A.6. ENumKakaoType

순번 변수명 항목명 타입 길이 비고
1 ATS 알림톡 String -
2 FTS 친구톡 텍스트 String -
3 FMS 친구톡 이미지 String -

A.7. KakaoReceiver

순번 변수명 항목명 타입 길이 필수 비고
1 rcv 수신번호 String 20 -
2 rcvnm 수신자명 String 70 -
3 msg 알림톡/친구톡 내용 String 1000/400 - 알림톡/친구톡텍스트 최대 1,000자
친구톡 이미지 최대 400자
4 altmsg 대체문자 내용 String 2000 -

A.8. KakaoSearchResult

순번 변수명 항목명 타입 길이 비고
1 code 요청에 대한 응답코드 Integer -
2 message 요청에 대한 응답메시지 String -
3 total 총 검색결과 건수 String -
4 perPage 페이지당 검색개수 String -
5 pageNum 페이지 번호 String -
6 pageCount 페이지 개수 String -
7 list 전송결과 정보 KakaoSentInfoDetail[] [배열] 최대 1,000개

A.9. KakaoSentInfo

순번 변수명 항목명 타입 길이 비고
1 contentType 카카오톡 유형 Integer - 1-알림톡 / 2-친구톡 / 3-친구톡 이미지
2 templateCode 템플릿 코드 String -
3 plusFriendID 카카오톡 채널 아이디 String -
4 sendNum 발신번호 String 20
5 altContent [동보] 대체문자 내용 String - 최대 2000byte
6 altSendType 대체문자 유형 String - 공백-미전송 / C-알림톡 또는 친구톡 내용 / A-대체문자 내용
7 reserveDT 예약일시 String -
8 adsYN 광고전송 여부 Boolean -
9 imageURL 친구톡 이미지 URL String -
10 sendCnt 전송건수 String -
11 successCnt 성공건수 String -
12 failCnt 실패건수 String -
13 altCnt 대체문자 건수 String -
14 cancelCnt 취소건수 String -
15 btns 버튼 목록 KakaoButton[] [배열] 최대 5개
16 msgs 전송결과 정보 KakaoSentInfoDetail[] [배열] 최대 1,000개

A.10. KakaoButton

순번 변수명 항목명 타입 길이 비고
1 n 버튼명 String 14
2 t 버튼유형 String 2 DS-배송조회(알림톡 전용) / WL-웹링크 / AL-앱링크 / MD-메시지전달 / BK-봇키워드
3 u1 버튼링크1 String 256 [앱링크] iOS / [웹링크] Mobile
4 u2 버튼링크2 String 256 [앱링크] Android / [웹링크] PC

A.11. KakaoSentInfoDetail

순번 변수명 항목명 타입 길이 비고
1 state 전송상태 코드 Integer 1 [부록] "전송 코드 테이블"
2 sendDT 전송일시 String -
3 result 전송결과 코드 Integer 3 [부록] "전송 코드 테이블"
4 resultDT 전송결과 수신일시 String -
5 contentType 카카오톡 유형 Integer - 1-알림톡 / 2-친구톡 / 3-친구톡 이미지
6 receiveNum 수신번호 String -
7 receiveName 수신자명 String -
8 content 알림톡/친구톡 내용 String -
9 altContent 대체문자 내용 String -
10 altContentType 대체문자 전송타입 Integer - 4-단문 / 6-장문
11 altSendDT 대체문자 전송일시 String - [부록] "전송 코드 테이블"
12 altResult 대체문자 전송결과 코드 Integer 3
13 altResultDT 대체문자 전송결과 수신일시 String -
14 receiptNum 접수번호 String 18
15 requestNum 요청번호 String 36

A.12. ChargeInfo

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

A.13. JoinForm

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

A.14. CorpInfo

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

A.15. ContactInfo

순번 변수명 항목명 타입 길이 필수 비고
1 id 아이디 String 50 O 6자 이상 50자 미만
2 pwd 비밀번호 String 20 O 6자 이상 20자 미만
3 personName 담당자 성명 String 100 O
4 tel 담당자 연락처 String 20 -
5 hp 담당자 휴대폰번호 String 20 -
6 fax 담당자 팩스번호 String 20 -
7 email 담당자 이메일 String 100 O
8 regDT 등록일시 String 14 -
9 searchAllAllowYN 담당자 조회권한 설정 Boolean - O 회사조회(true) : 모든 담당자의 카카오톡 전송내역 조회가능
개인조회(false) : 해당 담당자 계정으로 전송한 카카오톡 전송내역 조회가능
10 mgrYN 관리자 여부 Boolean - O true-관리자 / false-사용자
11 state 상태 Integer 1 - 0–승인대기 / 1–사용중