From a45140a60dd425a330e9753d02c420a1c1be4431 Mon Sep 17 00:00:00 2001 From: "hehihoho3@gmail.com" Date: Thu, 8 May 2025 18:00:47 +0900 Subject: [PATCH] =?UTF-8?q?=EC=95=8C=EB=A6=BC=ED=86=A1=20api=20=EC=98=88?= =?UTF-8?q?=EC=A0=9C=20=EC=B6=94=EA=B0=80=EC=A4=91?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../web/KakaoAlimTalkTemplateController.java | 3 + .../uia/web/EgovMypageRESTAPIController.java | 20 +- .../webapp/WEB-INF/jsp/web/api/at/apiSpec.jsp | 82 ++++ .../WEB-INF/jsp/web/api/at/apiSpec_tab1.jsp | 266 +++++++++++++ .../jsp/web/api/{ => at}/apiSpec_tab2.jsp | 0 .../jsp/web/api/{ => at}/apiSpec_tab3.jsp | 0 .../jsp/web/api/{ => at}/apiSpec_tab4.jsp | 0 .../jsp/web/api/{ => at}/apiSpec_tab5.jsp | 0 .../jsp/web/api/{ => munja}/apiSpec.jsp | 2 +- .../jsp/web/api/{ => munja}/apiSpec_tab1.jsp | 0 .../jsp/web/api/munja/apiSpec_tab2.jsp | 247 ++++++++++++ .../jsp/web/api/munja/apiSpec_tab3.jsp | 361 ++++++++++++++++++ .../jsp/web/api/munja/apiSpec_tab4.jsp | 353 +++++++++++++++++ .../jsp/web/api/munja/apiSpec_tab5.jsp | 195 ++++++++++ .../WEB-INF/jsp/web/api/top_tepMenu.jsp | 3 +- 15 files changed, 1529 insertions(+), 3 deletions(-) create mode 100644 src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec.jsp create mode 100644 src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab1.jsp rename src/main/webapp/WEB-INF/jsp/web/api/{ => at}/apiSpec_tab2.jsp (100%) rename src/main/webapp/WEB-INF/jsp/web/api/{ => at}/apiSpec_tab3.jsp (100%) rename src/main/webapp/WEB-INF/jsp/web/api/{ => at}/apiSpec_tab4.jsp (100%) rename src/main/webapp/WEB-INF/jsp/web/api/{ => at}/apiSpec_tab5.jsp (100%) rename src/main/webapp/WEB-INF/jsp/web/api/{ => munja}/apiSpec.jsp (97%) rename src/main/webapp/WEB-INF/jsp/web/api/{ => munja}/apiSpec_tab1.jsp (100%) create mode 100644 src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab2.jsp create mode 100644 src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab3.jsp create mode 100644 src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab4.jsp create mode 100644 src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab5.jsp diff --git a/src/main/java/itn/let/kakao/user/kakaoAt/web/KakaoAlimTalkTemplateController.java b/src/main/java/itn/let/kakao/user/kakaoAt/web/KakaoAlimTalkTemplateController.java index f6a3a06e..95681e48 100644 --- a/src/main/java/itn/let/kakao/user/kakaoAt/web/KakaoAlimTalkTemplateController.java +++ b/src/main/java/itn/let/kakao/user/kakaoAt/web/KakaoAlimTalkTemplateController.java @@ -305,6 +305,9 @@ public class KakaoAlimTalkTemplateController { KakaoReturnVO kakaoTemplateInfo =kakaoApiTemplate.selectKakaoApiTemplateDetail(kakaoVO); + System.out.println("kakaoTemplateInfo :; "+ kakaoTemplateInfo); + + String kakaoButtonTypeDs = ""; for(int i=0; i < kakaoTemplateInfo.getButtonList().size(); i++) { String buttonType = kakaoTemplateInfo.getButtonList().get(i).getLinkType(); diff --git a/src/main/java/itn/let/uat/uia/web/EgovMypageRESTAPIController.java b/src/main/java/itn/let/uat/uia/web/EgovMypageRESTAPIController.java index 3706a695..5eebcaa8 100644 --- a/src/main/java/itn/let/uat/uia/web/EgovMypageRESTAPIController.java +++ b/src/main/java/itn/let/uat/uia/web/EgovMypageRESTAPIController.java @@ -247,7 +247,25 @@ public class EgovMypageRESTAPIController{ } model.addAttribute("loginVO", loginVO); - return "web/api/apiSpec"; + return "web/api/munja/apiSpec"; + } + + /** + * @param model + * @return + * @throws Exception + */ + @RequestMapping(value="/web/api/apiAtSpec.do") + public String apiAtSpec(ModelMap model) + throws Exception { + LoginVO loginVO = EgovUserDetailsHelper.isAuthenticated()? (LoginVO)EgovUserDetailsHelper.getAuthenticatedUser():null; + + if(loginVO == null) { + return "redirect:/web/user/login/login.do"; + } + model.addAttribute("loginVO", loginVO); + + return "web/api/at/apiSpec"; } /** diff --git a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec.jsp b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec.jsp new file mode 100644 index 00000000..33381d46 --- /dev/null +++ b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec.jsp @@ -0,0 +1,82 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%> +<%@ taglib prefix="ui" uri="http://egovframework.gov/ctl/ui"%> +<%@ taglib uri="http://java.sun.com/jsp/jstl/functions" prefix="fn"%> + + + +
+ +
+ + + + +
+
+

REST API 설명

+
+
+ +
    +
  • +
  • +
  • +
  • +
  • +
  • +
  • +
  • +
+
+ + + + +
+ +
+ + + + +
+ +
+ + +
+ +
+ +
+ +
+ +
+ +
+
+
+
diff --git a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab1.jsp b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab1.jsp new file mode 100644 index 00000000..633c92d0 --- /dev/null +++ b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab1.jsp @@ -0,0 +1,266 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" + pageEncoding="UTF-8"%> + + + + +
+ +
Request
+
+
+

Request

+ + + + + + + + + + + + + + + + + + + + + + +
API Request Http Method, 프로토콜, HOST, Service Port + 정보 테이블
Http MethodPOST
프로토콜HTTP/1.1
HOSTapi.munjaon.co.kr
Service Port443
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
문자발송 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
설명타입필수
mberId사용자 IDStringO
accessKey인증용 API KeyStringO
callFrom발신자 번호(아이디에 등록되어 있는 번호)StringO
callToList수신자 번호(콤마(,) 기준으로 입력)StringO
smsTxt메시지 내용String(1~2,000Byte)O
nameStr메시지 내용에 [*이름*]이 있으면 치환용 이름 입력( | 로 구분 )StringX
test_yn테스트 데이터 여부StringX
+
+

※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.

+

※ 문자 텍스트 용량(byte) : 한글 1자당 2byte, 영문/숫자 1자당 1byte

+
+
+
+
[Example]
+
+

+
+

+ "mberId":"홍길동" +

+

+ ,"accessKey":"XXXXXXXXXXXXXX414050694b953" +

+

+ ,"callFrom":"01012341234" +

+

+ ,"callToList":"01011111111,01022222222,01033333333" +

+

+ ,"smsTxt":"문자 테스트~![*이름*]" +

+

+ ,"nameStr":"홍길동1|홍길동2|홍길동3" +

+

+ ,"test_yn":"" +

+
+

+
+
+ + +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
문자발송 API Response 키 종류 및 설명, 타입 테이블
설명타입
resultCode성공 여부("0" 아니면 실패)String
data결과값 객체(성공 : 데이터, 실패 : 메시지)Object
[data].msgGroupId메시지 그룹 IDString
[data].msgType메시지 타입(4 : 단문, 6 : 장문)String
[data].blockCnt수신거부 건수String
[data].failCnt전송 실패 건수String
[data].successCnt성공 건수String
[data].test_yn테스트 데이터 여부String
+
+

※ JSON 객체로 응답합니다.

+
+
+
+
+ [Example]O 성공 + 예시 +
+
+

+
+

+ "resultCode":"0" +

+

+ ,"data"{ +

+
+

+ "msgGroupId":"MSGGID_0000000000000" +

+

+ ,"msgType":"SMS" +

+

+ ,"resultCode":"0" +

+

+ ,"blockCnt":"0" +

+

+ ,"failCnt":"0" +

+

+ ,"successCnt":"3" +

+

+ ,"test_yn":null +

+
+

+
+

+
+
+
+
+ [Example]X 실패 예시 +
+
+

+
+

+ "resultCode":"1040" +

+

+ ,"data":"치환 데이터 오류" +

+
+

+
+
+ +
+ diff --git a/src/main/webapp/WEB-INF/jsp/web/api/apiSpec_tab2.jsp b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab2.jsp similarity index 100% rename from src/main/webapp/WEB-INF/jsp/web/api/apiSpec_tab2.jsp rename to src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab2.jsp diff --git a/src/main/webapp/WEB-INF/jsp/web/api/apiSpec_tab3.jsp b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab3.jsp similarity index 100% rename from src/main/webapp/WEB-INF/jsp/web/api/apiSpec_tab3.jsp rename to src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab3.jsp diff --git a/src/main/webapp/WEB-INF/jsp/web/api/apiSpec_tab4.jsp b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab4.jsp similarity index 100% rename from src/main/webapp/WEB-INF/jsp/web/api/apiSpec_tab4.jsp rename to src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab4.jsp diff --git a/src/main/webapp/WEB-INF/jsp/web/api/apiSpec_tab5.jsp b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab5.jsp similarity index 100% rename from src/main/webapp/WEB-INF/jsp/web/api/apiSpec_tab5.jsp rename to src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab5.jsp diff --git a/src/main/webapp/WEB-INF/jsp/web/api/apiSpec.jsp b/src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec.jsp similarity index 97% rename from src/main/webapp/WEB-INF/jsp/web/api/apiSpec.jsp rename to src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec.jsp index 2eb1d4d3..9bf7db27 100644 --- a/src/main/webapp/WEB-INF/jsp/web/api/apiSpec.jsp +++ b/src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec.jsp @@ -30,7 +30,7 @@ $(document).ready(function(){
- +
diff --git a/src/main/webapp/WEB-INF/jsp/web/api/apiSpec_tab1.jsp b/src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab1.jsp similarity index 100% rename from src/main/webapp/WEB-INF/jsp/web/api/apiSpec_tab1.jsp rename to src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab1.jsp diff --git a/src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab2.jsp b/src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab2.jsp new file mode 100644 index 00000000..a1d49448 --- /dev/null +++ b/src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab2.jsp @@ -0,0 +1,247 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> + +
    +
  • - API를 통해서 다른 내용의 문자를 대량으로 전송할 수 있습니다.
  • +
  • - 발신번호는 문자온 사이트를 통해 사전등록 후 이용하실 수 있습니다.(마이페이지-발신번호 관리 메뉴 이용)
  • +
  • - 문자 내용이 "90byte"를 초과하는 경우 장문(LMS)으로 자동 전환됩니다.
  • +
+ +
+ +
Request
+
+
+

Request

+ + + + + + + + + + + + + + + + + + + + + + +
API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
Http MethodPOST
프로토콜HTTP/1.1
HOSTapi.munjaon.co.kr
Service Port443
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
문자발송(대량) API Request 키 종류 및 설명, 타입, 필수 여부 테이블
설명타입필수
mberId사용자 IDStringO
accessKey인증용 API KeyStringO
callFrom발신자 번호(아이디에 등록되어 있는 번호)StringO
test_yn테스트 데이터 여부StringX
callTo_1수신자 번호 1StringO
smsTxt_1메시지 내용 1 String(1~2,000Byte)O
.........X
callTo_100수신자 번호 100StringX
smsTxt_100메시지 내용 100String(1~2,000Byte)X
+
+

※ 문자 텍스트 용량(byte) : 한글 1자당 2byte, 영문/숫자 1자당 1byte

+
+
+
+
[Example]
+
+

+
+

"mberId":"홍길동"

+

,"accessKey":"XXXXXXXXXXXXXX414050694b953"

+

,"callFrom":"01012341234"

+

,"test_yn":""

+

,"callTo_1":"01011111111"

+

,"smsTxt_1":"문자 테스트 1"

+

,"callTo_2":"01022222222"

+

,"smsTxt_2":"문자 테스트 2"

+
+

+
+
+ + +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
문자발송(대량) API Response 키 종류 및 설명, 타입 테이블
설명타입
resultCode성공 여부("0" 아니면 실패)String
data결과값 객체(성공 : 데이터, 실패 : 메시지)Object
[data].msgGroupIdList메시지 그룹 ID 리스트List String
[data].msgType메시지 타입(4 : 단문, 6 : 장문)String
[data].blockCnt수신거부 건수String
[data].failCnt전송 실패 건수String
[data].successCnt성공 건수String
[data].test_yn테스트 데이터 여부String
+
+

※ JSON 객체로 응답합니다.

+
+
+
+
[Example]O 성공 예시
+
+

+
+

"resultCode":"0"

+

,"data":[

+
+

"msgGroupIdList":[

+

+

"MSGGID_0000000013451"

+

+

,{

+

"MSGGID_0000000013452"

+

+

+

,"msgTypeList":[

+

+

"SMS"

+

+

,{

+

"SMS"

+

+

+

,"resultCode":"0"

+

,"successCnt":"2"

+

,"failCnt":"0"

+

,"blockCnt":"0"

+

,"test_yn":null

+

+
+
+

+
+
+
+
[Example]X 실패 예시
+
+

+
+

"resultCode":"1040"

+

,"data":"치환 데이터 오류"

+
+

+
+
+ +
diff --git a/src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab3.jsp b/src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab3.jsp new file mode 100644 index 00000000..32fae9e8 --- /dev/null +++ b/src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab3.jsp @@ -0,0 +1,361 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> + +
    +
  • - 문자온 사이트 및 API를 통해 전송된 문자 발송내역을 조회할 수 있습니다.
  • +
  • - 문자 발송내역은 날짜별로 조회되며, 최근 3개월까지만 조회 가능합니다.
  • +
  • - 발신번호별 문자 발송내역 조회 기능은 제공되지 않습니다.
  • +
+ +
+ +
Request
+
+
+

Request

+ + + + + + + + + + + + + + + + + + + + + + +
API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
Http MethodPOST
프로토콜HTTP/1.1
HOSTapi.munjaon.co.kr
Service Port443
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
전송결과 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
설명타입필수
mberId사용자 IDStringO
accessKey인증용 API KeyStringO
page페이지 번호StringX
pageSize페이지당 출력 개수StringX
startDate시작 일자StringX
endDate마감 일자StringX
test_yn테스트 데이터 여부StringX
+
+

※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.

+
+
+
+
[Example]
+
+

+
+

"mberId":"홍길동"

+

,"accessKey":"XXXXXXXXXXXXXX414050694b953"

+

,"page":""

+

,"pageSize":""

+

,"startDate":""

+

,"endDate":""

+

,"test_yn":""

+
+

+
+
+ + +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
전송결과 조회 API Response 키 종류 및 설명, 타입 테이블
설명타입
resultCode성공 여부("0" 아니면 실패)String
data결과값 객체(성공 : 데이터, 실패 : 메시지)Object
[data].message문자String
[data].next_yn다음 페이지 여부String
[data].objectList결과값 목록Object List
[data].msgGroupId메시지 그룹 IDString
[data].msgId메시지 IDString
[data].msgTypeName문자 구분명(단문, 장문, 그림)String
[data].msgType메시지 타입(4 : 단문, 6 : 장문)String
[data].callFrom발신자 번호String
[data].callTo수신자 번호String
[data].msgGroupCnt문자 발송 건수String
[data].sCnt성공 건수String
[data].fCnt실패 건수String
[data].wCnt대기 건수String
[data].msgResult발송 결과(성공 : S, 실패 : F)String
[data].smsTxt문자 내용String
[data].subject제목String
[data].reqdate발송 일자String
[data].curState전송 처리 결과값String
[data].userId사용자 IDString
[data].regdate등록 일자String
[data].reserveCYn예약 취소 여부String
[data].ttlCnt전체 요청 수String
[data].remainMsgCnt남은 문자 건수String
[data].totMsgCnt전체 문자 개수String
+
+

※ JSON 객체로 응답합니다.

+
+
+
+
[Example]O 성공 예시
+
+

+
+

"resultCode":"0"

+

,"data":[

+

+
+

"resultCode":"0"

+

,"message": null

+

,"next_yn":"n"

+

,"msgGroupId":"MSGGID_0000000000000"

+

,"objectList":[

+

+
+

"msgTypeName":"단문(SMS)"

+

,"msgType":"4"

+

,"callFrom":"01011112222"

+

,"callTo":"01011112223"

+

,"msgGroupCnt":"2"

+

,"msgGroupId":"MSGGID_0000000013340"

+

,"msgId":"MSGID_0000000000001"

+

,"scnt":"2"

+

,"fcnt":"0"

+

,"wcnt":"0"

+

,"msgResult":"S"

+

,"smsTxt":"문자 내용 단문 예제"

+

,"subject":null

+

,"reqdate":"2023-06-13 17:48:07"

+

,"curState":"3"

+

,"userId":"testuser"

+

,"regdate":"2023-06-13 17:48:07"

+

,"reserveCYn":"N"

+

,"ttlCnt":"1"

+

,"remainMsgCnt":"40"

+

,"totMsgCnt":"70"

+
+

+

,{

+
+

"msgTypeName":"장문(LMS)"

+

,"msgType":"6"

+

,"callFrom":"01011112222"

+

,"callTo":"01011112223"

+

,"msgGroupCnt":"1"

+

,"msgGroupId":"MSGGID_0000000013341"

+

,"msgId":"MSGID_0000000000002"

+

,"scnt":"1"

+

,"fcnt":"0"

+

,"wcnt":"0"

+

,"msgResult":"S"

+

,"smsTxt":"문자 내용 장문 예제"

+

,subject":null

+

,reqdate":"2023-06-02 11:46:50"

+

,"curState":"3"

+

,"userId":"testuser"

+

,"regdate":"2023-06-02 11:46:49"

+

,"reserveCYn":"N"

+

,"ttlCnt":"1"

+

,"remainMsgCnt":"40"

+

,"totMsgCnt":"70"

+

+
+

+
+

+

+
+

+
+
+
+
[Example]X 실패 예시
+
+

+
+

"resultCode":"3099"

+

,"data":"기타 시스템 오류"

+
+

+
+
+ +
diff --git a/src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab4.jsp b/src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab4.jsp new file mode 100644 index 00000000..44d4a720 --- /dev/null +++ b/src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab4.jsp @@ -0,0 +1,353 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> + +
    +
  • - 전송결과 조회의 "msgGroupId"를 사용하여 전송된 문자의 상세결과를 수신번호별로 조회할 수 있습니다.
  • +
  • - 전송결과가 "대기"인 경우에는 최종 결과 확인까지 최대 72시간까지 소요됩니다.
  • +
+ +
+ +
Request
+
+
+

Request

+ + + + + + + + + + + + + + + + + + + + + + +
API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
Http MethodPOST
프로토콜HTTP/1.1
HOSTapi.munjaon.co.kr
Service Port443
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
상세결과 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
설명타입필수
mberId사용자 IDStringO
accessKey인증용 API KeyStringO
msgGroupId메시지 그룹 IDStringO
page페이지 번호StringX
pageSize페이지당 출력 개수StringX
test_yn테스트 데이터 여부StringX
+
+

※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.

+
+
+
+
[Example]
+
+

+
+

"mberId":"홍길동"

+

,"accessKey":"XXXXXXXXXXXXXX414050694b953"

+

,"msgGroupId":"MSGGID_0000000011452"

+

,"page":""

+

,"pageSize":""

+

,"test_yn":""

+
+

+
+
+ + +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
상세결과 조회 API Response 키 종류 및 설명, 타입 테이블
설명타입
resultCode성공 여부("0" 아니면 실패)String
data결과값 객체(성공 : 데이터, 실패 : 메시지)Object
[data].message문자String
[data].next_yn다음 페이지 여부String
[data].objectList결과값 목록Object List
[data].msgGroupId메시지 그룹 IDString
[data].msgId메시지 IDString
[data].msgTypeName문자 구분명(단문, 장문, 그림)String
[data].msgType메시지 타입(4 : 단문, 6 : 장문)String
[data].callFrom발신자 번호String
[data].callTo수신자 번호String
[data].msgGroupCnt문자 발송 건수String
[data].sCnt성공 건수String
[data].fCnt실패 건수String
[data].wCnt대기 건수String
[data].msgResult발송 결과(성공 : S, 실패 : F)String
[data].smsTxt문자 내용String
[data].subject제목String
[data].reqdate발송 일자String
[data].curState전송 처리 결과값String
[data].userId사용자 IDString
[data].regdate등록 일자String
[data].reserveCYn예약 취소 여부String
[data].ttlCnt전체 요청 수String
[data].remainMsgCnt남은 문자 건수String
[data].totMsgCnt전체 문자 개수String
+
+

※ JSON 객체로 응답합니다.

+
+
+
+
[Example]O 성공 예시
+
+

+
+

"resultCode":"0"

+

,"data":[

+

+
+

"resultCode":"0"

+

,"message": null

+

,"next_yn":"n"

+

,"msgGroupId":"MSGGID_0000000000000"

+

,"objectList":[

+

+
+

"msgTypeName":"단문(SMS)"

+

,"msgType":"4"

+

,"callFrom":"01011112222"

+

,"callTo":"01011112223"

+

,"msgGroupCnt":"2"

+

,"msgGroupId":"MSGGID_0000000013340"

+

,"msgId":"MSGID_0000000000001"

+

,"scnt":null

+

,"fcnt":null

+

,"wcnt":null

+

,"msgResult":"S"

+

,"smsTxt":"문자 내용 단문 예제"

+

,"subject":null

+

,"reqdate":"2023-06-13 17:48:08"

+

,"curState":"3"

+

,"userId":"testuser"

+

,"regdate":"2023-06-13 17:48:07"

+

,"reserveCYn":"N"

+

,"ttlCnt":"10"

+

,"remainMsgCnt":"0"

+

,"totMsgCnt":"10"

+
+

+

,{

+
+

"msgTypeName":"단문(SMS)"

+

,"msgType":"4"

+

,"callFrom":"01011112222"

+

,"callTo":"01011112223"

+

,"msgGroupCnt":"2"

+

,"msgGroupId":"MSGGID_0000000013340"

+

,"msgId":"MSGID_0000000000002"

+

,"scnt":null

+

,"fcnt":null

+

,"wcnt":null

+

,"msgResult":"S"

+

,"smsTxt":"문자 내용 단문 예제"

+

,subject":null

+

,reqdate":"2023-06-13 17:48:09"

+

,"curState":"3"

+

,"userId":"testuser"

+

,"regdate":"2023-06-13 17:48:07"

+

,"reserveCYn":"N"

+

,"ttlCnt":"10"

+

,"remainMsgCnt":"0"

+

,"totMsgCnt":"10"

+

+
+

+
+

+

+
+

+
+
+
+
[Example]X 실패 예시
+
+

+
+

"resultCode":"4099"

+

,"data":"기타 시스템 오류"

+
+

+
+
+ +
diff --git a/src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab5.jsp b/src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab5.jsp new file mode 100644 index 00000000..df406dc3 --- /dev/null +++ b/src/main/webapp/WEB-INF/jsp/web/api/munja/apiSpec_tab5.jsp @@ -0,0 +1,195 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> + +
    +
  • - 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.
  • +
  • - 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.
  • +
+ +
+ +
Request
+
+
+

Request

+ + + + + + + + + + + + + + + + + + + + + + +
API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
Http MethodPOST
프로토콜HTTP/1.1
HOSTapi.munjaon.co.kr
Service Port443
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
설명타입필수
mberId사용자 IDStringO
accessKey인증용 API KeyStringO
+
+

※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.

+
+
+
+
[Example]
+
+

+
+

"mberId":"String"

+

,"accessKey":"String"

+
+

+
+
+ + +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
발송가능 건수 API Response 키 종류 및 설명, 타입 테이블
설명타입
resultCode성공 여부("0" 아니면 실패)String
data결과값 객체(성공 : 데이터, 실패 : 메시지)Object
[data].longPrice장문 단가String
[data].longSendPsbltEa장문 발송 가능 건수String
[data].mberMoney현재 보유 금액String
[data].message문자String
[data].picturePrice그림문자 단가String
[data].pictureSendPsbltEa그림문자 발송 가능 건수String
[data].shortPrice단문 단가String
[data].shortSendPsbltEa단문 발송 가능 건수String
+
+

※ JSON 객체로 응답합니다.

+
+
+
+
[Example]O 성공 예시
+
+

+
+

"resultCode":"0"

+

,"data"

+
+

"longPrice":"50"

+

,"longSendPsbltEa":"19651"

+

,"mberMoney":"982586.7"

+

,"message":null

+

,"picturePrice":"90"

+

,"pictureSendPsbltEa":"10917"

+

,"shortPrice":"18"

+

,"shortSendPsbltEa":"54588"

+
+

+
+

+
+
+
+
[Example]X 실패 예시
+
+

+
+

"resultCode":"5099"

+

,"data":"기타 시스템 오류"

+
+

+
+
+ +
diff --git a/src/main/webapp/WEB-INF/jsp/web/api/top_tepMenu.jsp b/src/main/webapp/WEB-INF/jsp/web/api/top_tepMenu.jsp index 54b556a2..951d4c82 100644 --- a/src/main/webapp/WEB-INF/jsp/web/api/top_tepMenu.jsp +++ b/src/main/webapp/WEB-INF/jsp/web/api/top_tepMenu.jsp @@ -98,7 +98,8 @@ function customPopup(){
  • -
  • +
  • +