전송결과
1. GetMessages - 전송내역 확인 (접수번호)
섹션 제목: “1. GetMessages - 전송내역 확인 (접수번호)”팝빌에서 반환받은 접수번호를 통해 문자 전송상태 및 결과를 확인합니다.
List<MessageResult> GetMessages(string CorpNum, string receiptNum, string UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | receiptNum | string | 18 | Y | 팝빌에서 할당한 접수번호 |
| 3 | UserID | string | 50 | N | 팝빌회원 아이디 |
List<MessageResult>
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | subject | string | 64 | 메시지 제목 (단위 : byte) 메시지 길이가 90byte 초과한 경우에만 적용 2byte : 한글, 한자, 특수문자 / 1byte : 영문, 숫자, 공백 |
| 2 | content | string | - | 메시지 내용 (단위 : byte) 단문 : 90byte 이하 / 장문 : 2,000byte 이하 2byte : 한글, 한자, 특수문자 / 1byte : 영문, 숫자, 공백 |
| 3 | sendNum | string | 20 | 발신번호 |
| 4 | senderName | string | 70 | 발신자명 |
| 5 | receiveNum | string | 20 | 수신번호 |
| 6 | receiveName | string | 70 | 수신자명 |
| 7 | receiptDT | string | 14 | 접수일시 형식 : yyyyMMddHHmmss |
| 8 | sendDT | string | 14 | 전송일시 형식 : yyyyMMddHHmmss |
| 9 | resultDT | string | 14 | 전송결과 수신일시 형식 : yyyyMMddHHmmss |
| 10 | reserveDT | string | 14 | 예약일시 형식 : yyyyMMddHHmmss |
| 11 | state | string | 1 | 상태코드 |
| 12 | result | string | 3 | 결과코드 |
| 13 | type | string | 3 | 메시지 타입
|
| 14 | tranNet | string | 3 | 전송처리 이동통신사명 |
| 15 | receiptNum | string | 18 | 접수번호 |
| 16 | requestNum | string | 36 | 요청번호 |
| 17 | interOPRefKey | string | 20 | 파트너 지정키 문자 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | Message | string | - | API 처리 실패에 대한 오류메시지 |
2. GetMessagesRN - 전송내역 확인 (요청번호)
섹션 제목: “2. GetMessagesRN - 전송내역 확인 (요청번호)”파트너가 할당한 요청번호를 통해 문자 전송상태 및 결과를 확인합니다.
List<MessageResult> GetMessagesRN(string CorpNum, string requestNum, string UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | requestNum | string | 36 | Y | 파트너가 할당한 요청번호 |
| 3 | UserID | string | 50 | N | 팝빌회원 아이디 |
List<MessageResult>
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | subject | string | 64 | 메시지 제목 (단위 : byte) 메시지 길이가 90byte 초과한 경우에만 적용 2byte : 한글, 한자, 특수문자 / 1byte : 영문, 숫자, 공백 |
| 2 | content | string | - | 메시지 내용 (단위 : byte) 단문 : 90byte 이하 / 장문 : 2,000byte 이하 2byte : 한글, 한자, 특수문자 / 1byte : 영문, 숫자, 공백 |
| 3 | sendNum | string | 20 | 발신번호 |
| 4 | senderName | string | 70 | 발신자명 |
| 5 | receiveNum | string | 20 | 수신번호 |
| 6 | receiveName | string | 70 | 수신자명 |
| 7 | receiptDT | string | 14 | 접수일시 형식 : yyyyMMddHHmmss |
| 8 | sendDT | string | 14 | 전송일시 형식 : yyyyMMddHHmmss |
| 9 | resultDT | string | 14 | 전송결과 수신일시 형식 : yyyyMMddHHmmss |
| 10 | reserveDT | string | 14 | 예약일시 형식 : yyyyMMddHHmmss |
| 11 | state | string | 1 | 상태코드 |
| 12 | result | string | 3 | 결과코드 |
| 13 | type | string | 3 | 메시지 타입
|
| 14 | tranNet | string | 3 | 전송처리 이동통신사명 |
| 15 | receiptNum | string | 18 | 접수번호 |
| 16 | requestNum | string | 36 | 요청번호 |
| 17 | interOPRefKey | string | 20 | 파트너 지정키 문자 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | Message | string | - | API 처리 실패에 대한 오류메시지 |
3. Search - 전송내역 목록 조회
섹션 제목: “3. Search - 전송내역 목록 조회”검색조건에 해당하는 문자 전송내역을 조회합니다. (조회기간 단위 : 최대 2개월)
- 문자 접수일시로부터 12개월 이내 접수건만 조회할 수 있습니다.
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
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 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 | bool? | - | N | 예약여부
기본값 : 전체조회 |
| 7 | SenderYN | bool? | - | N | 개인조회 여부
|
| 8 | Page | int? | - | N | 목록 페이지번호
기본값 : 1 |
| 9 | PerPage | int? | - | N | 페이지당 표시할 목록 건수 최대 : 1,000건
기본값 : 500건 |
| 10 | Order | string | 1 | N | 문자 접수일시를 기준으로 하는 목록 정렬 방향
|
| 11 | QString | string | - | N | 조회 검색어(발신자명, 수신자명, 수신번호)
기본값 : 전체조회 |
| 12 | UserID | string | 50 | N | 팝빌회원 아이디 |
MSGSearchResult
| 순번 | 변수명 | 타입 | 길이 | 설명 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | code | int | - | API 처리에 대한 응답코드
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 2 | message | string | - | API 처리에 대한 응답메시지 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3 | total | int | - | 총 검색결과 건수 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 4 | perPage | int | - | 페이지당 목록 건수 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 5 | pageNum | int | - | 페이지 번호 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 6 | pageCount | int | - | 페이지 개수 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 7 | list | 1,000 | 전송결과 정보 최대 : 1,000개 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
List<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에서만 유효한 세션을 포함하고 있습니다.
string GetSentListURL(string CorpNum, string UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | UserID | string | 50 | Y | 팝빌회원 아이디 |
string - 요청에 대한 응답 URL
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | Message | string | - | API 처리 실패에 대한 오류메시지 |
5. GetAutoDenyList - 080 수신거부 목록 확인
섹션 제목: “5. GetAutoDenyList - 080 수신거부 목록 확인”전용 080 번호에 등록된 수신거부 목록을 반환합니다.
- 080 수신 거부 서비스는 광고 문자 메시지에만 적용되며, 일반 문자 메시지에는 적용되지 않습니다.
List<AutoDeny> GetAutoDenyList(string CorpNum, string UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | UserID | string | 50 | N | 팝빌회원 아이디 |
List<AutoDeny>
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | number | string | 20 | 수신거부번호 |
| 2 | regDT | string | 14 | 등록일시 형식 : yyyyMMddHHmmss |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | Message | string | - | API 처리 실패에 대한 오류메시지 |
6. CheckAutoDenyNumber - 080 번호 확인
섹션 제목: “6. CheckAutoDenyNumber - 080 번호 확인”팝빌회원에 등록된 080 수신거부 번호 정보를 확인합니다.
AutoDenyNumberInfo CheckAutoDenyNumber(string CorpNum, string UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | string | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | UserID | string | 50 | N | 팝빌회원 아이디 |
AutoDenyNumberInfo
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | smsdenyNumber | string | 20 | 전용 080 번호 |
| 2 | regDT | string | 14 | 등록일시 형식 : yyyyMMddHHmmss |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | Message | string | - | API 처리 실패에 대한 오류메시지 |