tolag3/mjon_git
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

api 개발가이드 완료

Browse Source
This commit is contained in:
hehihoho3@gmail.com 2025-09-16 18:26:24 +09:00
parent 5d6934e311
commit 0b384934e5
23 changed files with 3637 additions and 3351 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
.claude/etc1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 73 KiB

BIN
.claude/etc2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 46 KiB

31
src/main/java/itn/let/uat/uia/web/EgovMypageRESTAPIController.java
View File

@ -260,27 +260,20 @@ public class EgovMypageRESTAPIController{
} }
model.addAttribute("loginVO", loginVO); model.addAttribute("loginVO", loginVO);
// return "web/api/apiAtSpec";
return "web/api/apiAtSpec"; return "web/api/apiAtSpec";
} }
@RequestMapping(value="/web/api/apiFtSpec.do")
/** public String apiFtSpec(ModelMap model)
* @param model throws Exception {
* @return LoginVO loginVO = EgovUserDetailsHelper.isAuthenticated()? (LoginVO)EgovUserDetailsHelper.getAuthenticatedUser():null;
* @throws Exception
*/ if(loginVO == null) {
/* @RequestMapping(value="/web/api/apiAtSpec.do") return "redirect:/web/user/login/login.do";
public String apiAtSpec(ModelMap model) }
throws Exception { model.addAttribute("loginVO", loginVO);
LoginVO loginVO = EgovUserDetailsHelper.isAuthenticated()? (LoginVO)EgovUserDetailsHelper.getAuthenticatedUser():null;
return "web/api/apiFtSpec";
if(loginVO == null) { }
return "redirect:/web/user/login/login.do";
}
model.addAttribute("loginVO", loginVO);
return "web/api/at/apiSpec";
}*/
/** /**
* @param model * @param model

42
src/main/webapp/WEB-INF/jsp/web/api/apiAtSpec.jsp
View File

@ -112,67 +112,53 @@ $(document).ready(function(){
<!-- tab button --> <!-- tab button -->
<ul class="list_tab"> <ul class="list_tab">
<li class="tab active"><button type="button" onclick="TabType1(this,'6');">채널 ID 조회</button></li> <li class="tab active"><button type="button" onclick="TabType1(this,'1');">채널 ID 조회</button></li>
<li class="tab"><button type="button" onclick="TabType1(this,'7');">템플릿 ID 조회</button></li> <li class="tab"><button type="button" onclick="TabType1(this,'2');">템플릿 ID 조회</button></li>
<li class="tab"><button type="button" onclick="TabType1(this,'8');">템플릿상세조회</button></li> <li class="tab"><button type="button" onclick="TabType1(this,'3');">템플릿상세조회</button></li>
<li class="tab"><button type="button" onclick="TabType1(this,'9');">알림톡 보내기</button></li> <li class="tab"><button type="button" onclick="TabType1(this,'4');">알림톡 보내기</button></li>
<li class="tab"><button type="button" onclick="TabType1(this,'11');">전송내역조회</button></li> <li class="tab"><button type="button" onclick="TabType1(this,'5');">전송내역조회</button></li>
<li class="tab"><button type="button" onclick="TabType1(this,'12');">전송내역조회(상세)</button></li> <li class="tab"><button type="button" onclick="TabType1(this,'6');">전송내역조회(상세)</button></li>
<li class="tab"><button type="button" onclick="TabType1(this,'13');">발송가능건수</button></li> <li class="tab"><button type="button" onclick="TabType1(this,'7');">발송가능건수</button></li>
</ul><!--// tab button --> </ul><!--// tab button -->
</div> </div>
<!-- 채널 ID 조회 --> <!-- 채널 ID 조회 -->
<div class="fee_cont current" id="tab1_6"> <div class="fee_cont current" id="tab1_1">
<c:import url="./at/apiSpec_tab1.jsp" /> <c:import url="./at/apiSpec_tab1.jsp" />
</div> </div>
<!-- 템플릿 ID 조회 --> <!-- 템플릿 ID 조회 -->
<div class="fee_cont" id="tab1_7"> <div class="fee_cont" id="tab1_2">
<c:import url="./at/apiSpec_tab2.jsp" /> <c:import url="./at/apiSpec_tab2.jsp" />
</div> </div>
<!-- 템플릿상세조회 --> <!-- 템플릿상세조회 -->
<div class="fee_cont" id="tab1_8"> <div class="fee_cont" id="tab1_3">
<c:import url="./at/apiSpec_tab3.jsp" /> <c:import url="./at/apiSpec_tab3.jsp" />
</div> </div>
<!-- 알림톡 보내기 --> <!-- 알림톡 보내기 -->
<div class="fee_cont" id="tab1_9"> <div class="fee_cont" id="tab1_4">
<c:import url="./at/apiSpec_tab4.jsp" /> <c:import url="./at/apiSpec_tab4.jsp" />
</div> </div>
<!-- 전송내역조회 --> <!-- 전송내역조회 -->
<div class="fee_cont" id="tab1_11"> <div class="fee_cont" id="tab1_5">
<c:import url="./at/apiSpec_tab6.jsp" /> <c:import url="./at/apiSpec_tab6.jsp" />
</div> </div>
<!-- 전송내역조회(상세) --> <!-- 전송내역조회(상세) -->
<div class="fee_cont" id="tab1_12"> <div class="fee_cont" id="tab1_6">
<c:import url="./at/apiSpec_tab7.jsp" /> <c:import url="./at/apiSpec_tab7.jsp" />
</div> </div>
<!-- 발송가능건수 --> <!-- 발송가능건수 -->
<div class="fee_cont" id="tab1_13"> <div class="fee_cont" id="tab1_7">
<c:import url="./at/apiSpec_tab8.jsp" /> <c:import url="./at/apiSpec_tab8.jsp" />
</div> </div>
</div> </div>
<!-- //REST API 개발 가이드 > 알림톡 --> <!-- //REST API 개발 가이드 > 알림톡 -->
<!-- REST API 개발 가이드 > 친구톡 -->
<!-- <div class="api_guide kakao" id="tab5_3">
<div class="list_tab_wrap2 type3">
<ul class="list_tab">
<li class="tab active"><button type="button" onclick="TabType2(this,'6');">채널 ID 조회</button></li>
<li class="tab"><button type="button" onclick="TabType2(this,'7');">친구톡 보내기</button></li>
<li class="tab"><button type="button" onclick="TabType2(this,'8');">전송내역조회</button></li>
<li class="tab"><button type="button" onclick="TabType2(this,'9');">전송내역조회(상세)</button></li>
<li class="tab"><button type="button" onclick="TabType2(this,'10');">발송가능건수</button></li>
</ul>
</div>
</div> -->
<!-- //REST API 개발 가이드 > 친구톡 -->
</div> </div>
</div><!--// send top --> </div><!--// send top -->
</div> </div>

111
src/main/webapp/WEB-INF/jsp/web/api/apiFtSpec.jsp Normal file
View File

@ -0,0 +1,111 @@
<%@ 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"%>
<head>
</head>
<script language=javascript>
$(document).ready(function(){
// 현재 url 추출
/* var url = window.location.pathname;
// 현재 url에서 uri만 추출
var lastPart = url.split('/').pop();
$('.tabType4 .tab').each(function(index) {
var $btn = $(this).children("button");
var id = $btn.attr("id");
// 개발가이드 그룹
if (id === 'apiSpec' && /api.*Spec\.do$/.test(lastPart)) {
$(this).addClass('active');
}
// 나머지 기본 처리
else if (lastPart.indexOf(id) > -1) {
$(this).addClass('active');
}
}); */
});
hljs.highlightAll();
</script>
<style>
.padding_add > p
{
padding-left: 30px;
padding-bottom: 8px;
}
.padding_add > div > p
{
padding-left: 60px;
padding-bottom: 8px;
}
</style>
<!-- content 영역 -->
<div class="inner">
<!-- send top -->
<div class="send_top">
<c:import url="./top_tepMenu.jsp" /><!--// tab button -->
<!-- tab button -->
<div class="api_guide_cont current">
<div class="heading">
<h2>REST API 개발 가이드</h2>
</div>
<!--// sub tab button -->
<c:import url="./top_subTepMenu.jsp" />
<!-- REST API 개발 가이드 > 알림톡 -->
<div class="api_guide current" id="tab5_1">
<div class="list_tab_wrap2 type3">
<!-- tab button -->
<ul class="list_tab">
<li class="tab active"><button type="button" onclick="TabType1(this,'1');">채널 ID 조회</button></li>
<li class="tab"><button type="button" onclick="TabType1(this,'2');">친구톡 보내기</button></li>
<li class="tab"><button type="button" onclick="TabType1(this,'3');">전송내역조회</button></li>
<li class="tab"><button type="button" onclick="TabType1(this,'4');">전송내역조회(상세)</button></li>
<li class="tab"><button type="button" onclick="TabType1(this,'5');">발송가능건수</button></li>
</ul><!--// tab button -->
</div>
<!-- 채널 ID 조회 -->
<div class="fee_cont current" id="tab1_1">
<c:import url="./ft/apiSpec_tab1.jsp" />
</div>
<!-- 알림톡 보내기 -->
<div class="fee_cont" id="tab1_2">
<c:import url="./ft/apiSpec_tab2.jsp" />
</div>
<!-- 전송내역조회 -->
<div class="fee_cont" id="tab1_3">
<c:import url="./ft/apiSpec_tab3.jsp" />
</div>
<!-- 전송내역조회(상세) -->
<div class="fee_cont" id="tab1_4">
<c:import url="./ft/apiSpec_tab4.jsp" />
</div>
<!-- 발송가능건수 -->
<div class="fee_cont" id="tab1_5">
<c:import url="./ft/apiSpec_tab5.jsp" />
</div>
</div>
<!-- //REST API 개발 가이드 > 알림톡 -->
</div>
</div><!--// send top -->
</div>

71
src/main/webapp/WEB-INF/jsp/web/api/apiSpec.jsp
View File

@ -91,77 +91,6 @@ $(document).ready(function(){
<!-- //REST API 개발 가이드 > 문자 --> <!-- //REST API 개발 가이드 > 문자 -->
<!-- REST API 개발 가이드 > 알림톡 --> <!-- REST API 개발 가이드 > 알림톡 -->
<div class="api_guide" id="tab5_2">
<div class="list_tab_wrap2 type3">
<!-- tab button -->
<ul class="list_tab">
<li class="tab active"><button type="button" onclick="TabType2(this,'6');">채널 ID 조회</button></li>
<li class="tab"><button type="button" onclick="TabType2(this,'7');">템플릿 ID 조회</button></li>
<li class="tab"><button type="button" onclick="TabType2(this,'8');">템플릿상세조회</button></li>
<li class="tab"><button type="button" onclick="TabType2(this,'9');">알림톡 보내기</button></li>
<!-- <li class="tab"><button type="button" onclick="TabType2(this,'10');">대량보내기</button></li> -->
<li class="tab"><button type="button" onclick="TabType2(this,'11');">전송내역조회</button></li>
<li class="tab"><button type="button" onclick="TabType2(this,'12');">전송내역조회(상세)</button></li>
<li class="tab"><button type="button" onclick="TabType2(this,'13');">발송가능건수</button></li>
</ul><!--// tab button -->
</div>
<!-- 채널 ID 조회 -->
<div class="api_guide_con" id="tab2_6">
<c:import url="./at/apiSpec_tab1.jsp" />
</div>
<!-- 템플릿 ID 조회 -->
<div class="api_guide_con" id="tab2_7">
<c:import url="./at/apiSpec_tab2.jsp" />
</div>
<!-- 템플릿상세조회 -->
<div class="api_guide_con" id="tab2_8">
<c:import url="./at/apiSpec_tab3.jsp" />
</div>
<!-- 단건보내기 -->
<div class="api_guide_con" id="tab2_9">
<c:import url="./at/apiSpec_tab4.jsp" />
</div>
<!-- 대량보내기 -->
<div class="api_guide_con" id="tab2_10">
<c:import url="./at/apiSpec_tab5.jsp" />
</div>
<!-- 전송내역조회 -->
<div class="api_guide_con" id="tab2_11">
<c:import url="./at/apiSpec_tab6.jsp" />
</div>
<!-- 전송내역조회(상세) -->
<div class="api_guide_con" id="tab2_12">
<c:import url="./at/apiSpec_tab7.jsp" />
</div>
<!-- 발송가능건수 -->
<div class="api_guide_con" id="tab2_13">
<c:import url="./at/apiSpec_tab8.jsp" />
</div>
</div>
<!-- //REST API 개발 가이드 > 알림톡 -->
<!-- REST API 개발 가이드 > 친구톡 -->
<div class="api_guide kakao" id="tab5_3">
<div class="list_tab_wrap2 type3">
<ul class="list_tab">
<li class="tab active"><button type="button" onclick="TabType2(this,'6');">채널 ID 조회</button></li>
<li class="tab"><button type="button" onclick="TabType2(this,'7');">친구톡 보내기</button></li>
<li class="tab"><button type="button" onclick="TabType2(this,'8');">전송내역조회</button></li>
<li class="tab"><button type="button" onclick="TabType2(this,'9');">전송내역조회(상세)</button></li>
<li class="tab"><button type="button" onclick="TabType2(this,'10');">발송가능건수</button></li>
</ul>
</div>
</div>
<!-- //REST API 개발 가이드 > 친구톡 --> <!-- //REST API 개발 가이드 > 친구톡 -->
</div> </div>
</div><!--// send top --> </div><!--// send top -->

8
src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab1.jsp
View File

@ -94,9 +94,9 @@
<code class="language-json"> <code class="language-json">
{ {
"mberId": "문자온", "mberId": "홍길동",
"accessKey": "XXXXXXXXXXXXXXXXXXXXbaa01d8d91", "accessKey": "XXXXXXXXXXXXXX414050694b953",
"test_yn": "" "test_yn": ""
} }
@ -225,9 +225,9 @@
<pre><code class="language-json"> <pre><code class="language-json">
{ {
"resultCode": "4010", "resultCode": "2099",
"data": "인증 정보가 올바르지 않습니다.(mberId/accessKey)" "data": "기타 시스템 오류"
} }
</code></pre> </code></pre>

13
src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab2.jsp
View File

@ -3,10 +3,9 @@
<ul class="info"> <ul class="info">
<li>- API를 통해서 템플릿 목록을 조회할 수 111있습니다.</li> <li>- 등록된 알림톡 템플릿 목록을 조회할 수 있습니다.</li>
<li>- API를 통해서 템플릿 목록을 조회할 수 111있습니다.</li> <li>- SenderKey별로 승인된 템플릿만 조회됩니다.</li>
<li>- API를 통해서 템플릿 목록을 조회할 수 111있습니다.</li> <li>- 템플릿 상태(등록완료, 승인대기 등)를 확인할 수 있습니다.</li>
<li>- API를 통해서 템플릿 목록을 조회할 수 111있습니다.</li>
</ul> </ul>
<div class="re_cont"> <div class="re_cont">
<!-- Request --> <!-- Request -->
@ -101,11 +100,11 @@
<code class="language-json"> <code class="language-json">
{ {
"mberId": "dudgusw", "mberId": "홍길동",
"accessKey": "3429312e6a2c732188d4cc7d15d8a1baa01d8d91", "accessKey": "XXXXXXXXXXXXXX414050694b953",
"senderKey": "669143473b1af459628b8bdf2f48da090c8895de", "senderKey": "XXXXXXXXXXXXXX669143473b1af",
"test_yn": "" "test_yn": ""
} }

1014
src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab3.jsp
View File

File diff suppressed because it is too large Load Diff

38
src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab4.jsp
View File

@ -85,12 +85,6 @@
<td>String</td> <td>String</td>
<td><span class="select_o">O</span></td> <td><span class="select_o">O</span></td>
</tr> </tr>
<tr>
<td><span class="font_b">subMsgSendYn</span></td>
<td>대체문자 발송 여부 (Y: 발송, N: 미발송)</td>
<td>String</td>
<td><span class="select_x">X</span></td>
</tr>
<tr> <tr>
<td><span class="font_b">callFrom</span></td> <td><span class="font_b">callFrom</span></td>
<td>발신자 번호</td> <td>발신자 번호</td>
@ -115,6 +109,12 @@
<td>String</td> <td>String</td>
<td><span class="select_o">O</span></td> <td><span class="select_o">O</span></td>
</tr> </tr>
<tr>
<td><span class="font_b">subMsgSendYn</span></td>
<td>대체문자 발송 여부 (Y: 발송, N: 미발송)</td>
<td>String</td>
<td><span class="select_x">X</span></td>
</tr>
<tr> <tr>
<td><span class="font_b">subMsgTxt_[i]</span></td> <td><span class="font_b">subMsgTxt_[i]</span></td>
<td>대체문자 내용</td> <td>대체문자 내용</td>
@ -142,35 +142,35 @@
<code class="language-json"> <code class="language-json">
{ {
"mberId": "dudgusw", "mberId": "홍길동",
"accessKey": "3429312e6a2c732188d4cc7d15d8a1baa01d8d91", "accessKey": "XXXXXXXXXXXXXX414050694b953",
"senderKey": "669143473b1af459628b8bdf2f48da090c8895de", "senderKey": "XXXXXXXXXXXXXX669143473b1af",
"templateCode": "bizp_2025031410525347794704159", "templateCode": "bizp_2025031410525XXXXXXXXXXXXX",
"subMsgSendYn": "Y",
"callFrom": "010-9341-4986", "callFrom": "010-9341-4986",
"callTo_1": "01083584250", "callTo_1": "01000000000",
"callTo_2": "01011111111", "callTo_2": "01011111111",
"templateTitle_1": "테스트 이호영2222", "templateTitle_1": "타이틀 테스트2222",
"templateTitle_2": "테스트 이호영2111", "templateTitle_2": "타이틀 테스트2111",
"templateContent_1": "테스트 이호영\\n타이틀 버튼 치환 테스트입니다.", "templateContent_1": "테스트 홍길동\\n템플릿 내용",
"templateContent_2": "테스트 이호영2\\n타이틀 버튼 치환 테스트입니다.", "templateContent_2": "테스트 홍길동2\\n템플릿 내용",
"subMsgSendYn": "Y",
"subMsgTxt_1": "대체문자 발송", "subMsgTxt_1": "대체문자 발송",
"subMsgTxt_2": "대체문자 발송2", "subMsgTxt_2": "대체문자 발송2",
"test_yn": "YS" "test_yn": ""
} }
</code> </code>
</pre> </pre>
@ -275,7 +275,7 @@
"msgType": "AT", "msgType": "AT",
"test_yn": "YS" "test_yn": ""
}, },

195
src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab5.jsp
View File

@ -1,195 +0,0 @@
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<ul class="info">
<li>- 보11유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.</li>
<li>- 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.</li>
</ul>
<div class="re_cont">
<!--Request-->
<div class="req_title">Request</div>
<div class="box">
<div class="text">
<h4>Request</h4>
<table>
<caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:80%;">
</colgroup>
<tr>
<th>Http Method</th>
<td>POST</td>
</tr>
<tr>
<th>프로토콜</th>
<td>HTTP/1.1</td>
</tr>
<tr>
<th>HOST</th>
<td>api.munjaon.co.kr</td>
</tr>
<tr>
<th>Service Port</th>
<td>443</td>
</tr>
</table>
</div>
</div>
<div class="type_table">
<table>
<caption>발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:45%;">
<col style="width:25%">
<col style="width:10%">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
<th>필수</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">mberId</span></td>
<td>사용자 ID</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">accessKey</span></td>
<td>인증용 API Key</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p>
</div>
</div>
<div class="box">
<div class="title">[Example]</div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"mberId"</span>:"String"</p>
<p>,<span>"accessKey"</span>:"String"</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<!--// Request-->
<!-- Response-->
<div class="res_title">Response</div>
<div class="type_table">
<table>
<caption>발송가능 건수 API Response 키 종류 및 설명, 타입 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:60%;">
<col style="width:20%;">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">resultCode</span></td>
<td>성공 여부("0" 아니면 실패)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">data</span></td>
<td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td>
<td>Object</td>
</tr>
<tr>
<td><span class="font_b">[data].longPrice</span></td>
<td>장문 단가</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].longSendPsbltEa</span></td>
<td>장문 발송 가능 건수</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].mberMoney</span></td>
<td>현재 보유 금액</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].message</span></td>
<td>문자</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].picturePrice</span></td>
<td>그림문자 단가</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].pictureSendPsbltEa</span></td>
<td>그림문자 발송 가능 건수</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].shortPrice</span></td>
<td>단문 단가</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].shortSendPsbltEa</span></td>
<td>단문 발송 가능 건수</td>
<td>String</td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ JSON 객체로 응답합니다.</p>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"resultCode"</span>:"0"</p>
<p>,<span>"data"</span>&#65371;</p>
<div class="indent_t1">
<p><span>"longPrice"</span>:"50"</p>
<p>,<span>"longSendPsbltEa"</span>:"19651"</p>
<p>,<span>"mberMoney"</span>:"982586.7"</p>
<p>,<span>"message"</span>:null</p>
<p>,<span>"picturePrice"</span>:"90"</p>
<p>,<span>"pictureSendPsbltEa"</span>:"10917"</p>
<p>,<span>"shortPrice"</span>:"18"</p>
<p>,<span>"shortSendPsbltEa"</span>:"54588"</p>
</div>
<p>&#65373;</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"resultCode"</span>:"5099"</p>
<p>,<span>"data"</span>:"기타 시스템 오류"</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<!--// Response-->
</div>

796
src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab6.jsp
View File

@ -1,365 +1,433 @@
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<ul class="info">
<li>- 문자온 사이트 및 API를 통해 전송된 발송내역을 조회할 수 있습니다.</li>
<li>- 문자 발송내역은 날짜별로 조회되며, 최근 3개월까지만 조회 가능합니다.</li>
<li>- 발신번호별 문자 발송내역 조회 기능은 제공되지 않습니다.</li>
</ul>
<div class="re_cont"> <ul class="info">
<!--Request--> <li>- 문자온 사이트 및 API를 통해 전송된 발송내역을 조회할 수 있습니다.</li>
<div class="req_title">Request</div> <li>- 문자 발송내역은 날짜별로 조회되며, 최근 3개월까지만 조회 가능합니다.</li>
<div class="box"> <li>- 발신번호별 문자 발송내역 조회 기능은 제공되지 않습니다.</li>
<div class="text"> </ul>
<h4>Request</h4>
<table> <div class="re_cont">
<caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption> <!--Request-->
<colgroup> <div class="req_title">Request</div>
<col style="width:20%;"> <div class="box">
<col style="width:80%;"> <div class="text">
</colgroup> <h4>Request</h4>
<tr> <table>
<th>Http Method</th> <caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption>
<td>POST</td> <colgroup>
</tr> <col style="width:20%;">
<tr> <col style="width:80%;">
<th>프로토콜</th> </colgroup>
<td>HTTP/1.1</td> <tr>
</tr> <th>Http Method</th>
<tr> <td>POST</td>
<th>HOST</th> </tr>
<td>api.munjaon.co.kr</td> <tr>
</tr> <th>프로토콜</th>
<tr> <td>HTTPS/1.1</td>
<th>Service Port</th> </tr>
<td>443</td> <tr>
</tr> <th>HOST</th>
<tr> <td>api.munjaon.co.kr</td>
<th>Endpoint</th> </tr>
<td>/api/inqry/hstry</td> <tr>
</tr> <th>Service Port</th>
</table> <td>443</td>
</div> </tr>
</div> <tr>
<div class="type_table"> <th>Endpoint</th>
<table> <td>/api/inqry/hstry</td>
<caption>전송결과 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption> </tr>
<colgroup> </table>
<col style="width:20%;"> </div>
<col style="width:45%;"> </div>
<col style="width:25%">
<col style="width:10%"> <div class="type_table">
</colgroup> <table>
<thead> <caption>전송결과 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption>
<tr> <colgroup>
<th>키</th> <col style="width:20%;">
<th>설명</th> <col style="width:45%;">
<th>타입</th> <col style="width:25%">
<th>필수</th> <col style="width:10%">
</tr> </colgroup>
</thead> <thead>
<tbody> <tr>
<tr> <th>키</th>
<td><span class="font_b">mberId</span></td> <th>설명</th>
<td>사용자 ID</td> <th>타입</th>
<td>String</td> <th>필수</th>
<td><span class="select_o">O</span></td> </tr>
</tr> </thead>
<tr> <tbody>
<td><span class="font_b">accessKey</span></td> <tr>
<td>인증용 API Key</td> <td><span class="font_b">mberId</span></td>
<td>String</td> <td>사용자 ID</td>
<td><span class="select_o">O</span></td> <td>String</td>
</tr> <td><span class="select_o">O</span></td>
<tr> </tr>
<td><span class="font_b">page</span></td> <tr>
<td>페이지 번호</td> <td><span class="font_b">accessKey</span></td>
<td>String</td> <td>인증용 API Key</td>
<td><span class="select_x">X</span></td> <td>String</td>
</tr> <td><span class="select_o">O</span></td>
<tr> </tr>
<td><span class="font_b">pageSize</span></td> <tr>
<td>페이지당 출력 개수</td> <td><span class="font_b">page</span></td>
<td>String</td> <td>페이지 번호(미입력 시 1)</td>
<td><span class="select_x">X</span></td> <td>String</td>
</tr> <td><span class="select_x">X</span></td>
<tr> </tr>
<td><span class="font_b">startDate</span></td> <tr>
<td>시작 일자</td> <td><span class="font_b">pageSize</span></td>
<td>String</td> <td>페이지당 출력 개수(미입력 시 기본값 적용)</td>
<td><span class="select_x">X</span></td> <td>String</td>
</tr> <td><span class="select_x">X</span></td>
<tr> </tr>
<td><span class="font_b">endDate</span></td> <tr>
<td>마감 일자</td> <td><span class="font_b">startDate</span></td>
<td>String</td> <td>시작 일자(yyyyMMdd)</td>
<td><span class="select_x">X</span></td> <td>String</td>
</tr> <td><span class="select_x">X</span></td>
<tr> </tr>
<td><span class="font_b">test_yn</span></td> <tr>
<td>테스트 데이터 여부</td> <td><span class="font_b">endDate</span></td>
<td>String</td> <td>마감 일자(yyyyMMdd)</td>
<td><span class="select_x">X</span></td> <td>String</td>
</tr> <td><span class="select_x">X</span></td>
</tbody> </tr>
</table> <tr>
<div class="table_info"> <td><span class="font_b">test_yn</span></td>
<p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p> <td>테스트 데이터 여부</td>
</div> <td>String</td>
</div> <td><span class="select_x">X</span></td>
<div class="box"> </tr>
<div class="title">[Example]</div> </tbody>
<div class="code_view"> </table>
<p>&#65371;</p> <div class="table_info">
<div class="indent"> <p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p>
<p><span>"mberId"</span>:"홍길동"</p> <p>※ Content-Type: application/json</p>
<p>,<span>"accessKey"</span>:"XXXXXXXXXXXXXX414050694b953"</p> </div>
<p>,<span>"page"</span>:""</p> </div>
<p>,<span>"pageSize"</span>:""</p>
<p>,<span>"startDate"</span>:""</p> <div class="box">
<p>,<span>"endDate"</span>:""</p> <div class="title">[Example]</div>
<p>,<span>"test_yn"</span>:""</p> <div class="code_view">
</div> <pre>
<p class="l_code">&#65373;</p> <code class="language-json">
</div> {
</div>
<!--// Request--> "mberId": "홍길동",
<!-- Response-->
<div class="res_title">Response</div> "accessKey": "XXXXXXXXXXXXXX414050694b953",
<div class="type_table">
<table> "page": "",
<caption>전송결과 조회 API Response 키 종류 및 설명, 타입 테이블</caption>
<colgroup> "pageSize": "",
<col style="width:20%;">
<col style="width:60%;"> "startDate": "",
<col style="width:20%;">
</colgroup> "endDate": "",
<thead>
<tr> "test_yn": ""
<th>키</th> }
<th>설명</th> </code>
<th>타입</th> </pre>
</tr> </div>
</thead> </div>
<tbody> <!--// Request-->
<tr>
<td><span class="font_b">resultCode</span></td> <!-- Response-->
<td>성공 여부("0" 아니면 실패)</td> <div class="res_title">Response</div>
<td>String</td> <div class="type_table">
</tr> <table>
<tr> <caption>전송결과 조회 API Response 키 종류 및 설명, 타입 테이블</caption>
<td><span class="font_b">data</span></td> <colgroup>
<td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td> <col style="width:20%;">
<td>Object</td> <col style="width:60%;">
</tr> <col style="width:20%;">
<tr> </colgroup>
<td><span class="font_b">[data].message</span></td> <thead>
<td>문자</td> <tr>
<td>String</td> <th>키</th>
</tr> <th>설명</th>
<tr> <th>타입</th>
<td><span class="font_b">[data].next_yn</span></td> </tr>
<td>다음 페이지 여부</td> </thead>
<td>String</td> <tbody>
</tr> <tr>
<tr> <td><span class="font_b">resultCode</span></td>
<td><span class="font_b">[data].objectList</span></td> <td>성공 여부("0" 아니면 실패)</td>
<td>결과값 목록</td> <td>String</td>
<td>Object List</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">data</span></td>
<td><span class="font_b">[data].msgGroupId</span></td> <td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td>
<td>메시지 그룹 ID</td> <td>Object | String</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].message</span></td>
<td><span class="font_b">[data].msgId</span></td> <td>메시지(필요 시)</td>
<td>메시지 ID</td> <td>String</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].next_yn</span></td>
<td><span class="font_b">[data].msgTypeName</span></td> <td>다음 페이지 여부(Y/N)</td>
<td>문자 구분명(단문, 장문, 그림)</td> <td>String</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList</span></td>
<td><span class="font_b">[data].msgType</span></td> <td>결과값 목록</td>
<td>메시지 타입(4 : 단문, 6 : 장문)</td> <td>Array&lt;Object&gt;</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].msgGroupId</span></td>
<td><span class="font_b">[data].callFrom</span></td> <td>메시지 그룹 ID</td>
<td>발신자 번호</td> <td>String</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].msgId</span></td>
<td><span class="font_b">[data].callTo</span></td> <td>메시지 ID</td>
<td>수신자 번호</td> <td>String</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].msgTypeName</span></td>
<td><span class="font_b">[data].msgGroupCnt</span></td> <td>문자 구분명(단문, 장문, 그림)</td>
<td>문자 발송 건수</td> <td>String</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].msgType</span></td>
<td><span class="font_b">[data].sCnt</span></td> <td>메시지 타입(4: 단문, 5: 장문, 6: 그림)</td>
<td>성공 건수</td> <td>String | Number</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].callFrom</span></td>
<td><span class="font_b">[data].fCnt</span></td> <td>발신자 번호</td>
<td>실패 건수</td> <td>String</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].callTo</span></td>
<td><span class="font_b">[data].wCnt</span></td> <td>수신자 번호</td>
<td>대기 건수</td> <td>String</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].msgGroupCnt</span></td>
<td><span class="font_b">[data].msgResult</span></td> <td>발송 건수</td>
<td>발송 결과(성공 : S, 실패 : F)</td> <td>String | Number</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].scnt</span></td>
<td><span class="font_b">[data].smsTxt</span></td> <td>성공 건수</td>
<td>문자 내용</td> <td>String | Number</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].fcnt</span></td>
<td><span class="font_b">[data].subject</span></td> <td>실패 건수</td>
<td>제목</td> <td>String | Number</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].wcnt</span></td>
<td><span class="font_b">[data].reqdate</span></td> <td>대기 건수</td>
<td>발송 일자</td> <td>String | Number</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].msgResult</span></td>
<td><span class="font_b">[data].curState</span></td> <td>발송 결과(성공: S, 실패: F)</td>
<td>전송 처리 결과값</td> <td>String</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].smsTxt</span></td>
<td><span class="font_b">[data].userId</span></td> <td>문자 내용</td>
<td>사용자 ID</td> <td>String</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].subject</span></td>
<td><span class="font_b">[data].regdate</span></td> <td>제목</td>
<td>등록 일자</td> <td>String | null</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].reqdate</span></td>
<td><span class="font_b">[data].reserveCYn</span></td> <td>발송 일자(YYYY-MM-DD HH:mm:ss)</td>
<td>예약 취소 여부</td> <td>String</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].curState</span></td>
<td><span class="font_b">[data].ttlCnt</span></td> <td>전송 처리 결과값</td>
<td>전체 요청 수</td> <td>String | Number</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].userId</span></td>
<td><span class="font_b">[data].remainMsgCnt</span></td> <td>사용자 ID</td>
<td>남은 문자 건수</td> <td>String</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].regdate</span></td>
<td><span class="font_b">[data].totMsgCnt</span></td> <td>등록 일자(YYYY-MM-DD HH:mm:ss)</td>
<td>전체 문자 개수</td> <td>String</td>
<td>String</td> </tr>
</tr> <tr>
</tbody> <td><span class="font_b">[data].objectList[i].reserveCYn</span></td>
</table> <td>예약 취소 여부(Y/N)</td>
<div class="table_info"> <td>String</td>
<p>※ JSON 객체로 응답합니다.</p> </tr>
</div> <tr>
</div> <td><span class="font_b">[data].ttlCnt</span></td>
<div class="box"> <td>전체 요청 수</td>
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div> <td>String | Number</td>
<div class="code_view"> </tr>
<p>&#65371;</p> <tr>
<div class="indent"> <td><span class="font_b">[data].remainMsgCnt</span></td>
<p><span>"resultCode"</span>:"0"</p> <td>남은 문자 건수</td>
<p>,<span>"data"</span>:&#65339;</p> <td>String | Number</td>
<p>&#65371;</p> </tr>
<div class="indent_t1"> <tr>
<p><span>"resultCode"</span>:"0"</p> <td><span class="font_b">[data].totMsgCnt</span></td>
<p>,<span>"message"</span>: null</p> <td>전체 문자 개수</td>
<p>,<span>"next_yn"</span>:"n"</p> <td>String | Number</td>
<p>,<span>"msgGroupId"</span>:"MSGGID_0000000000000"</p> </tr>
<p>,<span>"objectList"</span>:&#65339;</p> </tbody>
<p>&#65371;</p> </table>
<div class="indent_t2"> <div class="table_info">
<p><span>"msgTypeName"</span>:"단문(SMS)"</p> <p>※ JSON 객체로 응답합니다.</p>
<p>,<span>"msgType"</span>:"4"</p> </div>
<p>,<span>"callFrom"</span>:"01011112222"</p> </div>
<p>,<span>"callTo"</span>:"01011112223"</p>
<p>,<span>"msgGroupCnt"</span>:"2"</p> <div class="box">
<p>,<span>"msgGroupId"</span>:"MSGGID_0000000013340"</p> <div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div>
<p>,<span>"msgId"</span>:"MSGID_0000000000001"</p> <div class="code_view">
<p>,<span>"scnt"</span>:"2"</p> <pre>
<p>,<span>"fcnt"</span>:"0"</p> <code class="language-json">
<p>,<span>"wcnt"</span>:"0"</p> {
<p>,<span>"msgResult"</span>:"S"</p> "resultCode": "0",
<p>,<span>"smsTxt"</span>:"문자 내용 단문 예제"</p>
<p>,<span>"subject"</span>:null</p> "data": {
<p>,<span>"reqdate"</span>:"2023-06-13 17:48:07"</p>
<p>,<span>"curState"</span>:"3"</p> "resultCode": "0",
<p>,<span>"userId"</span>:"testuser"</p>
<p>,<span>"regdate"</span>:"2023-06-13 17:48:07"</p> "message": null,
<p>,<span>"reserveCYn"</span>:"N"</p>
<p>,<span>"ttlCnt"</span>:"1"</p> "next_yn": "n",
<p>,<span>"remainMsgCnt"</span>:"40"</p>
<p>,<span>"totMsgCnt"</span>:"70"</p> "msgGroupId": "MSGGID_0000000000000",
</div>
<p>&#65373;</p> "objectList": [
<p>,&#65371;</p>
<div class="indent_t2"> {
<p><span>"msgTypeName"</span>:"장문(LMS)"</p>
<p>,<span>"msgType"</span>:"6"</p> "msgTypeName": "단문(SMS)",
<p>,<span>"callFrom"</span>:"01011112222"</p>
<p>,<span>"callTo"</span>:"01011112223"</p> "msgType": "4",
<p>,<span>"msgGroupCnt"</span>:"1"</p>
<p>,<span>"msgGroupId"</span>:"MSGGID_0000000013341"</p> "callFrom": "01011112222",
<p>,<span>"msgId"</span>:"MSGID_0000000000002"</p>
<p>,<span>"scnt"</span>:"1"</p> "callTo": "01011112223",
<p>,<span>"fcnt"</span>:"0"</p>
<p>,<span>"wcnt"</span>:"0"</p> "msgGroupCnt": "2",
<p>,<span>"msgResult"</span>:"S"</p>
<p>,<span>"smsTxt"</span>:"문자 내용 장문 예제"</p> "msgGroupId": "MSGGID_0000000013340",
<p>,<span>subject"</span>:null</p>
<p>,<span>reqdate"</span>:"2023-06-02 11:46:50"</p> "msgId": "MSGID_0000000000001",
<p>,<span>"curState"</span>:"3"</p>
<p>,<span>"userId"</span>:"testuser"</p> "scnt": "2",
<p>,<span>"regdate"</span>:"2023-06-02 11:46:49"</p>
<p>,<span>"reserveCYn"</span>:"N"</p> "fcnt": "0",
<p>,<span>"ttlCnt"</span>:"1"</p>
<p>,<span>"remainMsgCnt"</span>:"40"</p> "wcnt": "0",
<p>,<span>"totMsgCnt"</span>:"70"</p>
<p>&#65373;</p> "msgResult": "S",
</div>
<p>&#65341;</p> "smsTxt": "문자 내용 단문 예제",
</div>
<p class="l_code_t2">&#65373;</p> "subject": null,
<p>&#65341;</p>
</div> "reqdate": "2023-06-13 17:48:07",
<p class="l_code">&#65373;</p>
</div> "curState": "3",
</div>
<div class="box"> "userId": "testuser",
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div>
<div class="code_view"> "regdate": "2023-06-13 17:48:07",
<p>&#65371;</p>
<div class="indent"> "reserveCYn": "N",
<p><span>"resultCode"</span>:"3099"</p>
<p>,<span>"data"</span>:"기타 시스템 오류"</p> "ttlCnt": "1",
</div>
<p class="l_code">&#65373;</p> "remainMsgCnt": "40",
</div>
</div> "totMsgCnt": "70"
<!--// Response-->
</div> },
{
"msgTypeName": "장문(LMS)",
"msgType": "5",
"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"
}
]
}
}
</code>
</pre>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div>
<div class="code_view">
<pre>
<code class="language-json">
{
"resultCode": "3099",
"data": "기타 시스템 오류"
}
</code>
</pre>
</div>
</div>
<!--// Response-->
</div>

535
src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab7.jsp
View File

@ -1,195 +1,342 @@
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<ul class="info">
<li>- 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.</li>
<li>- 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.</li>
</ul>
<div class="re_cont">
<!--Request--> <ul class="info">
<div class="req_title">Request</div> <li>- API를 통해서 메시지 그룹 ID 기준의 상세 이력(개별 건) 목록을 조회할 수 있습니다.</li>
<div class="box"> </ul>
<div class="text"> <div class="re_cont">
<h4>Request</h4> <!-- Request -->
<table> <div class="req_title">Request</div>
<caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption> <div class="box">
<colgroup> <div class="text">
<col style="width:20%;"> <h4>Request</h4>
<col style="width:80%;"> <table>
</colgroup> <caption>API Request Http Method, 프로토콜, HOST, Service Port, Endpoint 정보 테이블</caption>
<tr> <colgroup>
<th>Http Method</th> <col style="width:20%;">
<td>POST</td> <col style="width:80%;">
</tr> </colgroup>
<tr> <tr>
<th>프로토콜</th> <th>Http Method</th>
<td>HTTP/1.1</td> <td>POST</td>
</tr> </tr>
<tr> <tr>
<th>HOST</th> <th>프로토콜</th>
<td>api.munjaon.co.kr</td> <td>HTTPS/1.1</td>
</tr> </tr>
<tr> <tr>
<th>Service Port</th> <th>HOST</th>
<td>443</td> <td>api.munjaon.co.kr</td>
</tr> </tr>
</table> <tr>
</div> <th>Service Port</th>
</div> <td>443</td>
<div class="type_table"> </tr>
<table> <tr>
<caption>발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption> <th>Endpoint</th>
<colgroup> <td>/api/inqry/hstryDetail</td>
<col style="width:20%;"> </tr>
<col style="width:45%;"> </table>
<col style="width:25%"> </div>
<col style="width:10%"> </div>
</colgroup>
<thead> <div class="type_table">
<tr> <table>
<th>키</th> <caption>히스토리 상세 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption>
<th>설명</th> <colgroup>
<th>타입</th> <col style="width:20%;">
<th>필수</th> <col style="width:45%;">
</tr> <col style="width:25%">
</thead> <col style="width:10%">
<tbody> </colgroup>
<tr> <thead>
<td><span class="font_b">mberId</span></td> <tr>
<td>사용자 ID</td> <th>키</th>
<td>String</td> <th>설명</th>
<td><span class="select_o">O</span></td> <th>타입</th>
</tr> <th>필수</th>
<tr> </tr>
<td><span class="font_b">accessKey</span></td> </thead>
<td>인증용 API Key</td> <tbody>
<td>String</td> <tr>
<td><span class="select_o">O</span></td> <td><span class="font_b">mberId</span></td>
</tr> <td>사용자 ID</td>
</tbody> <td>String</td>
</table> <td><span class="select_o">O</span></td>
<div class="table_info"> </tr>
<p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p> <tr>
</div> <td><span class="font_b">accessKey</span></td>
</div> <td>인증용 API Key</td>
<div class="box"> <td>String</td>
<div class="title">[Example]</div> <td><span class="select_o">O</span></td>
<div class="code_view"> </tr>
<p>&#65371;</p> <tr>
<div class="indent"> <td><span class="font_b">msgGroupId</span></td>
<p><span>"mberId"</span>:"String"</p> <td>메시지 그룹 ID</td>
<p>,<span>"accessKey"</span>:"String"</p> <td>String</td>
</div> <td><span class="select_o">O</span></td>
<p class="l_code">&#65373;</p> </tr>
</div> </tbody>
</div> </table>
<!--// Request--> <div class="table_info">
<!-- Response--> <p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p>
<div class="res_title">Response</div> <p>※ Content-Type: application/json</p>
<div class="type_table"> </div>
<table> </div>
<caption>발송가능 건수 API Response 키 종류 및 설명, 타입 테이블</caption>
<colgroup> <div class="box">
<col style="width:20%;"> <div class="title">[Example]</div>
<col style="width:60%;"> <div class="code_view">
<col style="width:20%;"> <pre>
</colgroup> <code class="language-json">
<thead> {
<tr>
<th>키</th> "mberId": "홍길동",
<th>설명</th>
<th>타입</th> "accessKey": "XXXXXXXXXXXXXX414050694b953",
</tr>
</thead> "msgGroupId": "MSGGID_XXXXXXX0000063"
<tbody> }
<tr> </code>
<td><span class="font_b">resultCode</span></td> </pre>
<td>성공 여부("0" 아니면 실패)</td> </div>
<td>String</td> </div>
</tr> <!-- // Request -->
<tr>
<td><span class="font_b">data</span></td> <!-- Response -->
<td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td> <div class="res_title">Response</div>
<td>Object</td> <div class="type_table">
</tr> <table>
<tr> <caption>히스토리 상세 조회 API Response 키 종류 및 설명, 타입 테이블</caption>
<td><span class="font_b">[data].longPrice</span></td> <colgroup>
<td>장문 단가</td> <col style="width:20%;">
<td>String</td> <col style="width:60%;">
</tr> <col style="width:20%;">
<tr> </colgroup>
<td><span class="font_b">[data].longSendPsbltEa</span></td> <thead>
<td>장문 발송 가능 건수</td> <tr>
<td>String</td> <th>키</th>
</tr> <th>설명</th>
<tr> <th>타입</th>
<td><span class="font_b">[data].mberMoney</span></td> </tr>
<td>현재 보유 금액</td> </thead>
<td>String</td> <tbody>
</tr> <tr>
<tr> <td><span class="font_b">resultCode</span></td>
<td><span class="font_b">[data].message</span></td> <td>성공 여부("0" 이외는 실패)</td>
<td>문자</td> <td>String</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">data</span></td>
<td><span class="font_b">[data].picturePrice</span></td> <td>조회 결과 객체</td>
<td>그림문자 단가</td> <td>Object</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].resultCode</span></td>
<td><span class="font_b">[data].pictureSendPsbltEa</span></td> <td>내부 처리 결과(0: 성공)</td>
<td>그림문자 발송 가능 건수</td> <td>Number | String</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList</span></td>
<td><span class="font_b">[data].shortPrice</span></td> <td>개별 메시지 상세 목록</td>
<td>단문 단가</td> <td>Array&lt;Object&gt;</td>
<td>String</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">[data].objectList[i].msgGroupId</span></td>
<td><span class="font_b">[data].shortSendPsbltEa</span></td> <td>메시지 그룹 ID</td>
<td>단문 발송 가능 건수</td> <td>String</td>
<td>String</td> </tr>
</tr> <tr>
</tbody> <td><span class="font_b">[data].objectList[i].msgId</span></td>
</table> <td>개별 메시지 ID</td>
<div class="table_info"> <td>String</td>
<p>※ JSON 객체로 응답합니다.</p> </tr>
</div> <tr>
</div> <td><span class="font_b">[data].objectList[i].totMsgCnt</span></td>
<div class="box"> <td>총 발송 건수(그룹 기준)</td>
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div> <td>String</td>
<div class="code_view"> </tr>
<p>&#65371;</p> <tr>
<div class="indent"> <td><span class="font_b">[data].objectList[i].msgType</span></td>
<p><span>"resultCode"</span>:"0"</p> <td>메시지 타입 코드(예: 8=AT)</td>
<p>,<span>"data"</span>&#65371;</p> <td>Number</td>
<div class="indent_t1"> </tr>
<p><span>"longPrice"</span>:"50"</p> <tr>
<p>,<span>"longSendPsbltEa"</span>:"19651"</p> <td><span class="font_b">[data].objectList[i].msgTypeName</span></td>
<p>,<span>"mberMoney"</span>:"982586.7"</p> <td>메시지 타입명</td>
<p>,<span>"message"</span>:null</p> <td>String</td>
<p>,<span>"picturePrice"</span>:"90"</p> </tr>
<p>,<span>"pictureSendPsbltEa"</span>:"10917"</p> <tr>
<p>,<span>"shortPrice"</span>:"18"</p> <td><span class="font_b">[data].objectList[i].msgResult</span></td>
<p>,<span>"shortSendPsbltEa"</span>:"54588"</p> <td>결과(F: 실패, S: 성공 등)</td>
</div> <td>String</td>
<p>&#65373;</p> </tr>
</div> <tr>
<p class="l_code">&#65373;</p> <td><span class="font_b">[data].objectList[i].msgGroupCnt</span></td>
</div> <td>발송 건수</td>
</div> <td>Number</td>
<div class="box"> </tr>
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div> <tr>
<div class="code_view"> <td><span class="font_b">[data].objectList[i].smsTxt</span></td>
<p>&#65371;</p> <td>메시지 내용</td>
<div class="indent"> <td>String</td>
<p><span>"resultCode"</span>:"5099"</p> </tr>
<p>,<span>"data"</span>:"기타 시스템 오류"</p> <tr>
</div> <td><span class="font_b">[data].objectList[i].callFrom</span></td>
<p class="l_code">&#65373;</p> <td>발신 번호</td>
</div> <td>String</td>
</div> </tr>
<!--// Response--> <tr>
</div> <td><span class="font_b">[data].objectList[i].callTo</span></td>
<td>수신 번호</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].curState</span></td>
<td>현재 상태 코드</td>
<td>Number</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].remainMsgCnt</span></td>
<td>잔여 처리 건수</td>
<td>Number</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].reqdate</span></td>
<td>요청 일시(YYYY-MM-DD HH:mm:ss)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].regdate</span></td>
<td>등록 일시(YYYY-MM-DD HH:mm:ss)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].reserveCYn</span></td>
<td>예약 취소 여부(Y/N)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">localDateTime</span></td>
<td>서버 처리 일시(ISO-8601)</td>
<td>String</td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ JSON 객체로 응답합니다.</p>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div>
<div class="code_view">
<pre>
<code class="language-json">
{
"resultCode": "0",
"data": {
"resultCode": 0,
"objectList": [
{
"msgGroupId": "MSGGID_XXXXXXX0000063",
"msgId": "MSGCID_XXXXXXX00001180",
"totMsgCnt": "9",
"msgType": 8,
"msgTypeName": "알림톡(AT)",
"msgResult": "F",
"msgGroupCnt": 1,
"smsTxt": "test",
"callFrom": "01093414986",
"callTo": "01059941669",
"curState": 3,
"remainMsgCnt": 0,
"reqdate": "2025-09-05 11:45:45",
"regdate": "2025-09-05 11:45:45",
"reserveCYn": "N"
},
{
"msgGroupId": "MSGGID_XXXXXXX0000063",
"msgId": "MSGCID_XXXXXXX000001175",
"totMsgCnt": "9",
"msgType": 9,
"msgTypeName": "친구톡(AT)",
"msgResult": "F",
"msgGroupCnt": 1,
"smsTxt": "test",
"callFrom": "01093414986",
"callTo": "01098969885",
"curState": 3,
"remainMsgCnt": 0,
"reqdate": "2025-09-05 11:45:45",
"regdate": "2025-09-05 11:45:45",
"reserveCYn": "N"
},
]
},
"localDateTime": "2025-09-16T10:47:20.4014362"
}
</code>
</pre>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div>
<div class="code_view">
<pre><code class="language-json">
{
"resultCode": "4099",
"data": "기타 시스템 오류"
}
</code></pre>
</div>
</div>
<!-- // Response -->
</div>
<!--// Response-->

496
src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab8.jsp
View File

@ -1,195 +1,303 @@
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<ul class="info">
<li>- 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.</li>
<li>- 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.</li>
</ul>
<div class="re_cont">
<!--Request--> <ul class="info">
<div class="req_title">Request</div> <li>- 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS), 알림톡(AT), 친구톡(FT)별로 각각 확인할 수 있습니다.</li>
<div class="box"> <!-- <li>- 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫 결제 이벤트"는 적용되지 않습니다.</li> -->
<div class="text"> </ul>
<h4>Request</h4>
<table> <div class="re_cont">
<caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption> <!-- Request -->
<colgroup> <div class="req_title">Request</div>
<col style="width:20%;"> <div class="box">
<col style="width:80%;"> <div class="text">
</colgroup> <h4>Request</h4>
<tr> <table>
<th>Http Method</th> <caption>API Request Http Method, 프로토콜, HOST, Service Port, Endpoint 정보 테이블</caption>
<td>POST</td> <colgroup>
</tr> <col style="width:20%;">
<tr> <col style="width:80%;">
<th>프로토콜</th> </colgroup>
<td>HTTP/1.1</td> <tr>
</tr> <th>Http Method</th>
<tr> <td>POST</td>
<th>HOST</th> </tr>
<td>api.munjaon.co.kr</td> <tr>
</tr> <th>프로토콜</th>
<tr> <td>HTTPS/1.1</td>
<th>Service Port</th> </tr>
<td>443</td> <tr>
</tr> <th>HOST</th>
</table> <td>api.munjaon.co.kr</td>
</div> </tr>
</div> <tr>
<div class="type_table"> <th>Service Port</th>
<table> <td>443</td>
<caption>발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption> </tr>
<colgroup> <tr>
<col style="width:20%;"> <th>Endpoint</th>
<col style="width:45%;"> <td>/api/inqry/price</td>
<col style="width:25%"> </tr>
<col style="width:10%"> </table>
</colgroup> </div>
<thead> </div>
<tr>
<th>키</th> <div class="type_table">
<th>설명</th> <table>
<th>타입</th> <caption>가격/가능건수 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption>
<th>필수</th> <colgroup>
</tr> <col style="width:20%;">
</thead> <col style="width:45%;">
<tbody> <col style="width:25%">
<tr> <col style="width:10%">
<td><span class="font_b">mberId</span></td> </colgroup>
<td>사용자 ID</td> <thead>
<td>String</td> <tr>
<td><span class="select_o">O</span></td> <th>키</th>
</tr> <th>설명</th>
<tr> <th>타입</th>
<td><span class="font_b">accessKey</span></td> <th>필수</th>
<td>인증용 API Key</td> </tr>
<td>String</td> </thead>
<td><span class="select_o">O</span></td> <tbody>
</tr> <tr>
</tbody> <td><span class="font_b">mberId</span></td>
</table> <td>사용자 ID</td>
<div class="table_info"> <td>String</td>
<p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p> <td><span class="select_o">O</span></td>
</div> </tr>
</div> <tr>
<div class="box"> <td><span class="font_b">accessKey</span></td>
<div class="title">[Example]</div> <td>인증용 API Key</td>
<div class="code_view"> <td>String</td>
<p>&#65371;</p> <td><span class="select_o">O</span></td>
<div class="indent"> </tr>
<p><span>"mberId"</span>:"String"</p> </tbody>
<p>,<span>"accessKey"</span>:"String"</p> </table>
</div> <div class="table_info">
<p class="l_code">&#65373;</p> <p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p>
</div> <p>※ Content-Type: application/json</p>
</div> </div>
<!--// Request--> </div>
<!-- Response-->
<div class="res_title">Response</div> <div class="box">
<div class="type_table"> <div class="title">[Example]</div>
<table> <div class="code_view">
<caption>발송가능 건수 API Response 키 종류 및 설명, 타입 테이블</caption> <pre>
<colgroup> <code class="language-json">
<col style="width:20%;"> {
<col style="width:60%;">
<col style="width:20%;"> "mberId": "홍길동",
</colgroup>
<thead> "accessKey": "XXXXXXXXXXXXXX414050694b953"
<tr> }
<th>키</th> </code>
<th>설명</th> </pre>
<th>타입</th> </div>
</tr> </div>
</thead> <!-- // Request -->
<tbody>
<tr> <!-- Response -->
<td><span class="font_b">resultCode</span></td> <div class="res_title">Response</div>
<td>성공 여부("0" 아니면 실패)</td> <div class="type_table">
<td>String</td> <table>
</tr> <caption>가격/가능건수 조회 API Response 키 종류 및 설명, 타입 테이블</caption>
<tr> <colgroup>
<td><span class="font_b">data</span></td> <col style="width:20%;">
<td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td> <col style="width:60%;">
<td>Object</td> <col style="width:20%;">
</tr> </colgroup>
<tr> <thead>
<td><span class="font_b">[data].longPrice</span></td> <tr>
<td>장문 단가</td> <th>키</th>
<td>String</td> <th>설명</th>
</tr> <th>타입</th>
<tr> </tr>
<td><span class="font_b">[data].longSendPsbltEa</span></td> </thead>
<td>장문 발송 가능 건수</td> <tbody>
<td>String</td> <tr>
</tr> <td><span class="font_b">resultCode</span></td>
<tr> <td>성공 여부("0" 이외는 실패)</td>
<td><span class="font_b">[data].mberMoney</span></td> <td>String</td>
<td>현재 보유 금액</td> </tr>
<td>String</td> <tr>
</tr> <td><span class="font_b">data</span></td>
<tr> <td>조회 결과 객체(성공 시 가격/가능건수 정보)</td>
<td><span class="font_b">[data].message</span></td> <td>Object | String</td>
<td>문자</td> </tr>
<td>String</td> <tr>
</tr> <td><span class="font_b">[data].resultCode</span></td>
<tr> <td>내부 처리 결과("0": 성공)</td>
<td><span class="font_b">[data].picturePrice</span></td> <td>String</td>
<td>그림문자 단가</td> </tr>
<td>String</td> <tr>
</tr> <td><span class="font_b">[data].message</span></td>
<tr> <td>메시지(필요 시)</td>
<td><span class="font_b">[data].pictureSendPsbltEa</span></td> <td>String</td>
<td>그림문자 발송 가능 건수</td> </tr>
<td>String</td> <tr>
</tr> <td><span class="font_b">[data].localDateTime</span></td>
<tr> <td>서버 처리 일시(ISO-8601)</td>
<td><span class="font_b">[data].shortPrice</span></td> <td>String</td>
<td>단문 단가</td> </tr>
<td>String</td> <tr>
</tr> <td><span class="font_b">[data].shortPrice</span></td>
<tr> <td>단문(SMS) 단가</td>
<td><span class="font_b">[data].shortSendPsbltEa</span></td> <td>Number</td>
<td>단문 발송 가능 건수</td> </tr>
<td>String</td> <tr>
</tr> <td><span class="font_b">[data].longPrice</span></td>
</tbody> <td>장문(LMS) 단가</td>
</table> <td>Number</td>
<div class="table_info"> </tr>
<p>※ JSON 객체로 응답합니다.</p> <tr>
</div> <td><span class="font_b">[data].picturePrice</span></td>
</div> <td>사진(MMS) 단가</td>
<div class="box"> <td>Number</td>
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div> </tr>
<div class="code_view"> <tr>
<p>&#65371;</p> <td><span class="font_b">[data].kakaoAtPrice</span></td>
<div class="indent"> <td>카카오 알림톡 단가</td>
<p><span>"resultCode"</span>:"0"</p> <td>Number</td>
<p>,<span>"data"</span>&#65371;</p> </tr>
<div class="indent_t1"> <tr>
<p><span>"longPrice"</span>:"50"</p> <td><span class="font_b">[data].kakaoFtPrice</span></td>
<p>,<span>"longSendPsbltEa"</span>:"19651"</p> <td>카카오 친구톡(텍스트) 단가</td>
<p>,<span>"mberMoney"</span>:"982586.7"</p> <td>Number</td>
<p>,<span>"message"</span>:null</p> </tr>
<p>,<span>"picturePrice"</span>:"90"</p> <tr>
<p>,<span>"pictureSendPsbltEa"</span>:"10917"</p> <td><span class="font_b">[data].kakaoFtImgPrice</span></td>
<p>,<span>"shortPrice"</span>:"18"</p> <td>카카오 친구톡(이미지) 단가</td>
<p>,<span>"shortSendPsbltEa"</span>:"54588"</p> <td>Number</td>
</div> </tr>
<p>&#65373;</p> <tr>
</div> <td><span class="font_b">[data].kakaoFtWideImgPrice</span></td>
<p class="l_code">&#65373;</p> <td>카카오 친구톡(와이드 이미지) 단가</td>
</div> <td>Number</td>
</div> </tr>
<div class="box"> <tr>
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div> <td><span class="font_b">[data].mberMoney</span></td>
<div class="code_view"> <td>회원 보유 금액</td>
<p>&#65371;</p> <td>Number</td>
<div class="indent"> </tr>
<p><span>"resultCode"</span>:"5099"</p> <tr>
<p>,<span>"data"</span>:"기타 시스템 오류"</p> <td><span class="font_b">[data].shortSendPsbltEa</span></td>
</div> <td>단문 발송 가능 건수</td>
<p class="l_code">&#65373;</p> <td>Number</td>
</div> </tr>
</div> <tr>
<!--// Response--> <td><span class="font_b">[data].longSendPsbltEa</span></td>
</div> <td>장문 발송 가능 건수</td>
<td>Number</td>
</tr>
<tr>
<td><span class="font_b">[data].pictureSendPsbltEa</span></td>
<td>사진 발송 가능 건수</td>
<td>Number</td>
</tr>
<tr>
<td><span class="font_b">[data].kakaoAtSendPsbltEa</span></td>
<td>알림톡 발송 가능 건수</td>
<td>Number</td>
</tr>
<tr>
<td><span class="font_b">[data].kakaoFtSendPsbltEa</span></td>
<td>친구톡(텍스트) 발송 가능 건수</td>
<td>Number</td>
</tr>
<tr>
<td><span class="font_b">[data].kakaoFtImgSendPsbltEa</span></td>
<td>친구톡(이미지) 발송 가능 건수</td>
<td>Number</td>
</tr>
<tr>
<td><span class="font_b">[data].kakaoFtWideImgSendPsbltEa</span></td>
<td>친구톡(와이드 이미지) 발송 가능 건수</td>
<td>Number</td>
</tr>
<tr>
<td><span class="font_b">localDateTime</span></td>
<td>서버 처리 일시(ISO-8601)</td>
<td>String</td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ JSON 객체로 응답합니다.</p>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div>
<div class="code_view">
<pre>
<code class="language-json">
{
"resultCode": "0",
"data": {
"resultCode": "0",
"message": "",
"localDateTime": "2025-09-16T11:06:40.2556646",
"shortPrice": 18.0,
"longPrice": 50.0,
"picturePrice": 90.0,
"kakaoAtPrice": 6.9,
"kakaoFtPrice": 13.8,
"kakaoFtImgPrice": 19.9,
"kakaoFtWideImgPrice": 22.9,
"mberMoney": 6549661.26,
"shortSendPsbltEa": 363870,
"longSendPsbltEa": 130993,
"pictureSendPsbltEa": 72774,
"kakaoAtSendPsbltEa": 949226,
"kakaoFtSendPsbltEa": 474613,
"kakaoFtImgSendPsbltEa": 329128,
"kakaoFtWideImgSendPsbltEa": 286011
},
"localDateTime": "2025-09-16T11:06:40.2556646"
}
</code>
</pre>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div>
<div class="code_view">
<pre><code class="language-json">
{
"resultCode": "3099",
"data": "기타 시스템 오류"
}
</code></pre>
</div>
</div>
<!-- // Response -->
</div>
<!--// Response-->

415
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab1.jsp
View File

@ -7,210 +7,233 @@
<!-- <li>- 발신번호는 문자온 사이트를 통해 사전등록 후 이용하실 수 있습니다.(마이페이지-발신번호 관리 메뉴 이용)</li> --> <!-- <li>- 발신번호는 문자온 사이트를 통해 사전등록 후 이용하실 수 있습니다.(마이페이지-발신번호 관리 메뉴 이용)</li> -->
<!-- <li>- 문자 내용이 "90byte"를 초과하는 경우 장문(LMS)으로 자동 전환됩니다.</li> --> <!-- <li>- 문자 내용이 "90byte"를 초과하는 경우 장문(LMS)으로 자동 전환됩니다.</li> -->
</ul> </ul>
<div class="re_cont"> <div class="re_cont">
<!--Request--> <!-- Request -->
<div class="req_title">Request</div> <div class="req_title">Request</div>
<div class="box"> <div class="box">
<div class="text"> <div class="text">
<h4>Request</h4> <h4>Request</h4>
<table> <table>
<caption>API Request Http Method, 프로토콜, HOST, Service Port <caption>API Request Http Method, 프로토콜, HOST, Service Port, Endpoint 정보 테이블</caption>
정보 테이블</caption> <colgroup>
<colgroup> <col style="width:20%;">
<col style="width: 20%;"> <col style="width:80%;">
<col style="width: 80%;"> </colgroup>
</colgroup> <tr>
<tr> <th>Http Method</th>
<th>Http Method</th> <td>POST</td>
<td>POST</td> </tr>
</tr> <tr>
<tr> <th>프로토콜</th>
<th>프로토콜</th> <td>HTTPS/1.1</td>
<td>HTTP/1.1</td> </tr>
</tr> <tr>
<tr> <th>HOST</th>
<th>HOST</th> <td>api.munjaon.co.kr</td>
<td>api.munjaon.co.kr</td> </tr>
</tr> <tr>
<tr> <th>Service Port</th>
<th>Service Port</th> <td>443</td>
<td>443</td> </tr>
</tr> <tr>
</table> <th>Endpoint</th>
</div> <td>/api/kakao/inqry/chnlId</td>
</div> </tr>
<div class="type_table"> </table>
<table>
<caption>문자발송 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption>
<colgroup>
<col style="width: 20%;">
<col style="width: 45%;">
<col style="width: 25%">
<col style="width: 10%">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
<th>필수</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">mberId</span></td>
<td>사용자 ID</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">accessKey</span></td>
<td>인증용 API Key</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p>
<p>※ 문자 텍스트 용량(byte) : 한글 1자당 2byte, 영문/숫자 1자당 1byte</p>
</div>
</div>
<div class="box">
<div class="title">[Example]</div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p>
<span>"mberId"</span>:"홍길동"
</p>
<p>
,<span>"accessKey"</span>:"XXXXXXXXXXXXXX414050694b953"
</p>
</div> </div>
<p class="l_code">&#65373;</p>
</div> </div>
</div>
<!--// Request-->
<!-- Response-->
<div class="res_title">Response</div>
<div class="type_table">
<table>
<caption>문자발송 API Response 키 종류 및 설명, 타입 테이블</caption>
<colgroup>
<col style="width: 20%;">
<col style="width: 60%;">
<col style="width: 20%;">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">resultCode</span></td>
<td>성공 여부 ("0" 이면 성공, 그 외는 실패)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">data</span></td>
<td>응답 결과 객체 (성공 시 배열, 실패 시 메시지)</td>
<td>Array&lt;Object&gt;</td>
</tr>
<tr>
<td><span class="font_b">data[].userId</span></td>
<td>사용자 ID</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">data[].senderKey</span></td>
<td>발신자 키</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">data[].phoneNumber</span></td>
<td>수신자 전화번호</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">data[].yellowId</span></td>
<td>카카오톡 채널 ID</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">data[].firstRegistPnttm</span></td>
<td>최초 등록 시각 (yyyy‑MM‑dd HH:mm:ss)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">data[].firstRegisterId</span></td>
<td>최초 등록자 ID</td>
<td>String</td>
</tr>
</tbody>
</table>
<div class="table_info"> <div class="type_table">
<p>※ JSON 객체로 응답합니다.</p> <table>
</div> <caption>채널ID 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption>
</div> <colgroup>
<div class="box"> <col style="width:20%;">
<div class="title_t1"> <col style="width:45%;">
<span class="ex">[Example]</span><span class="ex_success">O 성공 <col style="width:25%">
예시</span> <col style="width:10%">
</div> </colgroup>
<div class="code_view"> <thead>
<p>&#65371;</p> <tr>
<div class="indent"> <th>키</th>
<p> <th>설명</th>
<span>"resultCode"</span>:"0" <th>타입</th>
</p> <th>필수</th>
<p> </tr>
,<span>"data"</span>&#65371; </thead>
</p> <tbody>
<div class="indent_t1"> <tr>
<p> <td><span class="font_b">mberId</span></td>
,<span>"senderKey"</span>:"6691434xxxxxxxxxxxxxxxxxxxxxxxxx" <td>사용자 ID</td>
</p> <td>String</td>
<p> <td><span class="select_o">O</span></td>
,<span>"phoneNumber"</span>:"010xxxxxxxx" </tr>
</p> <tr>
<p> <td><span class="font_b">accessKey</span></td>
,<span>"yellowId"</span>:"@ID" <td>인증용 API Key</td>
</p> <td>String</td>
<p> <td><span class="select_o">O</span></td>
,<span>"firstRegistPnttm"</span>:"2025-10-05 18:08:58" </tr>
</p> <tr>
<p> <td><span class="font_b">test_yn</span></td>
,<span>"firstRegisterId"</span>:"userId" <td>테스트 데이터 여부 (YS: 성공 테스트, YF: 실패 테스트)</td>
</p> <td>String</td>
</div> <td><span class="select_x">X</span></td>
<p>&#65373;</p> </tr>
</tbody>
</table>
<div class="table_info">
<p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p>
<p>※ Content-Type: application/json</p>
</div> </div>
<p class="l_code">&#65373;</p>
</div> </div>
</div>
<div class="box"> <div class="box">
<div class="title_t1"> <div class="title">[Example]</div>
<span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span> <div class="code_view">
</div> <pre>
<div class="code_view"> <code class="language-json">
<p>&#65371;</p> {
<div class="indent">
<p> "mberId": "홍길동",
<span>"resultCode"</span>:"401"
</p> "accessKey": "XXXXXXXXXXXXXX414050694b953",
<p>
,<span>"message"</span>:"Unauthorized" "test_yn": ""
</p> }
</code>
</pre>
</div> </div>
<p class="l_code">&#65373;</p>
</div> </div>
<!-- // Request -->
<!-- Response -->
<div class="res_title">Response</div>
<div class="type_table">
<table>
<caption>채널ID 조회 API Response 키 종류 및 설명, 타입 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:60%;">
<col style="width:20%;">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">resultCode</span></td>
<td>성공 여부("0" 이외는 실패)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">data</span></td>
<td>조회 결과 목록(성공 시 배열, 실패 시 오류 메시지)</td>
<td>Array | String</td>
</tr>
<tr>
<td><span class="font_b">[data][i].senderKey</span></td>
<td>발신 프로필 SenderKey</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data][i].phoneNumber</span></td>
<td>대표 전화번호</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data][i].yellowId</span></td>
<td>카카오 채널(옐로아이디)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data][i].frstRegistPnttm</span></td>
<td>최초 등록 일시(YYYY-MM-DD HH:mm:ss)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data][i].frstRegisterId</span></td>
<td>최초 등록자 ID</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">localDateTime</span></td>
<td>서버 처리 일시(ISO-8601)</td>
<td>String</td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ JSON 객체로 응답합니다.</p>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div>
<div class="code_view">
<pre>
<code class="language-json">
{
"resultCode": "0",
"data": [
{
"senderKey": "test_sender_key_001",
"phoneNumber": "02-1234-0000",
"yellowId": "@test_channel_001",
"frstRegistPnttm": "2025-09-09 12:44:21",
"frstRegisterId": "test_id_one"
},
{
"senderKey": "test_sender_key_002",
"phoneNumber": "02-1234-0001",
"yellowId": "@test_channel_002",
"frstRegistPnttm": "2025-09-09 12:44:21",
"frstRegisterId": "test_id_tow"
}
],
"localDateTime": "2025-09-09T12:44:21.624464"
}
</code>
</pre>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div>
<div class="code_view">
<pre><code class="language-json">
{
"resultCode": "2099",
"data": "기타 시스템 오류"
}
</code></pre>
</div>
</div>
<!-- // Response -->
</div> </div>
<!--// Response--> <!--// Response-->
</div>

552
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab2.jsp
View File

@ -1,232 +1,326 @@
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<ul class="info">
<li>- API를 통해서 카카오 친구톡(FT)을 발송할 수 있습니다.</li>
<li>- 버튼 타입은 <b>WL(웹링크), AL(앱링크)</b>만 지원합니다.</li>
<li>- 대체문자(subMsgTxt) 발송 여부는 subMsgSendYn으로 제어합니다.</li>
</ul>
<div class="re_cont">
<!-- Request -->
<div class="req_title">Request</div>
<div class="box">
<div class="text">
<h4>Request</h4>
<table>
<caption>API Request Http Method, 프로토콜, HOST, Service Port, Endpoint 정보 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:80%;">
</colgroup>
<tr>
<th>Http Method</th>
<td>POST</td>
</tr>
<tr>
<th>프로토콜</th>
<td>HTTPS/1.1</td>
</tr>
<tr>
<th>HOST</th>
<td>api.munjaon.co.kr</td>
</tr>
<tr>
<th>Service Port</th>
<td>443</td>
</tr>
<tr>
<th>Endpoint</th>
<td>/api/kakao/ft/sendMsg</td>
</tr>
</table>
</div>
</div>
<div class="type_table">
<table>
<caption>친구톡 발송 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:45%;">
<col style="width:25%">
<col style="width:10%">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
<th>필수</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">mberId</span></td>
<td>사용자 ID</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">accessKey</span></td>
<td>인증용 API Key</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">senderKey</span></td>
<td>발신 프로필 SenderKey</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">adFlag</span></td>
<td>광고 여부 (Y/N)</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">subMsgSendYn</span></td>
<td>대체문자 발송 여부 (Y/N)</td>
<td>String</td>
<td><span class="select_x">X</span></td>
</tr>
<tr>
<td><span class="font_b">callFrom</span></td>
<td>발신자 번호</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">callTo_[i]</span></td>
<td>수신자 번호</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">templateContent_[i]</span></td>
<td>친구톡 본문</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">templateImage</span></td>
<td>친구톡 이미지(PNG,JPG)</td>
<td>File</td>
<td><span class="select_x">X</span></td>
</tr>
<tr>
<td><span class="font_b">subMsgTxt_[i]</span></td>
<td>대체문자 내용</td>
<td>String</td>
<td><span class="select_x">X</span></td>
</tr>
<tr>
<td><span class="font_b">button</span></td>
<td>버튼 JSON 문자열(AL:앱링크, WL:웹링크 지원)</td>
<td>String(JSON)</td>
<td><span class="select_x">X</span></td>
</tr>
<tr>
<td><span class="font_b">test_yn</span></td>
<td>테스트 데이터 여부 (YS: 성공 테스트, YF: 실패 테스트)</td>
<td>String</td>
<td><span class="select_x">X</span></td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p>
<p>※ Content-Type: application/json</p>
</div>
</div>
<div class="box">
<div class="title">[Example]</div>
<div class="code_view">
<pre>
<code class="language-json">
{
"mberId": "dudgusw",
"accessKey": "3429312e6a2c732188d4cc7d15d8a1baa01d8d91",
"senderKey": "e42e34ee013147720711b4add6d181adbe4ce45f",
"adFlag": "N",
"subMsgSendYn": "Y",
"callFrom": "010-9341-4986",
"callTo_1": "01083584250",
"callTo_2": "01083584251",
"templateContent_1": "친구톡 본문 1",
"templateContent_2": "친구톡 본문 2",
"subMsgTxt_1": "대체문자 발송1",
"subMsgTxt_2": "대체문자 발송2",
"{ button": [
{
"name": "주문조회",
<ul class="info"> "linkType": "WL",
<li>- API를 통해서 다른 내용의 문자를 대량으로 전송할 수 있습니다.</li>
<li>- 발신번호는 문자온 사이트를 통해 사전등록 후 이용하실 수 있습니다.(마이페이지-발신번호 관리 메뉴 이용)</li> "linkPc": "PC 링크",
<li>- 문자 내용이 "90byte"를 초과하는 경우 장문(LMS)으로 자동 전환됩니다.</li>
</ul> "linkMo": "모바일 링크"
},
{
"name": "앱 열기",
"linkType": "AL",
"linkIos": "ios링크",
"linkAnd": "Android 링크"
}
]}"
}
</code>
</pre>
</div>
</div>
<!-- // Request -->
<div class="re_cont"> <!-- Response -->
<!--Request--> <div class="res_title">Response</div>
<div class="req_title">Request</div> <div class="type_table">
<div class="box"> <table>
<div class="text"> <caption>친구톡 발송 API Response 키 종류 및 설명, 타입 테이블</caption>
<h4>Request</h4> <colgroup>
<table> <col style="width:20%;">
<caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption> <col style="width:60%;">
<colgroup> <col style="width:20%;">
<col style="width:20%;"> </colgroup>
<col style="width:80%;"> <thead>
</colgroup> <tr>
<tr> <th>키</th>
<th>Http Method</th> <th>설명</th>
<td>POST</td> <th>타입</th>
</tr> </tr>
<tr> <thead>
<th>프로토콜</th> <tbody>
<td>HTTP/1.1</td> <tr>
</tr> <td><span class="font_b">resultCode</span></td>
<tr> <td>성공 여부("0" 이외는 실패)</td>
<th>HOST</th> <td>String</td>
<td>api.munjaon.co.kr</td> </tr>
</tr> <tr>
<tr> <td><span class="font_b">data</span></td>
<th>Service Port</th> <td>발송 결과 객체</td>
<td>443</td> <td>Object</td>
</tr> </tr>
</table> <tr>
</div> <td><span class="font_b">[data].resultCode</span></td>
</div> <td>내부 처리 결과("0": 성공)</td>
<div class="type_table"> <td>String</td>
<table> </tr>
<caption>문자발송 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption> <tr>
<colgroup> <td><span class="font_b">[data].msgType</span></td>
<col style="width: 20%;"> <td>메시지 타입(FT: 친구톡)</td>
<col style="width: 45%;"> <td>String</td>
<col style="width: 25%"> </tr>
<col style="width: 10%"> <tr>
</colgroup> <td><span class="font_b">[data].msgGroupIdList</span></td>
<thead> <td>발송된 메시지 그룹 ID 목록</td>
<tr> <td>Array&lt;String&gt;</td>
<th>키</th> </tr>
<th>설명</th> <tr>
<th>타입</th> <td><span class="font_b">[data].successCnt</span></td>
<th>필수</th> <td>성공 건수</td>
</tr> <td>String | Number</td>
</thead> </tr>
<tbody> <tr>
<tr> <td><span class="font_b">[data].failCnt</span></td>
<td><span class="font_b">mberId</span></td> <td>실패 건수</td>
<td>사용자 ID</td> <td>String | Number</td>
<td>String</td> </tr>
<td><span class="select_o">O</span></td> <tr>
</tr> <td><span class="font_b">localDateTime</span></td>
<tr> <td>서버 처리 일시(ISO-8601)</td>
<td><span class="font_b">accessKey</span></td> <td>String</td>
<td>인증용 API Key</td> </tr>
<td>String</td> </tbody>
<td><span class="select_o">O</span></td> </table>
</tr> <div class="table_info">
<tr> <p>※ JSON 객체로 응답합니다.</p>
<td><span class="font_b">senderKey</span></td> </div>
<td>발신 프로필 Key</td> </div>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ 문자 텍스트 용량(byte) : 한글 1자당 2byte, 영문/숫자 1자당 1byte</p>
</div>
</div>
<div class="box">
<div class="title">[Example]</div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"mberId"</span>:"홍길동"</p>
<p>,<span>"accessKey"</span>:"414050694b953XXXXXXXXXXXXXX"</p>
<p>,<span>"senderKey"</span>:"669143473b1af459628b8bdXXXXXXXXXXXXXX"</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<!--// Request-->
<!-- Response-->
<div class="res_title">Response</div>
<div class="type_table">
<table>
<caption>문자발송(대량) API Response 키 종류 및 설명, 타입 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:60%;">
<col style="width:20%;">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">resultCode</span></td>
<td>성공 여부("0" 아니면 실패)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">data</span></td>
<td>템플릿 정보 리스트</td>
<td>Array</td>
</tr>
<tr>
<td><span class="font_b">[data].senderKey</span></td>
<td>발신 프로필 키</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].templateCode</span></td>
<td>템플릿 코드</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].templateName</span></td>
<td>템플릿 이름</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].createdAt</span></td>
<td>생성일시</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].modifiedAt</span></td>
<td>수정일시</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].serviceStatus</span></td>
<td>템플릿 상태 <br>(REG: 등록, REQ: 검수요청, REJ: 반려,
STP: 차단, RDY: 발송전, ACT: 정상, DMT: 휴면, BLK:
차단)</td>
<td>String</td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ JSON 객체로 응답합니다.</p>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div>
<div class="code_view"> <div class="box">
<p>&#65371;</p> <div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div>
<div class="indent"> <div class="code_view">
<p> <pre>
<span>"resultCode"</span>:"0" <code class="language-json">
</p> {
<p> "resultCode": "0",
,<span>"data"</span>&#65371;
</p> "data": {
<div class="indent_t1">
<p> "resultCode": "0",
,<span>"senderKey"</span>:"669143473b1af459628xxxxxxxxxxxxxxxxxxxxx"
</p> "msgType": "FT",
<p>
,<span>"templateCode"</span>:"bizp_20250527112232xxxxxxxxxxxxx" "msgGroupIdList": [
</p>
<p> "MSGGID_1758008282543",
,<span>"templateName"</span>:"템플릿 명"
</p> "MSGGID_1758008282543"
<p>
,<span>"createdAt"</span>:"2025-05-27 11:22:33" ],
</p>
<p> "successCnt": "2",
,<span>"modifiedAt"</span>:"2025-05-27 11:22:33"
</p> "failCnt": "0"
<p>
,<span>"serviceStatus"</span>:"REG(등록완료)" },
</p>
</div> "localDateTime": "2025-09-16T16:38:02.5436925"
<p>&#65373;</p>
<p>,&#65371;</p> }
<div class="indent_t1"> </code>
<p> </pre>
,<span>"senderKey"</span>:"669143473b1af459628xxxxxxxxxxxxxxxxxxxxx" </div>
</p> </div>
<p>
,<span>"templateCode"</span>:"bizp_20250527112232xxxxxxxxxxxxx" <div class="box">
</p> <div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div>
<p> <div class="code_view">
,<span>"templateName"</span>:"템플릿 명2" <pre><code class="language-json">
</p> {
<p>
,<span>"createdAt"</span>:"2025-05-27 11:22:33" "resultCode": "4420",
</p>
<p> "data": "버튼 타입은 WL/AL만 지원합니다.(button.linkType)"
,<span>"modifiedAt"</span>:"2025-05-27 11:22:33"
</p> }
<p> </code></pre>
,<span>"serviceStatus"</span>:"RDY(대기)" </div>
</p> </div>
</div> <!-- // Response -->
<p>&#65373;</p> </div>
</div> <!--// Response-->
<p class="l_code">&#65373;</p> </div>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"resultCode"</span>:"4099"</p>
<p>,<span>"msg"</span>:"기타 시스템 오류"</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<!--// Response-->
</div>

758
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab3.jsp
View File

@ -1,331 +1,433 @@
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<ul class="info">
<li>- 문자온 사이트 및 API를 통해 전송된 발송내역을 조회할 수 있습니다.</li>
<li>- 문자 발송내역은 날짜별로 조회되며, 최근 3개월까지만 조회 가능합니다.</li>
<li>- 발신번호별 문자 발송내역 조회 기능은 제공되지 않습니다.</li>
</ul>
<div class="re_cont">
<!--Request-->
<div class="req_title">Request</div>
<div class="box">
<div class="text">
<h4>Request</h4>
<table>
<caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:80%;">
</colgroup>
<tr>
<th>Http Method</th>
<td>POST</td>
</tr>
<tr>
<th>프로토콜</th>
<td>HTTPS/1.1</td>
</tr>
<tr>
<th>HOST</th>
<td>api.munjaon.co.kr</td>
</tr>
<tr>
<th>Service Port</th>
<td>443</td>
</tr>
<tr>
<th>Endpoint</th>
<td>/api/inqry/hstry</td>
</tr>
</table>
</div>
</div>
<div class="type_table">
<table>
<caption>전송결과 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:45%;">
<col style="width:25%">
<col style="width:10%">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
<th>필수</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">mberId</span></td>
<td>사용자 ID</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">accessKey</span></td>
<td>인증용 API Key</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">page</span></td>
<td>페이지 번호(미입력 시 1)</td>
<td>String</td>
<td><span class="select_x">X</span></td>
</tr>
<tr>
<td><span class="font_b">pageSize</span></td>
<td>페이지당 출력 개수(미입력 시 기본값 적용)</td>
<td>String</td>
<td><span class="select_x">X</span></td>
</tr>
<tr>
<td><span class="font_b">startDate</span></td>
<td>시작 일자(yyyyMMdd)</td>
<td>String</td>
<td><span class="select_x">X</span></td>
</tr>
<tr>
<td><span class="font_b">endDate</span></td>
<td>마감 일자(yyyyMMdd)</td>
<td>String</td>
<td><span class="select_x">X</span></td>
</tr>
<tr>
<td><span class="font_b">test_yn</span></td>
<td>테스트 데이터 여부</td>
<td>String</td>
<td><span class="select_x">X</span></td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p>
<p>※ Content-Type: application/json</p>
</div>
</div>
<div class="box">
<div class="title">[Example]</div>
<div class="code_view">
<pre>
<code class="language-json">
{
"mberId": "홍길동",
"accessKey": "XXXXXXXXXXXXXX414050694b953",
"page": "",
"pageSize": "",
"startDate": "",
"endDate": "",
"test_yn": ""
}
</code>
</pre>
</div>
</div>
<!--// Request-->
<!-- Response-->
<div class="res_title">Response</div>
<div class="type_table">
<table>
<caption>전송결과 조회 API Response 키 종류 및 설명, 타입 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:60%;">
<col style="width:20%;">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">resultCode</span></td>
<td>성공 여부("0" 아니면 실패)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">data</span></td>
<td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td>
<td>Object | String</td>
</tr>
<tr>
<td><span class="font_b">[data].message</span></td>
<td>메시지(필요 시)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].next_yn</span></td>
<td>다음 페이지 여부(Y/N)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList</span></td>
<td>결과값 목록</td>
<td>Array&lt;Object&gt;</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].msgGroupId</span></td>
<td>메시지 그룹 ID</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].msgId</span></td>
<td>메시지 ID</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].msgTypeName</span></td>
<td>문자 구분명(단문, 장문, 그림)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].msgType</span></td>
<td>메시지 타입(4: 단문, 5: 장문, 6: 그림)</td>
<td>String | Number</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].callFrom</span></td>
<td>발신자 번호</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].callTo</span></td>
<td>수신자 번호</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].msgGroupCnt</span></td>
<td>발송 건수</td>
<td>String | Number</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].scnt</span></td>
<td>성공 건수</td>
<td>String | Number</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].fcnt</span></td>
<td>실패 건수</td>
<td>String | Number</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].wcnt</span></td>
<td>대기 건수</td>
<td>String | Number</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].msgResult</span></td>
<td>발송 결과(성공: S, 실패: F)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].smsTxt</span></td>
<td>문자 내용</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].subject</span></td>
<td>제목</td>
<td>String | null</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].reqdate</span></td>
<td>발송 일자(YYYY-MM-DD HH:mm:ss)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].curState</span></td>
<td>전송 처리 결과값</td>
<td>String | Number</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].userId</span></td>
<td>사용자 ID</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].regdate</span></td>
<td>등록 일자(YYYY-MM-DD HH:mm:ss)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].objectList[i].reserveCYn</span></td>
<td>예약 취소 여부(Y/N)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].ttlCnt</span></td>
<td>전체 요청 수</td>
<td>String | Number</td>
</tr>
<tr>
<td><span class="font_b">[data].remainMsgCnt</span></td>
<td>남은 문자 건수</td>
<td>String | Number</td>
</tr>
<tr>
<td><span class="font_b">[data].totMsgCnt</span></td>
<td>전체 문자 개수</td>
<td>String | Number</td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ JSON 객체로 응답합니다.</p>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div>
<div class="code_view">
<pre>
<code class="language-json">
{
"resultCode": "0",
"data": {
"resultCode": "0",
"message": null,
"next_yn": "n",
"msgGroupId": "MSGGID_0000000000000",
"objectList": [
{
<ul class="info"> "msgTypeName": "단문(SMS)",
<li>- 문자온 사이트 및 API를 통해 전송된 문자 발송내역을 조회할 수 있습니다.</li>
<li>- 문자 발송내역은 날짜별로 조회되며, 최근 3개월까지만 조회 가능합니다.</li> "msgType": "4",
<li>- 발신번호별 문자 발송내역 조회 기능은 제공되지 않습니다.</li>
</ul> "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": "5",
"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"
}
]
}
}
</code>
</pre>
</div>
</div>
<div class="re_cont"> <div class="box">
<!--Request--> <div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div>
<div class="req_title">Request</div> <div class="code_view">
<div class="box"> <pre>
<div class="text"> <code class="language-json">
<h4>Request</h4> {
<table>
<caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:80%;">
</colgroup>
<tr>
<th>Http Method</th>
<td>POST</td>
</tr>
<tr>
<th>프로토콜</th>
<td>HTTP/1.1</td>
</tr>
<tr>
<th>HOST</th>
<td>api.munjaon.co.kr</td>
</tr>
<tr>
<th>Service Port</th>
<td>443</td>
</tr>
</table>
</div>
</div>
<div class="type_table">
<table>
<caption>전송결과 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:45%;">
<col style="width:25%">
<col style="width:10%">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
<th>필수</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">mberId</span></td>
<td>사용자 ID</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">accessKey</span></td>
<td>인증용 API Key</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">senderKey</span></td>
<td>발신 프로필 Key</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">templateCode</span></td>
<td>템플릿 코드</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p>
</div>
</div>
<div class="box">
<div class="title">[Example]</div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"mberId"</span>:"홍길동"</p>
<p>,<span>"accessKey"</span>:"414050694b953XXXXXXXXXXXXXX"</p>
<p>,<span>"senderKey"</span>:"669143473b1af459628b8bdXXXXXXXXXXXXXX"</p>
<p>,<span>"templateCode"</span>:"bizp_202503141052XXXXXXXXXXXXXX"</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<!--// Request-->
<!-- Response-->
<div class="res_title">Response</div>
<div class="type_table">
<table>
<caption>전송결과 조회 API Response 키 종류 및 설명, 타입 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:60%;">
<col style="width:20%;">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">resultCode</span></td>
<td>성공 여부("0" 아니면 실패)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">data</span></td>
<td>템플릿 정보 리스트</td>
<td>Array</td>
</tr>
<tr><td><span class="font_b">[data].templateCode</span></td><td>템플릿 코드</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateName</span></td><td>템플릿 이름</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateMessageType</span></td><td>템플릿 메시지 유형 (BA:기본형(default), EX:부가정보형, AD:광고추가형, MI:복합형)</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateEmphasizeType</span></td><td>템플릿 강조 유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, ITEM_LIST: 아이템리스트형)</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateContent</span></td><td>템플릿 내용</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateExtra</span></td><td>부가정보</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateAd</span></td><td>광고성 메시지</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateImageName</span></td><td>템플릿 이미지 파일명</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateImageUrl</span></td><td>템플릿 이미지 링크</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateTitle</span></td><td>템플릿 내용 중 강조 표기할 핵심 정보</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateSubtitle</span></td><td>강조 표기 보조 문구</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateHeader</span></td><td>헤더</td><td>String</td></tr>
<tr><td><span class="font_b">[data].categoryCode</span></td><td>템플릿 카테고리 코드</td><td>String</td></tr>
<tr><td><span class="font_b">[data].securityFlag</span></td><td>보안 템플릿 여부 (true:설정)</td><td>Boolean</td></tr>
<tr><td><span class="font_b">[data].inspectionStatus</span></td><td>검수 상태 (REG: 등록, REQ: 검수요청, REJ: 반려, APR: 승인)</td><td>String</td></tr>
<tr><td><span class="font_b">[data].createdAt</span></td><td>생성일</td><td>String</td></tr>
<tr><td><span class="font_b">[data].modifiedAt</span></td><td>수정일</td><td>String</td></tr>
<tr><td><span class="font_b">[data].status</span></td><td>템플릿 상태(D:중지, A:정상, R:대기(발송전))</td><td>String</td></tr>
<tr><td><span class="font_b">[data].block</span></td><td>템플릿 차단 여부 (true:차단, false: 해제)</td><td>Boolean</td></tr>
<tr><td><span class="font_b">[data].dormant</span></td><td>템플릿 휴면 여부 (true:휴면, false: 해제)</td><td>Boolean</td></tr>
<tr><td><span class="font_b">[data].templateItemHighlight</span></td><td>아이템 하이라이트</td><td>Object</td></tr>
<tr><td><span class="font_b">[data].templateItemHighlight.title</span></td><td>타이틀</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateItemHighlight.description</span></td><td>상세 설명</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateItemHighlight.imageUrl</span></td><td>썸네일 이미지 주소</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateItem</span></td><td>아이템 정보</td><td>Object</td></tr>
<tr><td><span class="font_b">[data].templateItem.list[]</span></td><td>아이템 리스트</td><td>Array</td></tr>
<tr><td><span class="font_b">[data].templateItem.list[].title</span></td><td>타이틀</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateItem.list[].description</span></td><td>디스크립션</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateItem.summary</span></td><td>아이템 요약 정보</td><td>Object</td></tr>
<tr><td><span class="font_b">[data].templateItem.summary.title</span></td><td>타이틀</td><td>String</td></tr>
<tr><td><span class="font_b">[data].templateItem.summary.description</span></td><td>디스크립션</td><td>String</td></tr>
<!-- buttons -->
<tr><td><span class="font_b">[data].buttons[]</span></td><td>버튼 정보</td><td>Array</td></tr>
<tr><td><span class="font_b">[data].buttons[].name</span></td><td>버튼명</td><td>String</td></tr>
<tr><td><span class="font_b">[data].buttons[].linkType</span></td><td>버튼 링크타입 (DS:배송조회, WL:웹링크, AL:앱링크, BK:봇키워드, MD: 메시지전달, AC: 채널추가, BC: 상담톡전환, BT: 봇전환, P1: 이미지 보안전송 플러그인, P2: 개인정보이용 플러그인, P3: 원클릭 결제 플러그인)</td><td>String</td></tr>
<tr><td><span class="font_b">[data].buttons[].linkAnd</span></td><td>Android 앱 링크 주소</td><td>String</td></tr>
<tr><td><span class="font_b">[data].buttons[].linkIos</span></td><td>IOS 앱 링크 주소</td><td>String</td></tr>
<tr><td><span class="font_b">[data].buttons[].linkMo</span></td><td>모바일 웹 링크 주소</td><td>String</td></tr>
<tr><td><span class="font_b">[data].buttons[].linkPc</span></td><td>PC 웹 링크 주소</td><td>String</td></tr>
<tr><td><span class="font_b">[data].buttons[].pluginId</span></td><td>플러그인 ID</td><td>String</td></tr>
<!-- quickReplies -->
<tr><td><span class="font_b">[data].quickReplies[]</span></td><td>바로연결 정보</td><td>Array</td></tr>
<tr><td><span class="font_b">[data].quickReplies[].name</span></td><td>바로연결명</td><td>String</td></tr>
<tr><td><span class="font_b">[data].quickReplies[].linkType</span></td><td>바로연결 링크타입 (WL:웹링크, AL:앱링크, BK:봇키워드, MD: 메시지전달, BC: 상담톡전환, BT: 봇전환)</td><td>String</td></tr>
<tr><td><span class="font_b">[data].quickReplies[].linkAnd</span></td><td>Android 앱 링크 주소</td><td>String</td></tr>
<tr><td><span class="font_b">[data].quickReplies[].linkIos</span></td><td>IOS 앱 링크 주소</td><td>String</td></tr>
<tr><td><span class="font_b">[data].quickReplies[].linkMo</span></td><td>모바일 웹 링크 주소</td><td>String</td></tr>
<tr><td><span class="font_b">[data].quickReplies[].linkPc</span></td><td>PC 웹 링크 주소</td><td>String</td></tr>
<!-- comments -->
<tr><td><span class="font_b">[data].comments[]</span></td><td>댓글 목록</td><td>Array</td></tr>
<tr><td><span class="font_b">[data].comments[].content</span></td><td>댓글 본문</td><td>String</td></tr>
<tr><td><span class="font_b">[data].comments[].createdAt</span></td><td>댓글 생성일</td><td>String</td></tr>
<tr><td><span class="font_b">[data].comments[].status</span></td><td>댓글 상태 (REQ:등록, INQ:문의, APR:승인, REJ:반려, REP:답변)</td><td>String</td></tr>
<tr><td><span class="font_b">[data].comments[].userName</span></td><td>댓글 작성자</td><td>String</td></tr>
<tr><td><span class="font_b">[data].comments[].attachment</span></td><td>첨부파일</td><td>Array</td></tr>
<!-- attachment 내부 -->
<tr><td><span class="font_b">[data].comments[].attachment[]</span></td><td>첨부파일</td><td>Array</td></tr>
<tr><td><span class="font_b">[data].comments[].attachment[].originalFileName</span></td><td>업로드한 파일 이름</td><td>String</td></tr>
<tr><td><span class="font_b">[data].comments[].attachment[].filePath</span></td><td>파일 다운로드 경로</td><td>String</td></tr>
</tbody> "resultCode": "3099",
</table>
<div class="table_info"> "data": "기타 시스템 오류"
<p>※ JSON 객체로 응답합니다.</p> }
</div> </code>
</div> </pre>
<div class="box"> </div>
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div> </div>
<div class="code_view"> <!--// Response-->
<p>&#65371;</p> </div>
<div class="indent">
<p><span>"resultCode"</span>:"0"</p>
<p>,<span>"data"</span>:&#65339;</p>
<p>&#65371;</p>
<div class="indent_t1">
<p><span>"templateCode"</span>: "bizp_20250314105XXXXXXXXXXXXXXX"</p>
<p>,<span>"templateName"</span>: "템플릿 명"</p>
<p>,<span>"templateMessageType"</span>: "BA"</p>
<p>,<span>"templateEmphasizeType"</span>: "TEXT"</p>
<p>,<span>"templateContent"</span>: "템플릿 내용 예시"</p>
<p>,<span>"templateExtra"</span>: "부가정보"</p>
<p>,<span>"templateAd"</span>: "광고성 문구"</p>
<p>,<span>"templateImageName"</span>: "template.jpg"</p>
<p>,<span>"templateImageUrl"</span>: "https://cdn.example.com/image.jpg"</p>
<p>,<span>"templateTitle"</span>: "강조 제목"</p>
<p>,<span>"templateSubtitle"</span>: "보조 문구"</p>
<p>,<span>"templateHeader"</span>: "템플릿 헤더"</p>
<p>,<span>"categoryCode"</span>: "005001"</p>
<p>,<span>"securityFlag"</span>: true</p>
<p>,<span>"inspectionStatus"</span>: "REG"</p>
<p>,<span>"createdAt"</span>: "2025-06-30 10:30:00"</p>
<p>,<span>"modifiedAt"</span>: "2025-07-01 11:00:00"</p>
<p>,<span>"status"</span>: "A"</p>
<p>,<span>"block"</span>: false</p>
<p>,<span>"dormant"</span>: false</p>
<!-- templateItemHighlight -->
<p>,<span>"templateItemHighlight"</span>: {</p>
<div class="indent_t2">
<p><span>"title"</span>: "하이라이트 제목"</p>
<p>,<span>"description"</span>: "하이라이트 설명"</p>
<p>,<span>"imageUrl"</span>: "https://cdn.example.com/thumb.jpg"</p>
</div>
<p>}</p>
<!-- templateItem -->
<p>,<span>"templateItem"</span>: {</p>
<div class="indent_t2">
<p><span>"list"</span>: [</p>
<div class="indent_t3">
<p>&#65371;</p>
<p><span>"title"</span>: "아이템 제목"</p>
<p>,<span>"description"</span>: "아이템 설명"</p>
<p>&#65373;</p>
</div>
<p>],</p>
<p><span>"summary"</span>: {</p>
<div class="indent_t3">
<p><span>"title"</span>: "요약 제목"</p>
<p>,<span>"description"</span>: "요약 설명"</p>
</div>
<p>}</p>
</div>
<p>}</p>
<!-- buttons -->
<p>,<span>"buttons"</span>: [</p>
<div class="indent_t2">
<p>&#65371;</p>
<p><span>"name"</span>: "버튼명"</p>
<p>,<span>"linkType"</span>: "WL"</p>
<p>,<span>"linkAnd"</span>: "https://aos.example.com"</p>
<p>,<span>"linkIos"</span>: "https://ios.example.com"</p>
<p>,<span>"linkMo"</span>: "https://m.example.com"</p>
<p>,<span>"linkPc"</span>: "https://www.example.com"</p>
<p>,<span>"pluginId"</span>: "plugin123"</p>
<p>&#65373;</p>
</div>
<p>]</p>
<!-- quickReplies -->
<p>,<span>"quickReplies"</span>: [</p>
<div class="indent_t2">
<p>&#65371;</p>
<p><span>"name"</span>: "빠른응답"</p>
<p>,<span>"linkType"</span>: "WL"</p>
<p>,<span>"linkAnd"</span>: "https://aos.quick.com"</p>
<p>,<span>"linkIos"</span>: "https://ios.quick.com"</p>
<p>,<span>"linkMo"</span>: "https://m.quick.com"</p>
<p>,<span>"linkPc"</span>: "https://www.quick.com"</p>
<p>&#65373;</p>
</div>
<p>]</p>
<!-- comments -->
<p>,<span>"comments"</span>: [</p>
<div class="indent_t2">
<p>&#65371;</p>
<p><span>"content"</span>: "댓글 예시입니다."</p>
<p>,<span>"createdAt"</span>: "2025-07-01 10:00:00"</p>
<p>,<span>"status"</span>: "REQ"</p>
<p>,<span>"userName"</span>: "관리자"</p>
<p>,<span>"attachment"</span>: [</p>
<div class="indent_t3">
<p>&#65371;</p>
<p><span>"originalFileName"</span>: "example.pdf"</p>
<p>,<span>"filePath"</span>: "/download/example.pdf"</p>
<p>&#65373;</p>
</div>
<p>]</p>
<p>&#65373;</p>
</div>
<p>]</p>
</div>
<p class="l_code_t2">&#65373;</p>
<p>&#65341;</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"resultCode"</span>:"4099"</p>
<p>,<span>"data"</span>:"기타 시스템 오류"</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<!--// Response-->
</div>

693
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab4.jsp
View File

@ -1,353 +1,342 @@
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<ul class="info">
<li>- 전송결과 조회의 "msgGroupId"를 사용하여 전송된 문자의 상세결과를 수신번호별로 조회할 수 있습니다.</li>
<li>- 전송결과가 "대기"인 경우에는 최종 결과 확인까지 최대 72시간까지 소요됩니다.</li>
</ul>
<div class="re_cont">
<!--Request--> <ul class="info">
<div class="req_title">Request</div> <li>- API를 통해서 메시지 그룹 ID 기준의 상세 이력(개별 건) 목록을 조회할 수 있습니다.</li>
<div class="box"> </ul>
<div class="text"> <div class="re_cont">
<h4>Request</h4> <!-- Request -->
<table> <div class="req_title">Request</div>
<caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption> <div class="box">
<colgroup> <div class="text">
<col style="width:20%;"> <h4>Request</h4>
<col style="width:80%;"> <table>
</colgroup> <caption>API Request Http Method, 프로토콜, HOST, Service Port, Endpoint 정보 테이블</caption>
<tr> <colgroup>
<th>Http Method</th> <col style="width:20%;">
<td>POST</td> <col style="width:80%;">
</tr> </colgroup>
<tr> <tr>
<th>프로토콜</th> <th>Http Method</th>
<td>HTTP/1.1</td> <td>POST</td>
</tr> </tr>
<tr> <tr>
<th>HOST</th> <th>프로토콜</th>
<td>api.munjaon.co.kr</td> <td>HTTPS/1.1</td>
</tr> </tr>
<tr> <tr>
<th>Service Port</th> <th>HOST</th>
<td>443</td> <td>api.munjaon.co.kr</td>
</tr> </tr>
</table> <tr>
</div> <th>Service Port</th>
</div> <td>443</td>
<div class="type_table"> </tr>
<table> <tr>
<caption>상세결과 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption> <th>Endpoint</th>
<colgroup> <td>/api/inqry/hstryDetail</td>
<col style="width:20%;"> </tr>
<col style="width:45%;"> </table>
<col style="width:25%"> </div>
<col style="width:10%"> </div>
</colgroup>
<thead> <div class="type_table">
<tr> <table>
<th>키</th> <caption>히스토리 상세 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption>
<th>설명</th> <colgroup>
<th>타입</th> <col style="width:20%;">
<th>필수</th> <col style="width:45%;">
</tr> <col style="width:25%">
</thead> <col style="width:10%">
<tbody> </colgroup>
<tr> <thead>
<td><span class="font_b">mberId</span></td> <tr>
<td>사용자 ID</td> <th>키</th>
<td>String</td> <th>설명</th>
<td><span class="select_o">O</span></td> <th>타입</th>
</tr> <th>필수</th>
<tr> </tr>
<td><span class="font_b">accessKey</span></td> </thead>
<td>인증용 API Key</td> <tbody>
<td>String</td> <tr>
<td><span class="select_o">O</span></td> <td><span class="font_b">mberId</span></td>
</tr> <td>사용자 ID</td>
<tr> <td>String</td>
<td><span class="font_b">msgGroupId</span></td> <td><span class="select_o">O</span></td>
<td>메시지 그룹 ID</td> </tr>
<td>String</td> <tr>
<td><span class="select_o">O</span></td> <td><span class="font_b">accessKey</span></td>
</tr> <td>인증용 API Key</td>
<tr> <td>String</td>
<td><span class="font_b">page</span></td> <td><span class="select_o">O</span></td>
<td>페이지 번호</td> </tr>
<td>String</td> <tr>
<td><span class="select_x">X</span></td> <td><span class="font_b">msgGroupId</span></td>
</tr> <td>메시지 그룹 ID</td>
<tr> <td>String</td>
<td><span class="font_b">pageSize</span></td> <td><span class="select_o">O</span></td>
<td>페이지당 출력 개수</td> </tr>
<td>String</td> </tbody>
<td><span class="select_x">X</span></td> </table>
</tr> <div class="table_info">
<tr> <p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p>
<td><span class="font_b">test_yn</span></td> <p>※ Content-Type: application/json</p>
<td>테스트 데이터 여부</td> </div>
<td>String</td> </div>
<td><span class="select_x">X</span></td>
</tr> <div class="box">
</tbody> <div class="title">[Example]</div>
</table> <div class="code_view">
<div class="table_info"> <pre>
<p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p> <code class="language-json">
</div> {
</div>
<div class="box"> "mberId": "홍길동",
<div class="title">[Example]</div>
<div class="code_view"> "accessKey": "XXXXXXXXXXXXXX414050694b953",
<p>&#65371;</p>
<div class="indent"> "msgGroupId": "MSGGID_XXXXXXX0000063"
<p><span>"mberId"</span>:"홍길동"</p> }
<p>,<span>"accessKey"</span>:"XXXXXXXXXXXXXX414050694b953"</p> </code>
<p>,<span>"msgGroupId"</span>:"MSGGID_0000000011452"</p> </pre>
<p>,<span>"page"</span>:""</p> </div>
<p>,<span>"pageSize"</span>:""</p> </div>
<p>,<span>"test_yn"</span>:""</p> <!-- // Request -->
</div>
<p class="l_code">&#65373;</p> <!-- Response -->
</div> <div class="res_title">Response</div>
</div> <div class="type_table">
<!--// Request--> <table>
<!-- Response--> <caption>히스토리 상세 조회 API Response 키 종류 및 설명, 타입 테이블</caption>
<div class="res_title">Response</div> <colgroup>
<div class="type_table"> <col style="width:20%;">
<table> <col style="width:60%;">
<caption>상세결과 조회 API Response 키 종류 및 설명, 타입 테이블</caption> <col style="width:20%;">
<colgroup> </colgroup>
<col style="width:20%;"> <thead>
<col style="width:60%;"> <tr>
<col style="width:20%;"> <th>키</th>
</colgroup> <th>설명</th>
<thead> <th>타입</th>
<tr> </tr>
<th>키</th> </thead>
<th>설명</th> <tbody>
<th>타입</th> <tr>
</tr> <td><span class="font_b">resultCode</span></td>
</thead> <td>성공 여부("0" 이외는 실패)</td>
<tbody> <td>String</td>
<tr> </tr>
<td><span class="font_b">resultCode</span></td> <tr>
<td>성공 여부("0" 아니면 실패)</td> <td><span class="font_b">data</span></td>
<td>String</td> <td>조회 결과 객체</td>
</tr> <td>Object</td>
<tr> </tr>
<td><span class="font_b">data</span></td> <tr>
<td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td> <td><span class="font_b">[data].resultCode</span></td>
<td>Object</td> <td>내부 처리 결과(0: 성공)</td>
</tr> <td>Number | String</td>
<tr> </tr>
<td><span class="font_b">[data].message</span></td> <tr>
<td>문자</td> <td><span class="font_b">[data].objectList</span></td>
<td>String</td> <td>개별 메시지 상세 목록</td>
</tr> <td>Array&lt;Object&gt;</td>
<tr> </tr>
<td><span class="font_b">[data].next_yn</span></td> <tr>
<td>다음 페이지 여부</td> <td><span class="font_b">[data].objectList[i].msgGroupId</span></td>
<td>String</td> <td>메시지 그룹 ID</td>
</tr> <td>String</td>
<tr> </tr>
<td><span class="font_b">[data].objectList</span></td> <tr>
<td>결과값 목록</td> <td><span class="font_b">[data].objectList[i].msgId</span></td>
<td>Object List</td> <td>개별 메시지 ID</td>
</tr> <td>String</td>
<tr> </tr>
<td><span class="font_b">[data].msgGroupId</span></td> <tr>
<td>메시지 그룹 ID</td> <td><span class="font_b">[data].objectList[i].totMsgCnt</span></td>
<td>String</td> <td>총 발송 건수(그룹 기준)</td>
</tr> <td>String</td>
<tr> </tr>
<td><span class="font_b">[data].msgId</span></td> <tr>
<td>메시지 ID</td> <td><span class="font_b">[data].objectList[i].msgType</span></td>
<td>String</td> <td>메시지 타입 코드(예: 8=AT)</td>
</tr> <td>Number</td>
<tr> </tr>
<td><span class="font_b">[data].msgTypeName</span></td> <tr>
<td>문자 구분명(단문, 장문, 그림)</td> <td><span class="font_b">[data].objectList[i].msgTypeName</span></td>
<td>String</td> <td>메시지 타입명</td>
</tr> <td>String</td>
<tr> </tr>
<td><span class="font_b">[data].msgType</span></td> <tr>
<td>메시지 타입(4 : 단문, 6 : 장문)</td> <td><span class="font_b">[data].objectList[i].msgResult</span></td>
<td>String</td> <td>결과(F: 실패, S: 성공 등)</td>
</tr> <td>String</td>
<tr> </tr>
<td><span class="font_b">[data].callFrom</span></td> <tr>
<td>발신자 번호</td> <td><span class="font_b">[data].objectList[i].msgGroupCnt</span></td>
<td>String</td> <td>발송 건수</td>
</tr> <td>Number</td>
<tr> </tr>
<td><span class="font_b">[data].callTo</span></td> <tr>
<td>수신자 번호</td> <td><span class="font_b">[data].objectList[i].smsTxt</span></td>
<td>String</td> <td>메시지 내용</td>
</tr> <td>String</td>
<tr> </tr>
<td><span class="font_b">[data].msgGroupCnt</span></td> <tr>
<td>문자 발송 건수</td> <td><span class="font_b">[data].objectList[i].callFrom</span></td>
<td>String</td> <td>발신 번호</td>
</tr> <td>String</td>
<tr> </tr>
<td><span class="font_b">[data].sCnt</span></td> <tr>
<td>성공 건수</td> <td><span class="font_b">[data].objectList[i].callTo</span></td>
<td>String</td> <td>수신 번호</td>
</tr> <td>String</td>
<tr> </tr>
<td><span class="font_b">[data].fCnt</span></td> <tr>
<td>실패 건수</td> <td><span class="font_b">[data].objectList[i].curState</span></td>
<td>String</td> <td>현재 상태 코드</td>
</tr> <td>Number</td>
<tr> </tr>
<td><span class="font_b">[data].wCnt</span></td> <tr>
<td>대기 건수</td> <td><span class="font_b">[data].objectList[i].remainMsgCnt</span></td>
<td>String</td> <td>잔여 처리 건수</td>
</tr> <td>Number</td>
<tr> </tr>
<td><span class="font_b">[data].msgResult</span></td> <tr>
<td>발송 결과(성공 : S, 실패 : F)</td> <td><span class="font_b">[data].objectList[i].reqdate</span></td>
<td>String</td> <td>요청 일시(YYYY-MM-DD HH:mm:ss)</td>
</tr> <td>String</td>
<tr> </tr>
<td><span class="font_b">[data].smsTxt</span></td> <tr>
<td>문자 내용</td> <td><span class="font_b">[data].objectList[i].regdate</span></td>
<td>String</td> <td>등록 일시(YYYY-MM-DD HH:mm:ss)</td>
</tr> <td>String</td>
<tr> </tr>
<td><span class="font_b">[data].subject</span></td> <tr>
<td>제목</td> <td><span class="font_b">[data].objectList[i].reserveCYn</span></td>
<td>String</td> <td>예약 취소 여부(Y/N)</td>
</tr> <td>String</td>
<tr> </tr>
<td><span class="font_b">[data].reqdate</span></td> <tr>
<td>발송 일자</td> <td><span class="font_b">localDateTime</span></td>
<td>String</td> <td>서버 처리 일시(ISO-8601)</td>
</tr> <td>String</td>
<tr> </tr>
<td><span class="font_b">[data].curState</span></td> </tbody>
<td>전송 처리 결과값</td> </table>
<td>String</td> <div class="table_info">
</tr> <p>※ JSON 객체로 응답합니다.</p>
<tr> </div>
<td><span class="font_b">[data].userId</span></td> </div>
<td>사용자 ID</td>
<td>String</td> <div class="box">
</tr> <div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div>
<tr> <div class="code_view">
<td><span class="font_b">[data].regdate</span></td> <pre>
<td>등록 일자</td> <code class="language-json">
<td>String</td> {
</tr> "resultCode": "0",
<tr>
<td><span class="font_b">[data].reserveCYn</span></td> "data": {
<td>예약 취소 여부</td>
<td>String</td> "resultCode": 0,
</tr>
<tr> "objectList": [
<td><span class="font_b">[data].ttlCnt</span></td>
<td>전체 요청 수</td> {
<td>String</td>
</tr> "msgGroupId": "MSGGID_XXXXXXX0000063",
<tr>
<td><span class="font_b">[data].remainMsgCnt</span></td> "msgId": "MSGCID_XXXXXXX00001180",
<td>남은 문자 건수</td>
<td>String</td> "totMsgCnt": "9",
</tr>
<tr> "msgType": 8,
<td><span class="font_b">[data].totMsgCnt</span></td>
<td>전체 문자 개수</td> "msgTypeName": "알림톡(AT)",
<td>String</td>
</tr> "msgResult": "F",
</tbody>
</table> "msgGroupCnt": 1,
<div class="table_info">
<p>※ JSON 객체로 응답합니다.</p> "smsTxt": "test",
</div>
</div> "callFrom": "01093414986",
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div> "callTo": "01059941669",
<div class="code_view">
<p>&#65371;</p> "curState": 3,
<div class="indent">
<p><span>"resultCode"</span>:"0"</p> "remainMsgCnt": 0,
<p>,<span>"data"</span>:&#65339;</p>
<p>&#65371;</p> "reqdate": "2025-09-05 11:45:45",
<div class="indent_t1">
<p><span>"resultCode"</span>:"0"</p> "regdate": "2025-09-05 11:45:45",
<p>,<span>"message"</span>: null</p>
<p>,<span>"next_yn"</span>:"n"</p> "reserveCYn": "N"
<p>,<span>"msgGroupId"</span>:"MSGGID_0000000000000"</p>
<p>,<span>"objectList"</span>:&#65339;</p> },
<p>&#65371;</p>
<div class="indent_t2"> {
<p><span>"msgTypeName"</span>:"단문(SMS)"</p>
<p>,<span>"msgType"</span>:"4"</p> "msgGroupId": "MSGGID_XXXXXXX0000063",
<p>,<span>"callFrom"</span>:"01011112222"</p>
<p>,<span>"callTo"</span>:"01011112223"</p> "msgId": "MSGCID_XXXXXXX000001175",
<p>,<span>"msgGroupCnt"</span>:"2"</p>
<p>,<span>"msgGroupId"</span>:"MSGGID_0000000013340"</p> "totMsgCnt": "9",
<p>,<span>"msgId"</span>:"MSGID_0000000000001"</p>
<p>,<span>"scnt"</span>:null</p> "msgType": 9,
<p>,<span>"fcnt"</span>:null</p>
<p>,<span>"wcnt"</span>:null</p> "msgTypeName": "친구톡(AT)",
<p>,<span>"msgResult"</span>:"S"</p>
<p>,<span>"smsTxt"</span>:"문자 내용 단문 예제"</p> "msgResult": "F",
<p>,<span>"subject"</span>:null</p>
<p>,<span>"reqdate"</span>:"2023-06-13 17:48:08"</p> "msgGroupCnt": 1,
<p>,<span>"curState"</span>:"3"</p>
<p>,<span>"userId"</span>:"testuser"</p> "smsTxt": "test",
<p>,<span>"regdate"</span>:"2023-06-13 17:48:07"</p>
<p>,<span>"reserveCYn"</span>:"N"</p> "callFrom": "01093414986",
<p>,<span>"ttlCnt"</span>:"10"</p>
<p>,<span>"remainMsgCnt"</span>:"0"</p> "callTo": "01098969885",
<p>,<span>"totMsgCnt"</span>:"10"</p>
</div> "curState": 3,
<p>&#65373;</p>
<p>,&#65371;</p> "remainMsgCnt": 0,
<div class="indent_t2">
<p><span>"msgTypeName"</span>:"단문(SMS)"</p> "reqdate": "2025-09-05 11:45:45",
<p>,<span>"msgType"</span>:"4"</p>
<p>,<span>"callFrom"</span>:"01011112222"</p> "regdate": "2025-09-05 11:45:45",
<p>,<span>"callTo"</span>:"01011112223"</p>
<p>,<span>"msgGroupCnt"</span>:"2"</p> "reserveCYn": "N"
<p>,<span>"msgGroupId"</span>:"MSGGID_0000000013340"</p>
<p>,<span>"msgId"</span>:"MSGID_0000000000002"</p> },
<p>,<span>"scnt"</span>:null</p>
<p>,<span>"fcnt"</span>:null</p> ]
<p>,<span>"wcnt"</span>:null</p>
<p>,<span>"msgResult"</span>:"S"</p> },
<p>,<span>"smsTxt"</span>:"문자 내용 단문 예제"</p>
<p>,<span>subject"</span>:null</p> "localDateTime": "2025-09-16T10:47:20.4014362"
<p>,<span>reqdate"</span>:"2023-06-13 17:48:09"</p>
<p>,<span>"curState"</span>:"3"</p> }
<p>,<span>"userId"</span>:"testuser"</p> </code>
<p>,<span>"regdate"</span>:"2023-06-13 17:48:07"</p> </pre>
<p>,<span>"reserveCYn"</span>:"N"</p> </div>
<p>,<span>"ttlCnt"</span>:"10"</p> </div>
<p>,<span>"remainMsgCnt"</span>:"0"</p>
<p>,<span>"totMsgCnt"</span>:"10"</p> <div class="box">
<p>&#65373;</p> <div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div>
</div> <div class="code_view">
<p>&#65341;</p> <pre><code class="language-json">
</div> {
<p class="l_code_t2">&#65373;</p>
<p>&#65341;</p> "resultCode": "4099",
</div>
<p class="l_code">&#65373;</p> "data": "기타 시스템 오류"
</div>
</div> }
<div class="box"> </code></pre>
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div> </div>
<div class="code_view"> </div>
<p>&#65371;</p> <!-- // Response -->
<div class="indent"> </div>
<p><span>"resultCode"</span>:"4099"</p> <!--// Response-->
<p>,<span>"data"</span>:"기타 시스템 오류"</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<!--// Response-->
</div>

496
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab5.jsp
View File

@ -1,195 +1,303 @@
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<ul class="info">
<li>- 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.</li>
<li>- 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.</li>
</ul>
<div class="re_cont">
<!--Request--> <ul class="info">
<div class="req_title">Request</div> <li>- 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS), 알림톡(AT), 친구톡(FT)별로 각각 확인할 수 있습니다.</li>
<div class="box"> <!-- <li>- 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫 결제 이벤트"는 적용되지 않습니다.</li> -->
<div class="text"> </ul>
<h4>Request</h4>
<table> <div class="re_cont">
<caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption> <!-- Request -->
<colgroup> <div class="req_title">Request</div>
<col style="width:20%;"> <div class="box">
<col style="width:80%;"> <div class="text">
</colgroup> <h4>Request</h4>
<tr> <table>
<th>Http Method</th> <caption>API Request Http Method, 프로토콜, HOST, Service Port, Endpoint 정보 테이블</caption>
<td>POST</td> <colgroup>
</tr> <col style="width:20%;">
<tr> <col style="width:80%;">
<th>프로토콜</th> </colgroup>
<td>HTTP/1.1</td> <tr>
</tr> <th>Http Method</th>
<tr> <td>POST</td>
<th>HOST</th> </tr>
<td>api.munjaon.co.kr</td> <tr>
</tr> <th>프로토콜</th>
<tr> <td>HTTPS/1.1</td>
<th>Service Port</th> </tr>
<td>443</td> <tr>
</tr> <th>HOST</th>
</table> <td>api.munjaon.co.kr</td>
</div> </tr>
</div> <tr>
<div class="type_table"> <th>Service Port</th>
<table> <td>443</td>
<caption>발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption> </tr>
<colgroup> <tr>
<col style="width:20%;"> <th>Endpoint</th>
<col style="width:45%;"> <td>/api/inqry/price</td>
<col style="width:25%"> </tr>
<col style="width:10%"> </table>
</colgroup> </div>
<thead> </div>
<tr>
<th>키</th> <div class="type_table">
<th>설명</th> <table>
<th>타입</th> <caption>가격/가능건수 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption>
<th>필수</th> <colgroup>
</tr> <col style="width:20%;">
</thead> <col style="width:45%;">
<tbody> <col style="width:25%">
<tr> <col style="width:10%">
<td><span class="font_b">mberId</span></td> </colgroup>
<td>사용자 ID</td> <thead>
<td>String</td> <tr>
<td><span class="select_o">O</span></td> <th>키</th>
</tr> <th>설명</th>
<tr> <th>타입</th>
<td><span class="font_b">accessKey</span></td> <th>필수</th>
<td>인증용 API Key</td> </tr>
<td>String</td> </thead>
<td><span class="select_o">O</span></td> <tbody>
</tr> <tr>
</tbody> <td><span class="font_b">mberId</span></td>
</table> <td>사용자 ID</td>
<div class="table_info"> <td>String</td>
<p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p> <td><span class="select_o">O</span></td>
</div> </tr>
</div> <tr>
<div class="box"> <td><span class="font_b">accessKey</span></td>
<div class="title">[Example]</div> <td>인증용 API Key</td>
<div class="code_view"> <td>String</td>
<p>&#65371;</p> <td><span class="select_o">O</span></td>
<div class="indent"> </tr>
<p><span>"mberId"</span>:"String"</p> </tbody>
<p>,<span>"accessKey"</span>:"String"</p> </table>
</div> <div class="table_info">
<p class="l_code">&#65373;</p> <p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p>
</div> <p>※ Content-Type: application/json</p>
</div> </div>
<!--// Request--> </div>
<!-- Response-->
<div class="res_title">Response</div> <div class="box">
<div class="type_table"> <div class="title">[Example]</div>
<table> <div class="code_view">
<caption>발송가능 건수 API Response 키 종류 및 설명, 타입 테이블</caption> <pre>
<colgroup> <code class="language-json">
<col style="width:20%;"> {
<col style="width:60%;">
<col style="width:20%;"> "mberId": "홍길동",
</colgroup>
<thead> "accessKey": "XXXXXXXXXXXXXX414050694b953"
<tr> }
<th>키</th> </code>
<th>설명</th> </pre>
<th>타입</th> </div>
</tr> </div>
</thead> <!-- // Request -->
<tbody>
<tr> <!-- Response -->
<td><span class="font_b">resultCode</span></td> <div class="res_title">Response</div>
<td>성공 여부("0" 아니면 실패)</td> <div class="type_table">
<td>String</td> <table>
</tr> <caption>가격/가능건수 조회 API Response 키 종류 및 설명, 타입 테이블</caption>
<tr> <colgroup>
<td><span class="font_b">data</span></td> <col style="width:20%;">
<td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td> <col style="width:60%;">
<td>Object</td> <col style="width:20%;">
</tr> </colgroup>
<tr> <thead>
<td><span class="font_b">[data].longPrice</span></td> <tr>
<td>장문 단가</td> <th>키</th>
<td>String</td> <th>설명</th>
</tr> <th>타입</th>
<tr> </tr>
<td><span class="font_b">[data].longSendPsbltEa</span></td> </thead>
<td>장문 발송 가능 건수</td> <tbody>
<td>String</td> <tr>
</tr> <td><span class="font_b">resultCode</span></td>
<tr> <td>성공 여부("0" 이외는 실패)</td>
<td><span class="font_b">[data].mberMoney</span></td> <td>String</td>
<td>현재 보유 금액</td> </tr>
<td>String</td> <tr>
</tr> <td><span class="font_b">data</span></td>
<tr> <td>조회 결과 객체(성공 시 가격/가능건수 정보)</td>
<td><span class="font_b">[data].message</span></td> <td>Object | String</td>
<td>문자</td> </tr>
<td>String</td> <tr>
</tr> <td><span class="font_b">[data].resultCode</span></td>
<tr> <td>내부 처리 결과("0": 성공)</td>
<td><span class="font_b">[data].picturePrice</span></td> <td>String</td>
<td>그림문자 단가</td> </tr>
<td>String</td> <tr>
</tr> <td><span class="font_b">[data].message</span></td>
<tr> <td>메시지(필요 시)</td>
<td><span class="font_b">[data].pictureSendPsbltEa</span></td> <td>String</td>
<td>그림문자 발송 가능 건수</td> </tr>
<td>String</td> <tr>
</tr> <td><span class="font_b">[data].localDateTime</span></td>
<tr> <td>서버 처리 일시(ISO-8601)</td>
<td><span class="font_b">[data].shortPrice</span></td> <td>String</td>
<td>단문 단가</td> </tr>
<td>String</td> <tr>
</tr> <td><span class="font_b">[data].shortPrice</span></td>
<tr> <td>단문(SMS) 단가</td>
<td><span class="font_b">[data].shortSendPsbltEa</span></td> <td>Number</td>
<td>단문 발송 가능 건수</td> </tr>
<td>String</td> <tr>
</tr> <td><span class="font_b">[data].longPrice</span></td>
</tbody> <td>장문(LMS) 단가</td>
</table> <td>Number</td>
<div class="table_info"> </tr>
<p>※ JSON 객체로 응답합니다.</p> <tr>
</div> <td><span class="font_b">[data].picturePrice</span></td>
</div> <td>사진(MMS) 단가</td>
<div class="box"> <td>Number</td>
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div> </tr>
<div class="code_view"> <tr>
<p>&#65371;</p> <td><span class="font_b">[data].kakaoAtPrice</span></td>
<div class="indent"> <td>카카오 알림톡 단가</td>
<p><span>"resultCode"</span>:"0"</p> <td>Number</td>
<p>,<span>"data"</span>&#65371;</p> </tr>
<div class="indent_t1"> <tr>
<p><span>"longPrice"</span>:"50"</p> <td><span class="font_b">[data].kakaoFtPrice</span></td>
<p>,<span>"longSendPsbltEa"</span>:"19651"</p> <td>카카오 친구톡(텍스트) 단가</td>
<p>,<span>"mberMoney"</span>:"982586.7"</p> <td>Number</td>
<p>,<span>"message"</span>:null</p> </tr>
<p>,<span>"picturePrice"</span>:"90"</p> <tr>
<p>,<span>"pictureSendPsbltEa"</span>:"10917"</p> <td><span class="font_b">[data].kakaoFtImgPrice</span></td>
<p>,<span>"shortPrice"</span>:"18"</p> <td>카카오 친구톡(이미지) 단가</td>
<p>,<span>"shortSendPsbltEa"</span>:"54588"</p> <td>Number</td>
</div> </tr>
<p>&#65373;</p> <tr>
</div> <td><span class="font_b">[data].kakaoFtWideImgPrice</span></td>
<p class="l_code">&#65373;</p> <td>카카오 친구톡(와이드 이미지) 단가</td>
</div> <td>Number</td>
</div> </tr>
<div class="box"> <tr>
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div> <td><span class="font_b">[data].mberMoney</span></td>
<div class="code_view"> <td>회원 보유 금액</td>
<p>&#65371;</p> <td>Number</td>
<div class="indent"> </tr>
<p><span>"resultCode"</span>:"5099"</p> <tr>
<p>,<span>"data"</span>:"기타 시스템 오류"</p> <td><span class="font_b">[data].shortSendPsbltEa</span></td>
</div> <td>단문 발송 가능 건수</td>
<p class="l_code">&#65373;</p> <td>Number</td>
</div> </tr>
</div> <tr>
<!--// Response--> <td><span class="font_b">[data].longSendPsbltEa</span></td>
</div> <td>장문 발송 가능 건수</td>
<td>Number</td>
</tr>
<tr>
<td><span class="font_b">[data].pictureSendPsbltEa</span></td>
<td>사진 발송 가능 건수</td>
<td>Number</td>
</tr>
<tr>
<td><span class="font_b">[data].kakaoAtSendPsbltEa</span></td>
<td>알림톡 발송 가능 건수</td>
<td>Number</td>
</tr>
<tr>
<td><span class="font_b">[data].kakaoFtSendPsbltEa</span></td>
<td>친구톡(텍스트) 발송 가능 건수</td>
<td>Number</td>
</tr>
<tr>
<td><span class="font_b">[data].kakaoFtImgSendPsbltEa</span></td>
<td>친구톡(이미지) 발송 가능 건수</td>
<td>Number</td>
</tr>
<tr>
<td><span class="font_b">[data].kakaoFtWideImgSendPsbltEa</span></td>
<td>친구톡(와이드 이미지) 발송 가능 건수</td>
<td>Number</td>
</tr>
<tr>
<td><span class="font_b">localDateTime</span></td>
<td>서버 처리 일시(ISO-8601)</td>
<td>String</td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ JSON 객체로 응답합니다.</p>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div>
<div class="code_view">
<pre>
<code class="language-json">
{
"resultCode": "0",
"data": {
"resultCode": "0",
"message": "",
"localDateTime": "2025-09-16T11:06:40.2556646",
"shortPrice": 18.0,
"longPrice": 50.0,
"picturePrice": 90.0,
"kakaoAtPrice": 6.9,
"kakaoFtPrice": 13.8,
"kakaoFtImgPrice": 19.9,
"kakaoFtWideImgPrice": 22.9,
"mberMoney": 6549661.26,
"shortSendPsbltEa": 363870,
"longSendPsbltEa": 130993,
"pictureSendPsbltEa": 72774,
"kakaoAtSendPsbltEa": 949226,
"kakaoFtSendPsbltEa": 474613,
"kakaoFtImgSendPsbltEa": 329128,
"kakaoFtWideImgSendPsbltEa": 286011
},
"localDateTime": "2025-09-16T11:06:40.2556646"
}
</code>
</pre>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div>
<div class="code_view">
<pre><code class="language-json">
{
"resultCode": "3099",
"data": "기타 시스템 오류"
}
</code></pre>
</div>
</div>
<!-- // Response -->
</div>
<!--// Response-->

195
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab6.jsp
View File

@ -1,195 +0,0 @@
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<ul class="info">
<li>- 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.</li>
<li>- 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.</li>
</ul>
<div class="re_cont">
<!--Request-->
<div class="req_title">Request</div>
<div class="box">
<div class="text">
<h4>Request</h4>
<table>
<caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:80%;">
</colgroup>
<tr>
<th>Http Method</th>
<td>POST</td>
</tr>
<tr>
<th>프로토콜</th>
<td>HTTP/1.1</td>
</tr>
<tr>
<th>HOST</th>
<td>api.munjaon.co.kr</td>
</tr>
<tr>
<th>Service Port</th>
<td>443</td>
</tr>
</table>
</div>
</div>
<div class="type_table">
<table>
<caption>발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:45%;">
<col style="width:25%">
<col style="width:10%">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
<th>필수</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">mberId</span></td>
<td>사용자 ID</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">accessKey</span></td>
<td>인증용 API Key</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p>
</div>
</div>
<div class="box">
<div class="title">[Example]</div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"mberId"</span>:"String"</p>
<p>,<span>"accessKey"</span>:"String"</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<!--// Request-->
<!-- Response-->
<div class="res_title">Response</div>
<div class="type_table">
<table>
<caption>발송가능 건수 API Response 키 종류 및 설명, 타입 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:60%;">
<col style="width:20%;">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">resultCode</span></td>
<td>성공 여부("0" 아니면 실패)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">data</span></td>
<td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td>
<td>Object</td>
</tr>
<tr>
<td><span class="font_b">[data].longPrice</span></td>
<td>장문 단가</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].longSendPsbltEa</span></td>
<td>장문 발송 가능 건수</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].mberMoney</span></td>
<td>현재 보유 금액</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].message</span></td>
<td>문자</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].picturePrice</span></td>
<td>그림문자 단가</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].pictureSendPsbltEa</span></td>
<td>그림문자 발송 가능 건수</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].shortPrice</span></td>
<td>단문 단가</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].shortSendPsbltEa</span></td>
<td>단문 발송 가능 건수</td>
<td>String</td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ JSON 객체로 응답합니다.</p>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"resultCode"</span>:"0"</p>
<p>,<span>"data"</span>&#65371;</p>
<div class="indent_t1">
<p><span>"longPrice"</span>:"50"</p>
<p>,<span>"longSendPsbltEa"</span>:"19651"</p>
<p>,<span>"mberMoney"</span>:"982586.7"</p>
<p>,<span>"message"</span>:null</p>
<p>,<span>"picturePrice"</span>:"90"</p>
<p>,<span>"pictureSendPsbltEa"</span>:"10917"</p>
<p>,<span>"shortPrice"</span>:"18"</p>
<p>,<span>"shortSendPsbltEa"</span>:"54588"</p>
</div>
<p>&#65373;</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"resultCode"</span>:"5099"</p>
<p>,<span>"data"</span>:"기타 시스템 오류"</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<!--// Response-->
</div>

195
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab7.jsp
View File

@ -1,195 +0,0 @@
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<ul class="info">
<li>- 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.</li>
<li>- 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.</li>
</ul>
<div class="re_cont">
<!--Request-->
<div class="req_title">Request</div>
<div class="box">
<div class="text">
<h4>Request</h4>
<table>
<caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:80%;">
</colgroup>
<tr>
<th>Http Method</th>
<td>POST</td>
</tr>
<tr>
<th>프로토콜</th>
<td>HTTP/1.1</td>
</tr>
<tr>
<th>HOST</th>
<td>api.munjaon.co.kr</td>
</tr>
<tr>
<th>Service Port</th>
<td>443</td>
</tr>
</table>
</div>
</div>
<div class="type_table">
<table>
<caption>발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:45%;">
<col style="width:25%">
<col style="width:10%">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
<th>필수</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">mberId</span></td>
<td>사용자 ID</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">accessKey</span></td>
<td>인증용 API Key</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p>
</div>
</div>
<div class="box">
<div class="title">[Example]</div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"mberId"</span>:"String"</p>
<p>,<span>"accessKey"</span>:"String"</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<!--// Request-->
<!-- Response-->
<div class="res_title">Response</div>
<div class="type_table">
<table>
<caption>발송가능 건수 API Response 키 종류 및 설명, 타입 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:60%;">
<col style="width:20%;">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">resultCode</span></td>
<td>성공 여부("0" 아니면 실패)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">data</span></td>
<td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td>
<td>Object</td>
</tr>
<tr>
<td><span class="font_b">[data].longPrice</span></td>
<td>장문 단가</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].longSendPsbltEa</span></td>
<td>장문 발송 가능 건수</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].mberMoney</span></td>
<td>현재 보유 금액</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].message</span></td>
<td>문자</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].picturePrice</span></td>
<td>그림문자 단가</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].pictureSendPsbltEa</span></td>
<td>그림문자 발송 가능 건수</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].shortPrice</span></td>
<td>단문 단가</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].shortSendPsbltEa</span></td>
<td>단문 발송 가능 건수</td>
<td>String</td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ JSON 객체로 응답합니다.</p>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"resultCode"</span>:"0"</p>
<p>,<span>"data"</span>&#65371;</p>
<div class="indent_t1">
<p><span>"longPrice"</span>:"50"</p>
<p>,<span>"longSendPsbltEa"</span>:"19651"</p>
<p>,<span>"mberMoney"</span>:"982586.7"</p>
<p>,<span>"message"</span>:null</p>
<p>,<span>"picturePrice"</span>:"90"</p>
<p>,<span>"pictureSendPsbltEa"</span>:"10917"</p>
<p>,<span>"shortPrice"</span>:"18"</p>
<p>,<span>"shortSendPsbltEa"</span>:"54588"</p>
</div>
<p>&#65373;</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"resultCode"</span>:"5099"</p>
<p>,<span>"data"</span>:"기타 시스템 오류"</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<!--// Response-->
</div>

195
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab8.jsp
View File

@ -1,195 +0,0 @@
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<ul class="info">
<li>- 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.</li>
<li>- 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.</li>
</ul>
<div class="re_cont">
<!--Request-->
<div class="req_title">Request</div>
<div class="box">
<div class="text">
<h4>Request</h4>
<table>
<caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:80%;">
</colgroup>
<tr>
<th>Http Method</th>
<td>POST</td>
</tr>
<tr>
<th>프로토콜</th>
<td>HTTP/1.1</td>
</tr>
<tr>
<th>HOST</th>
<td>api.munjaon.co.kr</td>
</tr>
<tr>
<th>Service Port</th>
<td>443</td>
</tr>
</table>
</div>
</div>
<div class="type_table">
<table>
<caption>발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:45%;">
<col style="width:25%">
<col style="width:10%">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
<th>필수</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">mberId</span></td>
<td>사용자 ID</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
<tr>
<td><span class="font_b">accessKey</span></td>
<td>인증용 API Key</td>
<td>String</td>
<td><span class="select_o">O</span></td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p>
</div>
</div>
<div class="box">
<div class="title">[Example]</div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"mberId"</span>:"String"</p>
<p>,<span>"accessKey"</span>:"String"</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<!--// Request-->
<!-- Response-->
<div class="res_title">Response</div>
<div class="type_table">
<table>
<caption>발송가능 건수 API Response 키 종류 및 설명, 타입 테이블</caption>
<colgroup>
<col style="width:20%;">
<col style="width:60%;">
<col style="width:20%;">
</colgroup>
<thead>
<tr>
<th>키</th>
<th>설명</th>
<th>타입</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="font_b">resultCode</span></td>
<td>성공 여부("0" 아니면 실패)</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">data</span></td>
<td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td>
<td>Object</td>
</tr>
<tr>
<td><span class="font_b">[data].longPrice</span></td>
<td>장문 단가</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].longSendPsbltEa</span></td>
<td>장문 발송 가능 건수</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].mberMoney</span></td>
<td>현재 보유 금액</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].message</span></td>
<td>문자</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].picturePrice</span></td>
<td>그림문자 단가</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].pictureSendPsbltEa</span></td>
<td>그림문자 발송 가능 건수</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].shortPrice</span></td>
<td>단문 단가</td>
<td>String</td>
</tr>
<tr>
<td><span class="font_b">[data].shortSendPsbltEa</span></td>
<td>단문 발송 가능 건수</td>
<td>String</td>
</tr>
</tbody>
</table>
<div class="table_info">
<p>※ JSON 객체로 응답합니다.</p>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"resultCode"</span>:"0"</p>
<p>,<span>"data"</span>&#65371;</p>
<div class="indent_t1">
<p><span>"longPrice"</span>:"50"</p>
<p>,<span>"longSendPsbltEa"</span>:"19651"</p>
<p>,<span>"mberMoney"</span>:"982586.7"</p>
<p>,<span>"message"</span>:null</p>
<p>,<span>"picturePrice"</span>:"90"</p>
<p>,<span>"pictureSendPsbltEa"</span>:"10917"</p>
<p>,<span>"shortPrice"</span>:"18"</p>
<p>,<span>"shortSendPsbltEa"</span>:"54588"</p>
</div>
<p>&#65373;</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<div class="box">
<div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div>
<div class="code_view">
<p>&#65371;</p>
<div class="indent">
<p><span>"resultCode"</span>:"5099"</p>
<p>,<span>"data"</span>:"기타 시스템 오류"</p>
</div>
<p class="l_code">&#65373;</p>
</div>
</div>
<!--// Response-->
</div>

139
src/main/webapp/publish/js/highlight/styles/arta.css
View File

@ -1,66 +1,119 @@
pre code.hljs { pre code.hljs {
display: block; display: block;
overflow-x: auto; overflow-x: auto;
padding: 1em padding: 1em
} }
code.hljs { code.hljs {
padding: 3px 5px padding: 3px 5px
} }
/* /*
Date: 17.V.2011 Date: 17.V.2011
Author: pumbur <pumbur@pumbur.net> Author: pumbur <pumbur@pumbur.net>
*/ */
.hljs { .hljs {
background: #222; background: #222;
color: #aaa color: #aaa
} }
.hljs-subst { .hljs-subst {
color: #aaa color: #aaa
} }
.hljs-section { .hljs-section {
color: #fff color: #fff
} }
.hljs-comment,
.hljs-quote, .hljs-comment, .hljs-quote, .hljs-meta {
.hljs-meta { color: #444
color: #444
} }
.hljs-string,
.hljs-symbol, .hljs-string, .hljs-symbol, .hljs-bullet, .hljs-regexp {
.hljs-bullet, color: #ffcc33
.hljs-regexp {
color: #ffcc33
} }
.hljs-number,
.hljs-addition { .hljs-number, .hljs-addition {
color: #00cc66 color: #00cc66
} }
.hljs-built_in,
.hljs-literal, .hljs-built_in, .hljs-literal, .hljs-type, .hljs-template-variable,
.hljs-type, .hljs-attribute, .hljs-link {
.hljs-template-variable, color: #32aaee
.hljs-attribute,
.hljs-link {
color: #32aaee
} }
.hljs-keyword,
.hljs-selector-tag, .hljs-keyword, .hljs-selector-tag, .hljs-name, .hljs-selector-id,
.hljs-name, .hljs-selector-class {
.hljs-selector-id, color: #6644aa
.hljs-selector-class {
color: #6644aa
} }
.hljs-title,
.hljs-variable, .hljs-title, .hljs-variable, .hljs-deletion, .hljs-template-tag {
.hljs-deletion, color: #bb1166
.hljs-template-tag {
color: #bb1166
} }
.hljs-section,
.hljs-doctag, .hljs-section, .hljs-doctag, .hljs-strong {
.hljs-strong { font-weight: bold
font-weight: bold
} }
.hljs-emphasis { .hljs-emphasis {
font-style: italic font-style: italic
}
pre code.hljs {
display: block;
overflow-x: auto;
padding: 1em
}
code.hljs {
padding: 3px 5px
}
/*
Date: 17.V.2011
Author: pumbur <pumbur@pumbur.net>
*/
.hljs {
background: #222;
color: #aaa
}
.hljs-subst {
color: #fff
}
.hljs-section {
color: #fff
}
.hljs-comment, .hljs-quote, .hljs-meta {
color: #444
}
.hljs-string, .hljs-symbol, .hljs-bullet, .hljs-regexp {
color: #ffcc33
}
.hljs-number, .hljs-addition {
color: #fff
}
.hljs-built_in, .hljs-literal, .hljs-type, .hljs-template-variable,
.hljs-attribute, .hljs-link {
color: #32aaee
}
.hljs-keyword, .hljs-selector-tag, .hljs-name, .hljs-selector-id,
.hljs-selector-class {
color: #6644aa
}
.hljs-title, .hljs-variable, .hljs-deletion, .hljs-template-tag {
color: #bb1166
}
.hljs-section, .hljs-doctag, .hljs-strong {
font-weight: bold
}
.hljs-emphasis {
font-style: italic
} }