전송결과
1. GetMessages - 전송내역 확인 (접수번호)
섹션 제목: “1. GetMessages - 전송내역 확인 (접수번호)”팝빌에서 반환받은 접수번호를 통해 문자 전송상태 및 결과를 확인합니다.
Function GetMessages(CorpNum As String, receiptNum As String, Optional UserID As String = "") As CollectionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | receiptNum | String | 18 | Y | 팝빌에서 할당한 접수번호 |
| 3 | UserID | String | 50 | N | 팝빌회원 아이디 |
PBSentMsg
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 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 | 파트너 지정키 문자 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값 |
Err
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | LastErrCode | Long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | LastErrMessage | String | - | API 처리 실패에 대한 오류메시지 |
2. GetMessagesRN - 전송내역 확인 (요청번호)
섹션 제목: “2. GetMessagesRN - 전송내역 확인 (요청번호)”파트너가 할당한 요청번호를 통해 문자 전송상태 및 결과를 확인합니다.
Function GetMessagesRN(CorpNum As String, requestNum As String, Optional UserID As String = "") As CollectionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | requestNum | String | 36 | Y | 파트너가 할당한 요청번호 |
| 3 | UserID | String | 50 | N | 팝빌회원 아이디 |
PBSentMsg
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 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 | 파트너 지정키 문자 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값 |
Err
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | LastErrCode | Long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | LastErrMessage | String | - | API 처리 실패에 대한 오류메시지 |
3. Search - 전송내역 목록 조회
섹션 제목: “3. Search - 전송내역 목록 조회”검색조건에 해당하는 문자 전송내역을 조회합니다. (조회기간 단위 : 최대 2개월)
- 문자 접수일시로부터 12개월 이내 접수건만 조회할 수 있습니다.
Function Search(CorpNum As String, SDate As String, EDate As String, state As Collection, Item As Collection, ReserveYN As Boolean, SenderYN As Boolean, Page As Integer, PerPage As Integer, Order As String, Optional QString As String = "") As PBSearchList매개변수 Page, PerPage, Order를 이용하여 페이징 기능을 구현할 수 있습니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | SDate | String | 8 | Y | 검색 시작일자 형식 : yyyyMMdd |
| 3 | EDate | String | 8 | Y | 검색 종료일자 형식 : yyyyMMdd |
| 4 | state | Collection | - | Y | 전송상태 (다중 선택 가능)
|
| 5 | Item | Collection | - | N | 검색대상 (다중 선택 가능)
기본값 : 전체조회 |
| 6 | ReserveYN | Boolean | - | N | 예약여부
기본값 : 전체조회 |
| 7 | SenderYN | Boolean | - | N | 개인조회 여부
|
| 8 | Page | Integer | - | N | 목록 페이지번호
기본값 : 1 |
| 9 | PerPage | Integer | - | N | 페이지당 표시할 목록 건수 최대 : 1,000건
기본값 : 500건 |
| 10 | Order | String | 1 | Y | 문자 접수일시를 기준으로 하는 목록 정렬 방향
|
| 11 | QString | String | - | N | 조회 검색어(발신자명, 수신자명, 수신번호)
기본값 : 전체조회 |
PBSearchList
| 순번 | 변수명 | 타입 | 길이 | 설명 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | code | Integer | - | API 처리에 대한 응답코드
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 2 | message | String | - | API 처리에 대한 응답메시지 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3 | total | Integer | - | 총 검색결과 건수 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 4 | perPage | Integer | - | 페이지당 목록 건수 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 5 | pageNum | Integer | - | 페이지 번호 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 6 | pageCount | Integer | - | 페이지 개수 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 7 | list | - | 전송결과 정보 최대 : 1,000개 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PBSentMsg[ ]
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Err
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | LastErrCode | Long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | LastErrMessage | String | - | API 처리 실패에 대한 오류메시지 |
4. GetSentListURL - 문자 전송내역 팝업 URL
섹션 제목: “4. GetSentListURL - 문자 전송내역 팝업 URL”
문자 전송내역 팝업 URL을 반환합니다.
- 권장 사이즈 : width = 1,350px (최소 1,000px) / height = 800px
- 반환되는 URL은 30초 동안만 사용이 가능합니다.
- 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.
Function GetSentListURL(CorpNum As String, UserID As String) As StringParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | UserID | String | 50 | N | 팝빌회원 아이디 |
String - 요청에 대한 응답 URL
Err
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | LastErrCode | Long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | LastErrMessage | String | - | API 처리 실패에 대한 오류메시지 |
5. GetAutoDenyList - 080 수신거부 목록 확인
섹션 제목: “5. GetAutoDenyList - 080 수신거부 목록 확인”전용 080 번호에 등록된 수신거부 목록을 반환합니다.
- 080 수신 거부 서비스는 광고 문자 메시지에만 적용되며, 일반 문자 메시지에는 적용되지 않습니다.
Function GetAutoDenyList(CorpNum As String) As CollectionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
PBAutoDenyInfo
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | number | String | 20 | 수신거부번호 |
| 2 | regDT | String | 14 | 등록일시 형식 : yyyyMMddHHmmss |
Err
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | LastErrCode | Long | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | LastErrMessage | String | - | API 처리 실패에 대한 오류메시지 |