연동매뉴얼

Index

1. 카카오톡 채널 관리

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

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

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

Function GetPlusFriendMgtURL(CorpNum, UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

Err

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

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

Function ListPlusFriendID(CorpNum)

Parameters

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

Return

PlusFriend[ ]

Throws

Err

2. 발신번호 관리

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

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

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

Function GetSenderNumberMgtURL(CorpNum, UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

Err

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

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

Function GetSenderNumberList(CorpNum)

Parameters

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

Return

SenderNumber[ ]

Throws

Err

3. 알림톡 템플릿 관리

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

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

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

Function GetATSTemplateMgtURL(CorpNum, UserID)
유의사항

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

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

Err

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

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

Function ListATSTemplate(CorpNum)

Parameters

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

Return

KakaoATSTemplate[ ]

Throws

Err

4. 카카오톡 전송

접수번호(recieptNum)

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

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

4.1. SendATS - 알림톡 전송

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

ㆍ모든 수신자에게 동일한 내용을 전송하거나(동보전송), 수신자마다 개별 내용을 전송할 수 있습니다(대량전송). (최소 1건, 최대 1,000건)

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

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

Parameters

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

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)

Parameters

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

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)

Parameters

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

Return

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

Throws

Err

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

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

Function CancelReserve(CorpNum, ReceiptNum, UserID)

Parameters

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

Return

Response

Throws

Err

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

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

Function CancelReserveRN(CorpNum, RequestNum, UserID)

Parameters

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

Return

Response

Throws

Err

5. 정보확인

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

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

Function GetMessages(CorpNum, ReceiptNum, UserID)

Parameters

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

Return

KakaoSentResult

Throws

Err

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

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

Function GetMessagesRN(CorpNum, RequestNum, UserID)

Parameters

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

Return

KakaoSentResult

Throws

Err

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

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

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

Function Search(CorpNum, SDate, EDate, Item, ReserveYN, SenderYN, Order, Page, PerPage, QString)

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

Parameters

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

Return

KakaoSearchResult

Throws

Err

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

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

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

Function GetSentListURL(CorpNum, UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

Err

6. 포인트 관리

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

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

Function GetBalance(CorpNum)

Parameters

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

Return

String - 연동회원 잔여포인트

Throws

Err

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

Err

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

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

Function GetPartnerBalance(CorpNum)

Parameters

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

Return

String - 파트너 잔여포인트

Throws

Err

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

Err

6.5. GetUnitCost - 전송 단가 확인

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

Function GetUnitCost(CorpNum, KType)

Parameters

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

Return

String - 카카오톡 전송 단가

Throws

Err

6.6. GetChargeInfo - 과금정보 확인

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

Function GetChargeInfo(CorpNum, KType, UserID)

Parameters

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

Return

ChargeInfo

Throws

Err

7. 회원정보

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

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

Function CheckIsMember(CorpNum, linkID)

Parameters

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

Return

Response

Throws

Err

7.2. CheckID - 아이디 중복 확인

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

Function CheckID(id)

Parameters

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

Return

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

Throws

Err

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

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

Function JoinMember(JoinInfo)

Parameters

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

Return

Response

Throws

Err

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

Err

7.5. GetCorpInfo - 회사정보 확인

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

Function GetCorpInfo(CorpNum, UserId)

Parameters

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

Return

CorpInfo

Throws

Err

7.6. UpdateCorpInfo - 회사정보 수정

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

Function UpdateCorpInfo(CorpNum, corpInfo, UserId)

Parameters

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

Return

Response

Throws

Err

7.7. RegistContact - 담당자 등록

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

Function RegistContact(CorpNum, contInfo, UserId)

Parameters

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

Return

Response

Throws

Err

7.8. ListContact - 담당자 목록 확인

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

Function ListContact(CorpNum, UserID)

Parameters

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

Return

ContactInfo[ ]

Throws

Err

7.9. UpdateContact - 담당자 정보 수정

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

Function UpdateContact(CorpNum, contInfo, UserId)

Parameters

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

Return

Response

Throws

Err

A. 객체정보

A.1. Response

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

A.2. Err

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

A.3. SenderNumber

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

A.4. PlusFriend

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

A.5. KakaoATSTemplate

순번 변수명 항목명 타입 길이 비고
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 O
2 rcvnm 수신자명 String 70 -
3 msg 알림톡/친구톡 내용 String 1000/400 △ 다건전송시 필수, 알림톡/친구톡(텍스트) 전송시 최대 1,000자 / 친구톡(이미지) 전송시 최대 400자
4 altmsg 대체문자 내용 String 2000 -
5 interOPRefKey 파트너 지정 키 String 20 - 알림톡/친구톡 전송시 파트너가 개별건마다 입력할 수 있는 값

A.8. KakaoSearchResult

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

A.9. KakaoSentResult

순번 변수명 항목명 타입 길이 비고
1 contentType 카카오톡 유형 Integer - 1 : (알림톡) / 2 : (친구톡 텍스트) / 3 : (친구톡 이미지) 중 반환
2 templateCode 템플릿 코드 String - 알림톡 전송시 사용한 코드값
3 plusFriendID 카카오톡 채널 검색용 아이디 String - 알림톡/친구톡 전송시 사용한 아이디값
4 sendNum 발신번호 String 20
5 altContent [동보] 대체문자 내용 String 2000
6 altSendType 대체문자 유형 String - "" / "C" / "A" 중 반환
└ "" = 미전송, C = 알림톡 또는 친구톡 내용으로 전송, A = 대체문자 내용으로 전송
※ 대체문자의 경우, 포토문자(MMS) 형식은 지원하고 있지 않습니다.
7 reserveDT 예약일시 String -
8 adsYN 광고전송 여부 boolean - True : (광고) / False : (일반) 중 반환
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 전송결과 정보 KakaoSentDetail[ ] [배열] 최대 1,000개

A.10. KakaoButton

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

A.11. KakaoSentDetail

순번 변수명 항목명 타입 길이 비고
1 state 전송상태 코드 Integer 1 알림톡/친구톡 전송 작업 상태를 확인하는 값
└ [참고] 전송 상태 및 결과 코드
2 sendDT 전송일시 String -
3 result 전송결과 코드 Integer 3 {@no.3 state} = 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
16 interOPRefKey 파트너 지정 키 String 20 알림톡/친구톡 대량/동보전송시 파트너가 입력한 값

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 △ 담당자 추가시 필수, 6자 이상 20자 미만
3 personName 담당자 성명 String 100 O
4 tel 담당자 연락처(전화번호) String 20 O
5 hp 담당자 휴대폰번호 String 20 -
6 fax 담당자 팩스번호 String 20 -
7 email 담당자 이메일 String 100 O
8 regDT 등록일시 String 14 X
9 searchAllAllowYN 담당자 조회권한 설정 boolean - - True : (회사권한 - 모든 알림톡/친구톡 관리가능) / False : (개인권한 - 해당 계정으로 접수한 알림톡/친구톡 관리가능) 중 입력 또는 반환
※ 미입력시 기본값 False 처리
10 mgrYN 관리자 여부 boolean - X True : (관리자) / False : (일반사용자) 중 반환
※ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
11 state 계정상태 Integer 1 X 0 : (승인대기 - 관리자의 승인 후 이용가능) / 1 : (사용중) 중 반환