3. 정보확인
3.1. GetMessages - 전송내역 확인 (접수번호)
- 팝빌에서 반환받은 접수번호를 통해 문자 전송상태 및 결과를 확인합니다.
List<MessageResult> GetMessages(string CorpNum, string receiptNum, string UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| receiptNum | string | 18 | Y | 문자 전송요청시 팝빌로부터 반환 받은 접수번호 | |
| UserID | string | 50 | N | 팝빌회원 아이디 |
Return
Throws
3.2. GetMessagesRN - 전송내역 확인 (요청번호)
- 파트너가 할당한 요청번호를 통해 문자 전송상태 및 결과를 확인합니다.
List<MessageResult> GetMessagesRN(string CorpNum, string requestNum, string UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| requestNum | string | 36 | Y | 문자 전송요청시 파트너가 할당한 요청번호 | |
| UserID | string | 50 | N | 팝빌회원 아이디 |
Return
Throws
3.3. Search - 전송내역 목록 조회
-
검색조건에 해당하는 문자 전송내역을 조회합니다. (조회기간 단위 : 최대 2개월)
※ 문자 접수일시로부터 6개월 이내 접수건만 조회할 수 있습니다.
MSGSearchResult Search(string CorpNum, string SDate, string EDate, string[] State = null, string[] Item = null, bool? ReserveYN = false, bool? SenderYN = false, int? Page = null, int? PerPage = null, string Order = null, string QString = null, string UserID = null)- 페이지 관련 항목(Page, PerPage, Order)을 활용하여 문자 전송내역 목록을 구현할 수 있습니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| SDate | string | 8 | Y |
조회 기간의 시작일자
형식 : yyyyMMdd
|
|
| EDate | string | 8 | Y |
조회 기간의 종료일자
형식 : yyyyMMdd
|
|
| State | string[ ] | N |
전송상태 (다중 선택 가능)
기본값 : 전체조회
|
||
| Item | string[ ] | N |
검색대상 (다중 선택 가능)
SMS단문
LMS장문
MMS포토문자
기본값 : 전체조회
|
||
| ReserveYN | bool? | - | N |
예약여부
true예약전송건
false전체조회 : 기본값
|
|
| SenderYN | bool? | - | N |
개인조회 여부
true해당 담당자 계정으로 접수한 문자만 조회 (개인권한)
false접수한 문자 전체 조회 (관리자권한) : 기본값
|
|
| Page | int? | - | N |
목록 페이지번호
기본값 : 1
|
|
| PerPage | int? | - | N |
페이지당 표시할 목록 건수
최대 : 1,000건
기본값 : 500건
|
|
| Order | string | 1 | N |
문자 접수일시를 기준으로 하는 목록 정렬 방향
D내림차순 : 기본값
A오름차순
|
|
| QString | string | - | N |
조회하고자 하는 발신자명 또는 수신자명
기본값 : 전체조회
|
|
| UserID | string | 50 | N | 팝빌회원 아이디 | |
Return
Throws
3.4. GetSentListURL - 문자 전송내역 팝업 URL
- 문자 전송내역 확인 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
string GetSentListURL(string CorpNum, string UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| UserID | string | 50 | Y | 팝빌회원 아이디 |
Return
string - 요청에 대한 응답 URL
Throws
3.5. GetAutoDenyList - 080 수신거부 목록 확인
- 전용 080 번호에 등록된 수신거부 목록을 반환합니다.
List<AutoDeny> GetAutoDenyList(string CorpNum, string UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| UserID | string | 50 | N | 팝빌회원 아이디 |
Return
Throws
3.6. CheckAutoDenyNumber - 080 번호 확인
- 팝빌회원에 등록된 080 수신거부 번호 정보를 확인합니다.
string CheckAutoDenyNumber(string CorpNum, string UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| UserID | string | 50 | N | 팝빌회원 아이디 |