이지우 - API 소개 페이지 작업 중
This commit is contained in:
parent
93cb46a69e
commit
add6ea80b1
@ -42,10 +42,12 @@ $(document).ready(function(){
|
|||||||
<div class="pay_tab_wrap">
|
<div class="pay_tab_wrap">
|
||||||
<ul class="tabType1">
|
<ul class="tabType1">
|
||||||
<li class="tab active"><button type="button" onclick="TabType5(this,'1');TabType2(this,'1');$('.list_tab li:nth-child(1)').addClass('active').siblings().removeClass('active');">문자</button></li>
|
<li class="tab active"><button type="button" onclick="TabType5(this,'1');TabType2(this,'1');$('.list_tab li:nth-child(1)').addClass('active').siblings().removeClass('active');">문자</button></li>
|
||||||
<li class="tab"><button type="button" onclick="TabType5(this,'2');TabType2(this,'6');$('.list_tab li:nth-child(1)').addClass('active').siblings().removeClass('active');">카카오톡</button></li>
|
<li class="tab"><button type="button" onclick="TabType5(this,'2');TabType2(this,'6');$('.list_tab li:nth-child(1)').addClass('active').siblings().removeClass('active');">알림톡</button></li>
|
||||||
|
<li class="tab"><button type="button" onclick="TabType5(this,'3');TabType2(this,'13');$('.list_tab li:nth-child(1)').addClass('active').siblings().removeClass('active');">친구톡</button></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<!-- REST API 개발 가이드 > 문자 -->
|
||||||
<div class="api_guide current" id="tab5_1">
|
<div class="api_guide current" id="tab5_1">
|
||||||
<div class="list_tab_wrap2 type3">
|
<div class="list_tab_wrap2 type3">
|
||||||
<!-- tab button -->
|
<!-- tab button -->
|
||||||
@ -85,8 +87,9 @@ $(document).ready(function(){
|
|||||||
<c:import url="./msg/apiSpec_tab5.jsp" />
|
<c:import url="./msg/apiSpec_tab5.jsp" />
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
<!-- //REST API 개발 가이드 > 문자 -->
|
||||||
|
|
||||||
|
<!-- REST API 개발 가이드 > 알림톡 -->
|
||||||
<div class="api_guide" id="tab5_2">
|
<div class="api_guide" id="tab5_2">
|
||||||
<div class="list_tab_wrap2 type3">
|
<div class="list_tab_wrap2 type3">
|
||||||
<!-- tab button -->
|
<!-- tab button -->
|
||||||
@ -95,8 +98,8 @@ $(document).ready(function(){
|
|||||||
<li class="tab active"><button type="button" onclick="TabType2(this,'6');">채널 ID 조회</button></li>
|
<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,'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,'8');">템플릿상세조회</button></li>
|
||||||
<li class="tab"><button type="button" onclick="TabType2(this,'9');">단건보내기</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,'10');">대량보내기</button></li> -->
|
||||||
<li class="tab"><button type="button" onclick="TabType2(this,'11');">전송내역조회</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,'12');">전송내역조회(상세)</button></li>
|
||||||
<li class="tab"><button type="button" onclick="TabType2(this,'13');">발송가능건수</button></li>
|
<li class="tab"><button type="button" onclick="TabType2(this,'13');">발송가능건수</button></li>
|
||||||
@ -144,6 +147,21 @@ $(document).ready(function(){
|
|||||||
<c:import url="./at/apiSpec_tab8.jsp" />
|
<c:import url="./at/apiSpec_tab8.jsp" />
|
||||||
</div>
|
</div>
|
||||||
</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 개발 가이드 > 친구톡 -->
|
||||||
</div>
|
</div>
|
||||||
</div><!--// send top -->
|
</div><!--// send top -->
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
216
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab1.jsp
Normal file
216
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab1.jsp
Normal file
@ -0,0 +1,216 @@
|
|||||||
|
<%@ page language="java" contentType="text/html; charset=UTF-8"
|
||||||
|
pageEncoding="UTF-8"%>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="info">
|
||||||
|
<li>- API를 통해서 채널 ID를 조회할 수 있습니다.</li>
|
||||||
|
<!-- <li>- 발신번호는 문자온 사이트를 통해 사전등록 후 이용하실 수 있습니다.(마이페이지-발신번호 관리 메뉴 이용)</li> -->
|
||||||
|
<!-- <li>- 문자 내용이 "90byte"를 초과하는 경우 장문(LMS)으로 자동 전환됩니다.</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>
|
||||||
|
<p>※ 문자 텍스트 용량(byte) : 한글 1자당 2byte, 영문/숫자 1자당 1byte</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="box">
|
||||||
|
<div class="title">[Example]</div>
|
||||||
|
<div class="code_view">
|
||||||
|
<p>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p>
|
||||||
|
<span>"mberId"</span>:"홍길동"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"accessKey"</span>:"XXXXXXXXXXXXXX414050694b953"
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</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<Object></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">
|
||||||
|
<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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p>
|
||||||
|
<span>"resultCode"</span>:"0"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"data"</span>{
|
||||||
|
</p>
|
||||||
|
<div class="indent_t1">
|
||||||
|
<p>
|
||||||
|
,<span>"senderKey"</span>:"6691434xxxxxxxxxxxxxxxxxxxxxxxxx"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"phoneNumber"</span>:"010xxxxxxxx"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"yellowId"</span>:"@ID"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"firstRegistPnttm"</span>:"2025-10-05 18:08:58"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"firstRegisterId"</span>:"userId"
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<p>}</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p>
|
||||||
|
<span>"resultCode"</span>:"401"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"message"</span>:"Unauthorized"
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<!--// Response-->
|
||||||
|
</div>
|
||||||
|
|
||||||
232
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab2.jsp
Normal file
232
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab2.jsp
Normal file
@ -0,0 +1,232 @@
|
|||||||
|
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
|
||||||
|
|
||||||
|
<ul class="info">
|
||||||
|
<li>- API를 통해서 다른 내용의 문자를 대량으로 전송할 수 있습니다.</li>
|
||||||
|
<li>- 발신번호는 문자온 사이트를 통해 사전등록 후 이용하실 수 있습니다.(마이페이지-발신번호 관리 메뉴 이용)</li>
|
||||||
|
<li>- 문자 내용이 "90byte"를 초과하는 경우 장문(LMS)으로 자동 전환됩니다.</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>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">senderKey</span></td>
|
||||||
|
<td>발신 프로필 Key</td>
|
||||||
|
<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>{</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">}</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">
|
||||||
|
<p>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p>
|
||||||
|
<span>"resultCode"</span>:"0"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"data"</span>{
|
||||||
|
</p>
|
||||||
|
<div class="indent_t1">
|
||||||
|
<p>
|
||||||
|
,<span>"senderKey"</span>:"669143473b1af459628xxxxxxxxxxxxxxxxxxxxx"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"templateCode"</span>:"bizp_20250527112232xxxxxxxxxxxxx"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"templateName"</span>:"템플릿 명"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"createdAt"</span>:"2025-05-27 11:22:33"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"modifiedAt"</span>:"2025-05-27 11:22:33"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"serviceStatus"</span>:"REG(등록완료)"
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<p>}</p>
|
||||||
|
<p>,{</p>
|
||||||
|
<div class="indent_t1">
|
||||||
|
<p>
|
||||||
|
,<span>"senderKey"</span>:"669143473b1af459628xxxxxxxxxxxxxxxxxxxxx"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"templateCode"</span>:"bizp_20250527112232xxxxxxxxxxxxx"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"templateName"</span>:"템플릿 명2"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"createdAt"</span>:"2025-05-27 11:22:33"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"modifiedAt"</span>:"2025-05-27 11:22:33"
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
,<span>"serviceStatus"</span>:"RDY(대기)"
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<p>}</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"resultCode"</span>:"4099"</p>
|
||||||
|
<p>,<span>"msg"</span>:"기타 시스템 오류"</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<!--// Response-->
|
||||||
|
</div>
|
||||||
331
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab3.jsp
Normal file
331
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab3.jsp
Normal file
@ -0,0 +1,331 @@
|
|||||||
|
<%@ 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>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>{</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">}</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>
|
||||||
|
</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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"resultCode"</span>:"0"</p>
|
||||||
|
<p>,<span>"data"</span>:[</p>
|
||||||
|
<p>{</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>{</p>
|
||||||
|
<p><span>"title"</span>: "아이템 제목"</p>
|
||||||
|
<p>,<span>"description"</span>: "아이템 설명"</p>
|
||||||
|
<p>}</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>{</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>}</p>
|
||||||
|
</div>
|
||||||
|
<p>]</p>
|
||||||
|
|
||||||
|
<!-- quickReplies -->
|
||||||
|
<p>,<span>"quickReplies"</span>: [</p>
|
||||||
|
<div class="indent_t2">
|
||||||
|
<p>{</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>}</p>
|
||||||
|
</div>
|
||||||
|
<p>]</p>
|
||||||
|
|
||||||
|
<!-- comments -->
|
||||||
|
<p>,<span>"comments"</span>: [</p>
|
||||||
|
<div class="indent_t2">
|
||||||
|
<p>{</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>{</p>
|
||||||
|
<p><span>"originalFileName"</span>: "example.pdf"</p>
|
||||||
|
<p>,<span>"filePath"</span>: "/download/example.pdf"</p>
|
||||||
|
<p>}</p>
|
||||||
|
</div>
|
||||||
|
<p>]</p>
|
||||||
|
<p>}</p>
|
||||||
|
</div>
|
||||||
|
<p>]</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code_t2">}</p>
|
||||||
|
<p>]</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"resultCode"</span>:"4099"</p>
|
||||||
|
<p>,<span>"data"</span>:"기타 시스템 오류"</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<!--// Response-->
|
||||||
|
</div>
|
||||||
353
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab4.jsp
Normal file
353
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab4.jsp
Normal file
@ -0,0 +1,353 @@
|
|||||||
|
<%@ 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-->
|
||||||
|
<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>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">msgGroupId</span></td>
|
||||||
|
<td>메시지 그룹 ID</td>
|
||||||
|
<td>String</td>
|
||||||
|
<td><span class="select_o">O</span></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">page</span></td>
|
||||||
|
<td>페이지 번호</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">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>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="box">
|
||||||
|
<div class="title">[Example]</div>
|
||||||
|
<div class="code_view">
|
||||||
|
<p>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"mberId"</span>:"홍길동"</p>
|
||||||
|
<p>,<span>"accessKey"</span>:"XXXXXXXXXXXXXX414050694b953"</p>
|
||||||
|
<p>,<span>"msgGroupId"</span>:"MSGGID_0000000011452"</p>
|
||||||
|
<p>,<span>"page"</span>:""</p>
|
||||||
|
<p>,<span>"pageSize"</span>:""</p>
|
||||||
|
<p>,<span>"test_yn"</span>:""</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</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].message</span></td>
|
||||||
|
<td>문자</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].next_yn</span></td>
|
||||||
|
<td>다음 페이지 여부</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].objectList</span></td>
|
||||||
|
<td>결과값 목록</td>
|
||||||
|
<td>Object List</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].msgGroupId</span></td>
|
||||||
|
<td>메시지 그룹 ID</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].msgId</span></td>
|
||||||
|
<td>메시지 ID</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].msgTypeName</span></td>
|
||||||
|
<td>문자 구분명(단문, 장문, 그림)</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].msgType</span></td>
|
||||||
|
<td>메시지 타입(4 : 단문, 6 : 장문)</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].callFrom</span></td>
|
||||||
|
<td>발신자 번호</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].callTo</span></td>
|
||||||
|
<td>수신자 번호</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].msgGroupCnt</span></td>
|
||||||
|
<td>문자 발송 건수</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].sCnt</span></td>
|
||||||
|
<td>성공 건수</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].fCnt</span></td>
|
||||||
|
<td>실패 건수</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].wCnt</span></td>
|
||||||
|
<td>대기 건수</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].msgResult</span></td>
|
||||||
|
<td>발송 결과(성공 : S, 실패 : F)</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].smsTxt</span></td>
|
||||||
|
<td>문자 내용</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].subject</span></td>
|
||||||
|
<td>제목</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].reqdate</span></td>
|
||||||
|
<td>발송 일자</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].curState</span></td>
|
||||||
|
<td>전송 처리 결과값</td>
|
||||||
|
<td>String</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].regdate</span></td>
|
||||||
|
<td>등록 일자</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].reserveCYn</span></td>
|
||||||
|
<td>예약 취소 여부</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].ttlCnt</span></td>
|
||||||
|
<td>전체 요청 수</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].remainMsgCnt</span></td>
|
||||||
|
<td>남은 문자 건수</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><span class="font_b">[data].totMsgCnt</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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"resultCode"</span>:"0"</p>
|
||||||
|
<p>,<span>"data"</span>:[</p>
|
||||||
|
<p>{</p>
|
||||||
|
<div class="indent_t1">
|
||||||
|
<p><span>"resultCode"</span>:"0"</p>
|
||||||
|
<p>,<span>"message"</span>: null</p>
|
||||||
|
<p>,<span>"next_yn"</span>:"n"</p>
|
||||||
|
<p>,<span>"msgGroupId"</span>:"MSGGID_0000000000000"</p>
|
||||||
|
<p>,<span>"objectList"</span>:[</p>
|
||||||
|
<p>{</p>
|
||||||
|
<div class="indent_t2">
|
||||||
|
<p><span>"msgTypeName"</span>:"단문(SMS)"</p>
|
||||||
|
<p>,<span>"msgType"</span>:"4"</p>
|
||||||
|
<p>,<span>"callFrom"</span>:"01011112222"</p>
|
||||||
|
<p>,<span>"callTo"</span>:"01011112223"</p>
|
||||||
|
<p>,<span>"msgGroupCnt"</span>:"2"</p>
|
||||||
|
<p>,<span>"msgGroupId"</span>:"MSGGID_0000000013340"</p>
|
||||||
|
<p>,<span>"msgId"</span>:"MSGID_0000000000001"</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>
|
||||||
|
<p>,<span>"reqdate"</span>:"2023-06-13 17:48:08"</p>
|
||||||
|
<p>,<span>"curState"</span>:"3"</p>
|
||||||
|
<p>,<span>"userId"</span>:"testuser"</p>
|
||||||
|
<p>,<span>"regdate"</span>:"2023-06-13 17:48:07"</p>
|
||||||
|
<p>,<span>"reserveCYn"</span>:"N"</p>
|
||||||
|
<p>,<span>"ttlCnt"</span>:"10"</p>
|
||||||
|
<p>,<span>"remainMsgCnt"</span>:"0"</p>
|
||||||
|
<p>,<span>"totMsgCnt"</span>:"10"</p>
|
||||||
|
</div>
|
||||||
|
<p>}</p>
|
||||||
|
<p>,{</p>
|
||||||
|
<div class="indent_t2">
|
||||||
|
<p><span>"msgTypeName"</span>:"단문(SMS)"</p>
|
||||||
|
<p>,<span>"msgType"</span>:"4"</p>
|
||||||
|
<p>,<span>"callFrom"</span>:"01011112222"</p>
|
||||||
|
<p>,<span>"callTo"</span>:"01011112223"</p>
|
||||||
|
<p>,<span>"msgGroupCnt"</span>:"2"</p>
|
||||||
|
<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>
|
||||||
|
<p>,<span>reqdate"</span>:"2023-06-13 17:48:09"</p>
|
||||||
|
<p>,<span>"curState"</span>:"3"</p>
|
||||||
|
<p>,<span>"userId"</span>:"testuser"</p>
|
||||||
|
<p>,<span>"regdate"</span>:"2023-06-13 17:48:07"</p>
|
||||||
|
<p>,<span>"reserveCYn"</span>:"N"</p>
|
||||||
|
<p>,<span>"ttlCnt"</span>:"10"</p>
|
||||||
|
<p>,<span>"remainMsgCnt"</span>:"0"</p>
|
||||||
|
<p>,<span>"totMsgCnt"</span>:"10"</p>
|
||||||
|
<p>}</p>
|
||||||
|
</div>
|
||||||
|
<p>]</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code_t2">}</p>
|
||||||
|
<p>]</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"resultCode"</span>:"4099"</p>
|
||||||
|
<p>,<span>"data"</span>:"기타 시스템 오류"</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<!--// Response-->
|
||||||
|
</div>
|
||||||
195
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab5.jsp
Normal file
195
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab5.jsp
Normal file
@ -0,0 +1,195 @@
|
|||||||
|
<%@ 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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"mberId"</span>:"String"</p>
|
||||||
|
<p>,<span>"accessKey"</span>:"String"</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"resultCode"</span>:"0"</p>
|
||||||
|
<p>,<span>"data"</span>{</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>}</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"resultCode"</span>:"5099"</p>
|
||||||
|
<p>,<span>"data"</span>:"기타 시스템 오류"</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<!--// Response-->
|
||||||
|
</div>
|
||||||
195
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab6.jsp
Normal file
195
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab6.jsp
Normal file
@ -0,0 +1,195 @@
|
|||||||
|
<%@ 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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"mberId"</span>:"String"</p>
|
||||||
|
<p>,<span>"accessKey"</span>:"String"</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"resultCode"</span>:"0"</p>
|
||||||
|
<p>,<span>"data"</span>{</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>}</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"resultCode"</span>:"5099"</p>
|
||||||
|
<p>,<span>"data"</span>:"기타 시스템 오류"</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<!--// Response-->
|
||||||
|
</div>
|
||||||
195
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab7.jsp
Normal file
195
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab7.jsp
Normal file
@ -0,0 +1,195 @@
|
|||||||
|
<%@ 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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"mberId"</span>:"String"</p>
|
||||||
|
<p>,<span>"accessKey"</span>:"String"</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"resultCode"</span>:"0"</p>
|
||||||
|
<p>,<span>"data"</span>{</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>}</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"resultCode"</span>:"5099"</p>
|
||||||
|
<p>,<span>"data"</span>:"기타 시스템 오류"</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<!--// Response-->
|
||||||
|
</div>
|
||||||
195
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab8.jsp
Normal file
195
src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab8.jsp
Normal file
@ -0,0 +1,195 @@
|
|||||||
|
<%@ 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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"mberId"</span>:"String"</p>
|
||||||
|
<p>,<span>"accessKey"</span>:"String"</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"resultCode"</span>:"0"</p>
|
||||||
|
<p>,<span>"data"</span>{</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>}</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</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>{</p>
|
||||||
|
<div class="indent">
|
||||||
|
<p><span>"resultCode"</span>:"5099"</p>
|
||||||
|
<p>,<span>"data"</span>:"기타 시스템 오류"</p>
|
||||||
|
</div>
|
||||||
|
<p class="l_code">}</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<!--// Response-->
|
||||||
|
</div>
|
||||||
Loading…
Reference in New Issue
Block a user