5. 정보확인
5.1. GetMessages - 알림톡/친구톡 전송내역 확인
- 팝빌에서 반환받은 접수번호를 통해 알림톡/친구톡 전송상태 및 결과를 확인합니다.
kakaoService.getMessages(CorpNum, ReceiptNum, UserID, success, error)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| ReceiptNum | string | 18 | Y | 카카오톡 전송 접수시 팝빌로부터 반환받은 접수번호 | |
| UserID | string | 50 | N | 팝빌회원 아이디 | |
| success | function | - | Y | 성공에 대한 콜백 함수 | |
| error | function | - | Y | 실패에 대한 콜백 함수 |
Return
Throws
5.2. GetMessagesRN - 알림톡/친구톡 전송내역 확인 (요청번호 할당)
- 파트너가 할당한 요청번호를 통해 알림톡/친구톡 전송상태 및 결과를 확인합니다.
kakaoService.getMessagesRN(CorpNum, RequestNum, UserID, success, error)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| RequestNum | string | 36 | Y | 카카오톡 전송 접수시 파트너가 할당한 요청번호 | |
| UserID | string | 50 | N | 팝빌회원 아이디 | |
| success | function | - | Y | 성공에 대한 콜백 함수 | |
| error | function | - | Y | 실패에 대한 콜백 함수 |
Return
Throws
5.3. Search - 전송내역 목록 조회
-
검색조건에 해당하는 카카오톡 전송내역을 조회합니다. (조회기간 단위 : 최대 2개월)
※ 카카오톡 접수일시로부터 6개월 이내 접수건만 조회할 수 있습니다.
kakaoService.search(CorpNum, SDate, EDate, State, Item, ReserveYN, SenderYN, Page, PerPage, Order, Qstring, UserID, success, error)- 페이지 관련 항목(Page, PerPage, Order)을 활용하여 카카오톡 전송내역 목록을 구현할 수 있습니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| SDate | string | 8 | Y |
조회 기간의 시작일자
형식 : yyyyMMdd
|
|
| EDate | string | 8 | Y |
조회 기간의 종료일자
형식 : yyyyMMdd
|
|
| State | Array | N |
전송상태 (다중 선택 가능)
기본값 : 전체조회
|
||
| Item | Array | N |
검색대상 (다중 선택 가능)
ATS알림톡
FTS친구톡(텍스트)
FMS친구톡(이미지)
기본값 : 전체조회
|
||
| ReserveYN | string | 1 | N |
전송유형별 조회 (택 1)
0즉시전송건
1예약전송건
기본값 : 전체조회
|
|
| SenderYN | boolean | - | N |
사용자권한별 조회
true해당 담당자 계정으로 접수한 카카오톡만 조회 (개인권한)
false접수한 카카오톡 전체 조회 (관리자권한)
|
|
| Page | number | - | N |
목록 페이지번호
기본값 : 1
|
|
| PerPage | number | - | N |
페이지당 표시할 목록 건수
최대 : 1,000건
기본값 : 500건
|
|
| Order | string | 1 | N |
알림톡/친구톡 접수일시를 기준으로 하는 목록 정렬 방향
D내림차순 : 기본값
A오름차순
|
|
| QString | string | 70 | N |
조회 검색어(수신자명)
기본값 : 전체조회
|
|
| UserID | string | 50 | N | 팝빌회원 아이디 | |
| success | function | - | Y | 성공에 대한 콜백 함수 | |
| error | function | - | Y | 실패에 대한 콜백 함수 | |
Return
Throws
5.4. GetSentListURL - 카카오톡 전송내역 팝업 URL
- 카카오톡 전송내역을 확인하는 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
kakaoService.getSentListURL(CorpNum, UserID, success, error)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| UserID | string | 50 | N | 팝빌회원 아이디 | |
| success | function | - | Y | 성공에 대한 콜백 함수 | |
| error | function | - | Y | 실패에 대한 콜백 함수 |
Return
string - 요청에 대한 응답 URL