전송결과

1. GetMessages - 전송내역 확인 (접수번호)

GET https://popbill-test.linkhub.co.kr/Message/{receiptNum}

팝빌에서 반환받은 접수번호를 통해 문자 전송상태 및 결과를 확인합니다.

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
3	`Accept-Encoding`	N	응답 압축 방식 `gzip`
4	`X-PB-UserID`	N	팝빌회원 아이디

Path 파라미터

순번	변수명	타입	길이	필수	설명
1	`receiptNum`	string	18	Y	팝빌에서 할당한 접수번호

요청 예시

curl --request GET \
  --url 'https://{domain}/Message/{receiptNum}' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번	변수명	타입	길이	설명
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`	number	1	상태코드 [참고] 팝빌 상태코드
12	`result`	number	3	결과코드 [참고] 통신사 결과코드
13	`type`	string	3	메시지 타입 `SMS` 단문 `LMS` 장문 `MMS` 포토문자
14	`tranNet`	string	3	전송처리 이동통신사명
15	`receiptNum`	string	18	접수번호
16	`requestNum`	string	36	요청번호
17	`interOPRefKey`	string	20	파트너 지정키 문자 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

응답 예시

[
    {
        "content": "메시지 내용",
        "sendNum": "16008536",
        "receiveNum": "01012345678",
        "receiptDT": "20251027105030",
        "sendDT": "20251027105033",
        "resultDT": "20251027105035",
        "result": 100,
        "tranNet": "LGT",
        "receiptNum": "025102710000000005",
        "state": 3,
        "type": "SMS"
    }
]

2. GetMessagesRN - 전송내역 확인 (요청번호)

GET https://popbill-test.linkhub.co.kr/Message/Get/{requestNum}

파트너가 할당한 요청번호를 통해 문자 전송상태 및 결과를 확인합니다.

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
3	`Accept-Encoding`	N	응답 압축 방식 `gzip`
4	`X-PB-UserID`	N	팝빌회원 아이디

Path 파라미터

순번	변수명	타입	길이	필수	설명
1	`requestNum`	string	36	Y	파트너가 할당한 요청번호

요청 예시

curl --request GET \
  --url 'https://{domain}/Message/Get/{requestNum}' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번	변수명	타입	길이	설명
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`	number	1	상태코드 [참고] 팝빌 상태코드
12	`result`	number	3	결과코드 [참고] 통신사 결과코드
13	`type`	string	3	메시지 타입 `SMS` 단문 `LMS` 장문 `MMS` 포토문자
14	`tranNet`	string	3	전송처리 이동통신사명
15	`receiptNum`	string	18	접수번호
16	`requestNum`	string	36	요청번호
17	`interOPRefKey`	string	20	파트너 지정키 문자 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

응답 예시

[
    {
        "content": "메시지 내용",
        "sendNum": "16008536",
        "receiveNum": "01012345678",
        "receiptDT": "20251027105545",
        "sendDT": "20251027105548",
        "resultDT": "20251027105551",
        "result": 100,
        "tranNet": "LGT",
        "receiptNum": "025102710000000006",
        "requestNum": "test001234",
        "state": 3,
        "type": "SMS"
    }
]

3. Search - 전송내역 목록 조회

GET https://popbill-test.linkhub.co.kr/Message/Search

검색조건에 해당하는 문자 전송내역을 조회합니다. (조회기간 단위 : 최대 2개월)
문자 접수일시로부터 12개월 이내 접수건만 조회할 수 있습니다.

매개변수 Page, PerPage, Order를 이용하여 페이징 기능을 구현할 수 있습니다.

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
3	`Accept-Encoding`	N	응답 압축 방식 `gzip`
4	`X-PB-UserID`	N	팝빌회원 아이디

Query 파라미터

순번	변수명	타입	길이	필수	설명
1	`SDate`	string	8	Y	검색 시작일자 형식 : yyyyMMdd
2	`EDate`	string	8	Y	검색 종료일자 형식 : yyyyMMdd
3	`State`	string	-	Y	전송상태 (다중 선택 가능) `1` 대기 `2` 성공 `3` 실패 `4` 취소 다중 선택시 콤마(',')로 구분. 예) 1,2
4	`Item`	string	-	N	검색대상 (다중 선택 가능) `SMS` 단문 `LMS` 장문 `MMS` 포토문자 다중 선택시 콤마(',')로 구분. 예) SMS,LMS 기본값 : 전체조회
5	`ReserveYN`	boolean	-	N	예약여부 `true` 예약전송건 `false` 즉시전송건 기본값 : 전체조회
6	`SenderOnly`	boolean	-	N	사용자권한별 조회 `true` 팝빌회원 아이디(UserID)로 전송한 문자만 조회 `false` 전송한 문자 전체 조회 : 기본값
7	`Page`	number	-	N	목록 페이지번호 기본값 : 1
8	`PerPage`	number	-	N	페이지당 표시할 목록 건수 최대 : 1,000건 기본값 : 500건
9	`Order`	string	1	N	문자 접수일시를 기준으로 하는 목록 정렬 방향 `D` 내림차순 : 기본값 `A` 오름차순
10	`QString`	string	-	N	조회 검색어(발신자명, 수신자명, 수신번호) 기본값 : 전체조회

요청 예시

curl --request GET \
  --url 'https://{domain}/Message/Search?SDate={SDate}&EDate={EDate}&State={State}' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번 변수명 타입 길이 설명

code

number

API 처리에 대한 응답코드

1 성공

message

string

API 처리에 대한 응답메시지

total

number

총 검색결과 건수

perPage

number

페이지 당 목록 건수

pageNum

number

페이지 번호

pageCount

number

페이지 개수

array

전송결과 정보

최대 : 1,000건

list

순번	변수명	타입	길이	설명
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`	number	1	상태코드 [참고] 팝빌 상태코드
12	`result`	number	3	결과코드 [참고] 통신사 결과코드
13	`type`	string	3	메시지 타입 `SMS` 단문 `LMS` 장문 `MMS` 포토문자
14	`tranNet`	string	3	전송처리 이동통신사명
15	`receiptNum`	string	18	접수번호
16	`requestNum`	string	36	요청번호
17	`interOPRefKey`	string	20	파트너 지정키 문자 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

응답 예시

{
    "code": 1,
    "total": 19,
    "perPage": 500,
    "pageNum": 1,
    "pageCount": 1,
    "list": [
        {
            "content": "메시지 내용",
            "sendNum": "16008536",
            "receiveNum": "01012345678",
            "receiptDT": "20251027105545",
            "sendDT": "20251027105548",
            "resultDT": "20251027105551",
            "result": 100,
            "tranNet": "LGT",
            "receiptNum": "025102710000000006",
            "requestNum": "test001234",
            "state": 3,
            "type": "SMS"
        }
    ],
    "message": "검색 완료"
}

4. GetSentListURL - 문자 전송내역 팝업 URL

GET https://popbill-test.linkhub.co.kr/Message

문자 전송내역 팝업 URL 미리보기

문자 전송내역 팝업 URL을 반환합니다.

권장 사이즈 : width = 1,350px (최소 1,000px) / height = 800px
반환되는 URL은 30초 동안만 사용이 가능합니다.
반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
3	`Accept-Encoding`	N	응답 압축 방식 `gzip`
4	`X-PB-UserID`	N	팝빌회원 아이디

Query 파라미터

순번	변수명	타입	길이	필수	설명
1	`TG`	string	-	Y	고정값 : BOX

요청 예시

curl --request GET \
  --url 'https://{domain}/Message?TG=BOX' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번	변수명	타입	길이	설명
1	`url`	string	-	문자 전송내역 팝업 URL

응답 예시

{
    "url": "https://test.popbill.com/App/API?T=IRXSGITDREOTPOIRLPUHCB4BSBC4...NX7BMAR3="
}

5. GetAutoDenyList - 080 수신거부 목록 확인

GET https://popbill-test.linkhub.co.kr/Message/Denied

전용 080 번호에 등록된 수신거부 목록을 반환합니다.
080 수신 거부 서비스는 광고 문자 메시지에만 적용되며, 일반 문자 메시지에는 적용되지 않습니다.

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
3	`Accept-Encoding`	N	응답 압축 방식 `gzip`
4	`X-PB-UserID`	N	팝빌회원 아이디

요청 예시

curl --request GET \
  --url 'https://{domain}/Message/Denied' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번	변수명	타입	길이	설명
1	`number`	string	20	수신거부번호
2	`regDT`	string	14	등록일시 형식 : yyyyMMddHHmmss

응답 예시

[
  {
    "number": "0801112222",
    "regDT": "20250206151252"
  }
]

6. CheckAutoDenyNumber - 080 번호 확인

GET https://popbill-test.linkhub.co.kr/Message/AutoDenyNumberInfo

팝빌회원에 등록된 080 수신거부 번호 정보를 확인합니다.

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
3	`Accept-Encoding`	N	응답 압축 방식 `gzip`
4	`X-PB-UserID`	N	팝빌회원 아이디

요청 예시

curl --request GET \
  --url 'https://{domain}/Message/AutoDenyNumberInfo' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번	변수명	타입	길이	설명
1	`smsdenyNumber`	string	20	전용 080 번호
2	`regDT`	string	14	등록일시 형식 : yyyyMMddHHmmss

응답 예시

{
    "smsdenyNumber": "0801112222",
    "regDT": "20250206151252"
}