본문
무선통신 API 규격
기본정보
API코드
WC001
API URL 주소
/v1/comms/member
API아이디
무선통신-001
API명
고객정보 조회
HTTP메서드명
POST
사용여부
예
API제공자명
통신업권
API요청자명
정보수신자
HTTP요청유형명
application/json; charset=UTF-8
HTTP응답유형명
application/json; charset=UTF-8
API설명
통신서비스를 계약한 정보주체의 계약관리번호 조회
• Pagination, 계약관리번호 기준 오름차순
• (기준시점) 현재 기준
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 정보요청용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Type | API 유형 | 예 | String(2) | 정기적/비정기적 전송 API 유형 ( 01: 정기적, 02: 비정기적 ) |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | search_timestamp | 조회일시 | 아니오 | String(14) | 요청자가 처리한 마지막 API 처리시각(YYYYMMDDhhmmss) 최초 호출값은 0, 이후에는 마지막 호출 시 search_timestamp 응답값 |
| Body | next_page | 다음 페이지 기준개체 식별자 | 아니오 | String(1000) | 다음 페이지 요청을 위한 기준개체(설정 시 해당 개체 후 limit개 반환) 최초 호출 시 값이 없고, 이후 요청 시 응답값의 다음페이지 기준개체 사용 - Pagination, 계약관리번호 기준 오름차순 |
| Body | limit | 최대조회갯수 | 예 | String(3) | 최대값 500 |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메시지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
| Body | search_timestamp | 조회일시 | 아니오 | String(14) | API 처리 시점의 현재시각을 설정하여 회신 |
| Body | next_page | 다음 페이지 기준개체 식별자 | 아니오 | String(1000) | 다음 페이지 요청을 위한 기준개체의 식별자 (다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신) |
| Body | ctrt_list_cnt | 계약목록개수 | 예 | String(3) | 계약내역목록의 총 개수 |
| Body | ctrt_dsctn_list | 계약내역목록 | 예 | Object | 조회기간에 해당하는 모든 계약 내역 데이터를 포함하는 배열형 객체 |
| Body | --ctrt_mng_no | 계약관리번호 | 예 | String(50) | 정보전송자가 각 통신 회선을 식별하기 위해 정보주체에게 부여한 고유번호 식별자(해시 가능) |
| Body | --join_no | 가입번호 | 예 | String(20) | 정보주체의 통신회선에 할당된 가입번호 (마스킹 가능) |
| Body | --cmmn_se | 통신구분 | 예 | String(2) | 정보주체가 가입한 통신 서비스 상품의 구분(코드) 01: 휴대폰(이동단말기) |
| Body | --join_se | 가입구분 | 예 | String(2) | 정보주체의 가입 상태를 나타내는 구분(코드) 01: 정상/ 02: 고객정지/ 03: 연체정지/ 04: 기타 |
기본정보
API코드
WC002
API URL 주소
/v1/comms/mobile-join
API아이디
무선통신-002
API명
가입정보 조회
HTTP메서드명
POST
사용여부
예
API제공자명
통신업권
API요청자명
정보수신자
HTTP요청유형명
application/json; charset=UTF-8
HTTP응답유형명
application/json; charset=UTF-8
API설명
계약관리번호 기준 현재 시점의 요금제 가입정보 조회
• (기준시점) 현재 기준
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 정보요청용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Type | API 유형 | 예 | String(2) | 정기적/비정기적 전송 API 유형 ( 01: 정기적, 02: 비정기적 ) |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | search_timestamp | 조회일시 | 아니오 | String(14) | 가장 최근 조회한 시간 |
| Body | ctrt_mng_no | 계약관리번호 | 예 | String(50) | 정보전송자가 정보주체에게 부여한 통신회선 식별자 |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메시지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
| Body | search_timestamp | 조회일시 | 아니오 | String(14) | API 처리 시점의 현재시각을 설정하여 회신 |
| Body | srvc_plan_nm | 서비스요금제명 | 예 | String(200) | 통신사업체가 제공하는 서비스 요금제명 (예: 5G 슈퍼 요금제, LTE 요금제, 가족 요금제, 학생 요금제 등 ) |
기본정보
API코드
WC003
API URL 주소
/v1/comms/mobile-usage
API아이디
무선통신-003
API명
이용정보 조회
HTTP메서드명
POST
사용여부
예
API제공자명
통신업권
API요청자명
정보수신자
HTTP요청유형명
application/json; charset=UTF-8
HTTP응답유형명
application/json; charset=UTF-8
API설명
정보주체가 가입한 통신서비스의 월별 이용량 정보 조회
• (기준시점) FROM과 TO를 확인하여 해당 기간의 정보를 회신(전월부터 최대 1년전까지)
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 정보요청용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Type | API 유형 | 예 | String(2) | 정기적/비정기적 전송 API 유형 ( 01: 정기적, 02: 비정기적 ) |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | search_timestamp | 조회일시 | 아니오 | String(14) | 가장 최근 조회한 시간 |
| Body | ctrt_mng_no | 계약관리번호 | 예 | String(50) | 정보전송자가 정보주체에게 부여한 통신회선 식별자 |
| Body | bgng_ym | 시작연월 | 예 | String(6) | 조회 시작월(YYYYMM) |
| Body | end_ym | 종료연월 | 예 | String(6) | 조회 종료월(YYYYMM) |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메시지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
| Body | search_timestamp | 조회일시 | 아니오 | String(14) | API 처리 시점의 현재시각을 설정하여 회신 |
| Body | srvc_utztn_list_cnt | 서비스이용목록개수 | 예 | String(3) | 서비스이용목록의 개수 |
| Body | srvc_utztn_dsctn_list | 서비스이용내역목록 | 예 | Object | 조회기간 동안의 서비스 이용내역을 포함하는 데이터 항목의 배열형 객체 |
| Body | --srvc_utztn_ym | 서비스이용연월 | 예 | String(6) | 서비스 이용연월(YYYYMM) |
| Body | --srvc_voice_utztn_qy | 서비스음성이용량 | 예 | Integer(5) | 해당 연월에 발신으로 사용한 음성서비스 이용량(단위:분) |
| Body | --srvc_ltr_utztn_qy | 서비스문자이용량 | 예 | Integer(5) | 해당 연월에 발신으로 사용한 문자서비스 이용량(단위:개) |
| Body | --srvc_data_utztn_qy | 서비스데이터이용량 | 예 | Integer(10) | 해당 연월에 사용한 데이터 서비스 이용량(단위:KB) |
기본정보
API코드
WC004
API URL 주소
/v1/comms/mobile-bills
API아이디
무선통신-004
API명
청구정보 조회
HTTP메서드명
POST
사용여부
예
API제공자명
통신업권
API요청자명
정보수신자
HTTP요청유형명
application/json; charset=UTF-8
HTTP응답유형명
application/json; charset=UTF-8
API설명
가입된 통신서비스의 요금 청구 정보 조회
• (기준시점) FROM과 TO를 확인하여 해당 기간의 정보를 회신(전월부터 최대 1년전까지)
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 정보요청용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Type | API 유형 | 예 | String(2) | 정기적/비정기적 전송 API 유형 ( 01: 정기적, 02: 비정기적 ) |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | search_timestamp | 조회일시 | 아니오 | String(14) | 가장 최근 조회한 시간 |
| Body | ctrt_mng_no | 계약관리번호 | 예 | String(50) | 정보전송자가 정보주체에게 부여한 통신회선 식별자 |
| Body | bgng_ym | 시작연월 | 예 | String(6) | 조회 시작월(YYYYMM) |
| Body | end_ym | 종료연월 | 예 | String(6) | 조회 종료월(YYYYMM) |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메시지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
| Body | search_timestamp | 조회일시 | 아니오 | String(14) | API 처리 시점의 현재시각을 설정하여 회신 |
| Body | bll_list_cnt | 청구목록개수 | 예 | String(3) | 청구내역목록의 개수 |
| Body | bll_dsctn_list | 청구내역목록 | 예 | Object | 조회기간 동안의 청구내역을 포함하는 데이터 항목의 배열형 객체 |
| Body | --bll_ym | 청구연월 | 예 | String(6) | 청구정보의 대상연월(YYYYMM) |
| Body | --bll_amt | 청구금액 | 예 | Integer(15) | 청구연월에 청구되는 요금액 (단위: 원) |
| Body | --pay_prnmnt_ymd | 납부예정일자 | 예 | Date(8) | 청구정보에 등록된 납부 예정일자(YYYYMMDD) |
기본정보
API코드
WC005
API URL 주소
/v1/comms/mobile-payments
API아이디
무선통신-005
API명
납부정보 조회
HTTP메서드명
POST
사용여부
예
API제공자명
통신업권
API요청자명
정보수신자
HTTP요청유형명
application/json; charset=UTF-8
HTTP응답유형명
application/json; charset=UTF-8
API설명
가입된 통신서비스 요금 청구에 대한 납부 정보 조회
• (기준시점) FROM과 TO를 확인하여 해당 기간의 정보를 회신(전월부터 최대 1년전까지)
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 정보요청용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Type | API 유형 | 예 | String(2) | 정기적/비정기적 전송 API 유형 ( 01: 정기적, 02: 비정기적 ) |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | search_timestamp | 조회일시 | 아니오 | String(14) | 가장 최근 조회한 시간 |
| Body | ctrt_mng_no | 계약관리번호 | 예 | String(50) | 정보전송자가 정보주체에게 부여한 통신회선 식별자 |
| Body | bgng_ym | 시작연월 | 예 | String(6) | 조회 시작월(YYYYMM) |
| Body | end_ym | 종료연월 | 예 | String(6) | 조회 종료월(YYYYMM) |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메시지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
| Body | search_timestamp | 조회일시 | 아니오 | String(14) | API 처리 시점의 현재시각을 설정하여 회신 |
| Body | pay_list_cnt | 납부목록개수 | 예 | String(3) | 납부내역목록의 개수 |
| Body | pay_dsctn_list | 납부내역목록 | 예 | Object | 조회기간 동안의 납부내역을 포함하는 데이터 항목의 배열형 객체 |
| Body | --pay_ym | 납부연월 | 예 | String(6) | 납부정보의 대상연월(YYYYMM) |
| Body | --pay_amt | 납부금액 | 예 | Integer(15) | 납부연월에 납부한 납부금액(단위: 원) |
| Body | --pay_mn | 납부수단 | 아니오 | String(2) | 실제 납부방법(미납시 공란) 01:신용카드 / 02:계좌이체 / 03:지로 / 99:기타 |