전송결과
1. GetMessages - 전송내역 확인 (접수번호)
섹션 제목: “1. GetMessages - 전송내역 확인 (접수번호)”팝빌에서 반환받은 접수번호를 통해 문자 전송상태 및 결과를 확인합니다.
subroutine getmessageresult(string corpnum, string receiptnum, ref messageresult ref_result[]) throws popbillexceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | corpnum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 2 | receiptnum | string | 18 | Y | 팝빌에서 할당한 접수번호 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3 | ref_result | - | Y | 서브루틴 반환 결과값 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ref MessageResult[ ]
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
messageresult[ ] - 요청 파라미터의 ref_result 확인
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | string | - | API 처리 실패에 대한 오류메시지 |
2. GetMessagesRN - 전송내역 확인 (요청번호)
섹션 제목: “2. GetMessagesRN - 전송내역 확인 (요청번호)”파트너가 할당한 요청번호를 통해 문자 전송상태 및 결과를 확인합니다.
subroutine getmessageresultrn(string corpnum, string requestnum, ref messageresult ref_result[]) throws popbillexceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | corpnum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 2 | requestnum | string | 36 | Y | 파트너가 할당한 요청번호 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3 | ref_result | - | Y | 서브루틴 반환 결과값 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ref MessageResult[ ]
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
messageresult[ ] - 요청 파라미터의 ref_result 확인
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | string | - | API 처리 실패에 대한 오류메시지 |
3. Search - 전송내역 목록 조회
섹션 제목: “3. Search - 전송내역 목록 조회”검색조건에 해당하는 문자 전송내역을 조회합니다. (조회기간 단위 : 최대 2개월)
- 문자 접수일시로부터 12개월 이내 접수건만 조회할 수 있습니다.
function msgsearchresult search(string corpnum, string sdate, string edate, string state[], string item[], boolean reserveyn, boolean senderyn, string order, int page, int perpage, string qstring) throws popbillexception매개변수 Page, PerPage, Order를 이용하여 페이징 기능을 구현할 수 있습니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | corpnum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | sDate | string | 8 | Y | 검색 시작일자 형식 : yyyyMMdd |
| 3 | eDate | string | 8 | Y | 검색 종료일자 형식 : yyyyMMdd |
| 4 | state | string[ ] | - | Y | 전송상태 (다중 선택 가능)
|
| 5 | item | string[ ] | - | N | 검색대상 (다중 선택 가능)
기본값 : 전체조회 |
| 6 | reserveyn | boolean | - | N | 예약여부
기본값 : 전체조회 |
| 7 | senderyn | boolean | - | N | 개인조회 여부
|
| 8 | order | string | 1 | Y | 문자 접수일시를 기준으로 하는 목록 정렬 방향
|
| 9 | page | int | - | N | 목록 페이지번호
기본값 : 1 |
| 10 | perpage | int | - | N | 페이지당 표시할 목록 건수 최대 : 1,000건
기본값 : 500건 |
| 11 | qstring | string | - | N | 조회 검색어(발신자명, 수신자명, 수신번호)
기본값 : 전체조회 |
MSGSearchResult
| 순번 | 변수명 | 타입 | 길이 | 설명 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | code | string | - | API 처리에 대한 응답코드
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 2 | message | string | - | API 처리에 대한 응답메시지 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3 | total | string | - | 총 검색결과 건수 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 4 | perPage | string | - | 페이지당 목록 건수 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 5 | pageNum | string | - | 페이지 번호 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 6 | pageCount | string | - | 페이지 개수 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 7 | list | - | 전송결과 정보 최대 : 1,000개 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MessageResult[ ]
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | string | - | API 처리 실패에 대한 오류메시지 |
4. GetSentListURL - 문자 전송내역 팝업 URL
섹션 제목: “4. GetSentListURL - 문자 전송내역 팝업 URL”
문자 전송내역 팝업 URL을 반환합니다.
- 권장 사이즈 : width = 1,350px (최소 1,000px) / height = 800px
- 반환되는 URL은 30초 동안만 사용이 가능합니다.
- 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.
function string getSentListURL(string corpnum, string userid) throws popbillexceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | corpnum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | userid | string | 50 | N | 팝빌회원 아이디 |
string - 요청에 대한 응답 URL
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | string | - | API 처리 실패에 대한 오류메시지 |
5. GetAutoDenyList - 080 수신거부 목록 확인
섹션 제목: “5. GetAutoDenyList - 080 수신거부 목록 확인”전용 080 번호에 등록된 수신거부 목록을 반환합니다.
- 080 수신 거부 서비스는 광고 문자 메시지에만 적용되며, 일반 문자 메시지에는 적용되지 않습니다.
subroutine getautodenylist(string corpnum, ref autodeny ref_list[]) throws popbillexceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | corpnum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | ||||||||||||||||||
| 2 | ref_list | - | Y | 서브루틴 반환 결과값 | |||||||||||||||||||
ref AutoDeny[ ]
| |||||||||||||||||||||||
autodeny[ ] - 요청 파라미터의 ref_list 확인
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | string | - | API 처리 실패에 대한 오류메시지 |