5. 정보확인
5.1. GetMessages - 알림톡/친구톡 전송내역 확인
- 팝빌에서 반환받은 접수번호를 통해 알림톡/친구톡 전송상태 및 결과를 확인합니다.
Function GetMessages(CorpNum, ReceiptNum, UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| ReceiptNum | String | 18 | Y | 팝빌에서 할당한 접수번호 | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
5.2. GetMessagesRN - 알림톡/친구톡 전송내역 확인 (요청번호 할당)
- 파트너가 할당한 요청번호를 통해 알림톡/친구톡 전송상태 및 결과를 확인합니다.
Function GetMessagesRN(CorpNum, RequestNum, UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| RequestNum | String | 36 | Y | 파트너가 할당한 요청번호 | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
5.3. Search - 전송내역 목록 조회
검색조건에 해당하는 카카오톡 전송내역을 조회합니다. (조회기간 단위 : 최대 2개월)
- 카카오톡 접수일시로부터 6개월 이내 접수건만 조회할 수 있습니다.
Function Search(CorpNum, SDate, EDate, Item, ReserveYN, SenderYN, Order, Page, PerPage, QString)- 매개변수 Page, PerPage, Order를 이용하여 페이징 기능을 구현할 수 있습니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| SDate | String | 8 | Y |
검색 시작일자
형식 : yyyyMMdd
|
|
| EDate | String | 8 | Y |
검색 종료일자
형식 : yyyyMMdd
|
|
| State | Arrays | Y |
전송상태 (다중 선택 가능)
|
||
| Item | Arrays | N |
검색대상 (다중 선택 가능)
ATS알림톡
FTS친구톡(텍스트)
FMS친구톡(이미지)
기본값 : 전체조회
|
||
| ReserveYN | String | 1 | N |
전송유형별 조회 (택 1)
0즉시전송건
1예약전송건
기본값 : 전체조회
|
|
| SenderYN | boolean | - | N |
사용자권한별 조회
True해당 담당자 계정으로 접수한 카카오톡만 조회 (개인권한)
False접수한 카카오톡 전체 조회 (관리자권한) : 기본값
|
|
| Order | String | 1 | N |
알림톡/친구톡 접수일시를 기준으로 하는 목록 정렬 방향
D내림차순 : 기본값
A오름차순
|
|
| Page | Integer | - | N |
목록 페이지번호
기본값 : 1
|
|
| PerPage | Integer | - | N |
페이지당 표시할 목록 건수
최대 : 1,000건
기본값 : 500건
|
|
| QString | String | 70 | N |
조회 검색어(수신자명)
기본값 : 전체조회
|
|
Return
Throws
5.4. GetSentListURL - 카카오톡 전송내역 팝업 URL
- 카카오톡 전송내역 팝업 URL을 반환합니다.
- 권장 사이즈 : width = 1,350px (최소 1,000px) / height = 800px
- 반환되는 URL은 30초 동안만 사용이 가능합니다.
- 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.
Function GetSentListURL(CorpNum, UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL