이지우 - API 소개 페이지 작업 중
@add6ea80b10620f9f8bb5210ef362ff8cbfaa43c
--- src/main/webapp/WEB-INF/jsp/web/api/apiSpec.jsp
+++ src/main/webapp/WEB-INF/jsp/web/api/apiSpec.jsp
... | ... | @@ -42,10 +42,12 @@ |
| 42 | 42 |
<div class="pay_tab_wrap"> |
| 43 | 43 |
<ul class="tabType1"> |
| 44 | 44 |
<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>
|
| 45 |
- <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>
|
|
| 45 |
+ <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>
|
|
| 46 |
+ <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>
|
|
| 46 | 47 |
</ul> |
| 47 | 48 |
</div> |
| 48 | 49 |
|
| 50 |
+ <!-- REST API 개발 가이드 > 문자 --> |
|
| 49 | 51 |
<div class="api_guide current" id="tab5_1"> |
| 50 | 52 |
<div class="list_tab_wrap2 type3"> |
| 51 | 53 |
<!-- tab button --> |
... | ... | @@ -85,8 +87,9 @@ |
| 85 | 87 |
<c:import url="./msg/apiSpec_tab5.jsp" /> |
| 86 | 88 |
</div> |
| 87 | 89 |
</div> |
| 90 |
+ <!-- //REST API 개발 가이드 > 문자 --> |
|
| 88 | 91 |
|
| 89 |
- |
|
| 92 |
+ <!-- REST API 개발 가이드 > 알림톡 --> |
|
| 90 | 93 |
<div class="api_guide" id="tab5_2"> |
| 91 | 94 |
<div class="list_tab_wrap2 type3"> |
| 92 | 95 |
<!-- tab button --> |
... | ... | @@ -95,8 +98,8 @@ |
| 95 | 98 |
<li class="tab active"><button type="button" onclick="TabType2(this,'6');">채널 ID 조회</button></li> |
| 96 | 99 |
<li class="tab"><button type="button" onclick="TabType2(this,'7');">템플릿 ID 조회</button></li> |
| 97 | 100 |
<li class="tab"><button type="button" onclick="TabType2(this,'8');">템플릿상세조회</button></li> |
| 98 |
- <li class="tab"><button type="button" onclick="TabType2(this,'9');">단건보내기</button></li> |
|
| 99 |
- <li class="tab"><button type="button" onclick="TabType2(this,'10');">대량보내기</button></li> |
|
| 101 |
+ <li class="tab"><button type="button" onclick="TabType2(this,'9');">알림톡 보내기</button></li> |
|
| 102 |
+ <!-- <li class="tab"><button type="button" onclick="TabType2(this,'10');">대량보내기</button></li> --> |
|
| 100 | 103 |
<li class="tab"><button type="button" onclick="TabType2(this,'11');">전송내역조회</button></li> |
| 101 | 104 |
<li class="tab"><button type="button" onclick="TabType2(this,'12');">전송내역조회(상세)</button></li> |
| 102 | 105 |
<li class="tab"><button type="button" onclick="TabType2(this,'13');">발송가능건수</button></li> |
... | ... | @@ -144,6 +147,21 @@ |
| 144 | 147 |
<c:import url="./at/apiSpec_tab8.jsp" /> |
| 145 | 148 |
</div> |
| 146 | 149 |
</div> |
| 150 |
+ <!-- //REST API 개발 가이드 > 알림톡 --> |
|
| 151 |
+ |
|
| 152 |
+ <!-- REST API 개발 가이드 > 친구톡 --> |
|
| 153 |
+ <div class="api_guide kakao" id="tab5_3"> |
|
| 154 |
+ <div class="list_tab_wrap2 type3"> |
|
| 155 |
+ <ul class="list_tab"> |
|
| 156 |
+ <li class="tab active"><button type="button" onclick="TabType2(this,'6');">채널 ID 조회</button></li> |
|
| 157 |
+ <li class="tab"><button type="button" onclick="TabType2(this,'7');">친구톡 보내기</button></li> |
|
| 158 |
+ <li class="tab"><button type="button" onclick="TabType2(this,'8');">전송내역조회</button></li> |
|
| 159 |
+ <li class="tab"><button type="button" onclick="TabType2(this,'9');">전송내역조회(상세)</button></li> |
|
| 160 |
+ <li class="tab"><button type="button" onclick="TabType2(this,'10');">발송가능건수</button></li> |
|
| 161 |
+ </ul> |
|
| 162 |
+ </div> |
|
| 163 |
+ </div> |
|
| 164 |
+ <!-- //REST API 개발 가이드 > 친구톡 --> |
|
| 147 | 165 |
</div> |
| 148 | 166 |
</div><!--// send top --> |
| 149 | 167 |
</div> |
+++ src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab1.jsp
... | ... | @@ -0,0 +1,216 @@ |
| 1 | +<%@ page language="java" contentType="text/html; charset=UTF-8" | |
| 2 | + pageEncoding="UTF-8"%> | |
| 3 | + | |
| 4 | + | |
| 5 | +<ul class="info"> | |
| 6 | + <li>- API를 통해서 채널 ID를 조회할 수 있습니다.</li> | |
| 7 | +<!-- <li>- 발신번호는 문자온 사이트를 통해 사전등록 후 이용하실 수 있습니다.(마이페이지-발신번호 관리 메뉴 이용)</li> --> | |
| 8 | +<!-- <li>- 문자 내용이 "90byte"를 초과하는 경우 장문(LMS)으로 자동 전환됩니다.</li> --> | |
| 9 | +</ul> | |
| 10 | + | |
| 11 | +<div class="re_cont"> | |
| 12 | + <!--Request--> | |
| 13 | + <div class="req_title">Request</div> | |
| 14 | + <div class="box"> | |
| 15 | + <div class="text"> | |
| 16 | + <h4>Request</h4> | |
| 17 | + <table> | |
| 18 | + <caption>API Request Http Method, 프로토콜, HOST, Service Port | |
| 19 | + 정보 테이블</caption> | |
| 20 | + <colgroup> | |
| 21 | + <col style="width: 20%;"> | |
| 22 | + <col style="width: 80%;"> | |
| 23 | + </colgroup> | |
| 24 | + <tr> | |
| 25 | + <th>Http Method</th> | |
| 26 | + <td>POST</td> | |
| 27 | + </tr> | |
| 28 | + <tr> | |
| 29 | + <th>프로토콜</th> | |
| 30 | + <td>HTTP/1.1</td> | |
| 31 | + </tr> | |
| 32 | + <tr> | |
| 33 | + <th>HOST</th> | |
| 34 | + <td>api.munjaon.co.kr</td> | |
| 35 | + </tr> | |
| 36 | + <tr> | |
| 37 | + <th>Service Port</th> | |
| 38 | + <td>443</td> | |
| 39 | + </tr> | |
| 40 | + </table> | |
| 41 | + </div> | |
| 42 | + </div> | |
| 43 | + <div class="type_table"> | |
| 44 | + <table> | |
| 45 | + <caption>문자발송 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption> | |
| 46 | + <colgroup> | |
| 47 | + <col style="width: 20%;"> | |
| 48 | + <col style="width: 45%;"> | |
| 49 | + <col style="width: 25%"> | |
| 50 | + <col style="width: 10%"> | |
| 51 | + </colgroup> | |
| 52 | + <thead> | |
| 53 | + <tr> | |
| 54 | + <th>키</th> | |
| 55 | + <th>설명</th> | |
| 56 | + <th>타입</th> | |
| 57 | + <th>필수</th> | |
| 58 | + </tr> | |
| 59 | + </thead> | |
| 60 | + <tbody> | |
| 61 | + <tr> | |
| 62 | + <td><span class="font_b">mberId</span></td> | |
| 63 | + <td>사용자 ID</td> | |
| 64 | + <td>String</td> | |
| 65 | + <td><span class="select_o">O</span></td> | |
| 66 | + </tr> | |
| 67 | + <tr> | |
| 68 | + <td><span class="font_b">accessKey</span></td> | |
| 69 | + <td>인증용 API Key</td> | |
| 70 | + <td>String</td> | |
| 71 | + <td><span class="select_o">O</span></td> | |
| 72 | + </tr> | |
| 73 | + </tbody> | |
| 74 | + </table> | |
| 75 | + <div class="table_info"> | |
| 76 | + <p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p> | |
| 77 | + <p>※ 문자 텍스트 용량(byte) : 한글 1자당 2byte, 영문/숫자 1자당 1byte</p> | |
| 78 | + </div> | |
| 79 | + </div> | |
| 80 | + <div class="box"> | |
| 81 | + <div class="title">[Example]</div> | |
| 82 | + <div class="code_view"> | |
| 83 | + <p>{</p> | |
| 84 | + <div class="indent"> | |
| 85 | + <p> | |
| 86 | + <span>"mberId"</span>:"홍길동" | |
| 87 | + </p> | |
| 88 | + <p> | |
| 89 | + ,<span>"accessKey"</span>:"XXXXXXXXXXXXXX414050694b953" | |
| 90 | + </p> | |
| 91 | + </div> | |
| 92 | + <p class="l_code">}</p> | |
| 93 | + </div> | |
| 94 | + </div> | |
| 95 | + <!--// Request--> | |
| 96 | + <!-- Response--> | |
| 97 | + <div class="res_title">Response</div> | |
| 98 | + <div class="type_table"> | |
| 99 | + <table> | |
| 100 | + <caption>문자발송 API Response 키 종류 및 설명, 타입 테이블</caption> | |
| 101 | + <colgroup> | |
| 102 | + <col style="width: 20%;"> | |
| 103 | + <col style="width: 60%;"> | |
| 104 | + <col style="width: 20%;"> | |
| 105 | + </colgroup> | |
| 106 | + <thead> | |
| 107 | + <tr> | |
| 108 | + <th>키</th> | |
| 109 | + <th>설명</th> | |
| 110 | + <th>타입</th> | |
| 111 | + </tr> | |
| 112 | + </thead> | |
| 113 | + <tbody> | |
| 114 | + <tr> | |
| 115 | + <td><span class="font_b">resultCode</span></td> | |
| 116 | + <td>성공 여부 ("0" 이면 성공, 그 외는 실패)</td> | |
| 117 | + <td>String</td> | |
| 118 | + </tr> | |
| 119 | + <tr> | |
| 120 | + <td><span class="font_b">data</span></td> | |
| 121 | + <td>응답 결과 객체 (성공 시 배열, 실패 시 메시지)</td> | |
| 122 | + <td>Array<Object></td> | |
| 123 | + </tr> | |
| 124 | + <tr> | |
| 125 | + <td><span class="font_b">data[].userId</span></td> | |
| 126 | + <td>사용자 ID</td> | |
| 127 | + <td>String</td> | |
| 128 | + </tr> | |
| 129 | + <tr> | |
| 130 | + <td><span class="font_b">data[].senderKey</span></td> | |
| 131 | + <td>발신자 키</td> | |
| 132 | + <td>String</td> | |
| 133 | + </tr> | |
| 134 | + <tr> | |
| 135 | + <td><span class="font_b">data[].phoneNumber</span></td> | |
| 136 | + <td>수신자 전화번호</td> | |
| 137 | + <td>String</td> | |
| 138 | + </tr> | |
| 139 | + <tr> | |
| 140 | + <td><span class="font_b">data[].yellowId</span></td> | |
| 141 | + <td>카카오톡 채널 ID</td> | |
| 142 | + <td>String</td> | |
| 143 | + </tr> | |
| 144 | + <tr> | |
| 145 | + <td><span class="font_b">data[].firstRegistPnttm</span></td> | |
| 146 | + <td>최초 등록 시각 (yyyy‑MM‑dd HH:mm:ss)</td> | |
| 147 | + <td>String</td> | |
| 148 | + </tr> | |
| 149 | + <tr> | |
| 150 | + <td><span class="font_b">data[].firstRegisterId</span></td> | |
| 151 | + <td>최초 등록자 ID</td> | |
| 152 | + <td>String</td> | |
| 153 | + </tr> | |
| 154 | + </tbody> | |
| 155 | + </table> | |
| 156 | + | |
| 157 | + <div class="table_info"> | |
| 158 | + <p>※ JSON 객체로 응답합니다.</p> | |
| 159 | + </div> | |
| 160 | + </div> | |
| 161 | + <div class="box"> | |
| 162 | + <div class="title_t1"> | |
| 163 | + <span class="ex">[Example]</span><span class="ex_success">O 성공 | |
| 164 | + 예시</span> | |
| 165 | + </div> | |
| 166 | + <div class="code_view"> | |
| 167 | + <p>{</p> | |
| 168 | + <div class="indent"> | |
| 169 | + <p> | |
| 170 | + <span>"resultCode"</span>:"0" | |
| 171 | + </p> | |
| 172 | + <p> | |
| 173 | + ,<span>"data"</span>{ | |
| 174 | + </p> | |
| 175 | + <div class="indent_t1"> | |
| 176 | + <p> | |
| 177 | + ,<span>"senderKey"</span>:"6691434xxxxxxxxxxxxxxxxxxxxxxxxx" | |
| 178 | + </p> | |
| 179 | + <p> | |
| 180 | + ,<span>"phoneNumber"</span>:"010xxxxxxxx" | |
| 181 | + </p> | |
| 182 | + <p> | |
| 183 | + ,<span>"yellowId"</span>:"@ID" | |
| 184 | + </p> | |
| 185 | + <p> | |
| 186 | + ,<span>"firstRegistPnttm"</span>:"2025-10-05 18:08:58" | |
| 187 | + </p> | |
| 188 | + <p> | |
| 189 | + ,<span>"firstRegisterId"</span>:"userId" | |
| 190 | + </p> | |
| 191 | + </div> | |
| 192 | + <p>}</p> | |
| 193 | + </div> | |
| 194 | + <p class="l_code">}</p> | |
| 195 | + </div> | |
| 196 | + </div> | |
| 197 | + <div class="box"> | |
| 198 | + <div class="title_t1"> | |
| 199 | + <span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span> | |
| 200 | + </div> | |
| 201 | + <div class="code_view"> | |
| 202 | + <p>{</p> | |
| 203 | + <div class="indent"> | |
| 204 | + <p> | |
| 205 | + <span>"resultCode"</span>:"401" | |
| 206 | + </p> | |
| 207 | + <p> | |
| 208 | + ,<span>"message"</span>:"Unauthorized" | |
| 209 | + </p> | |
| 210 | + </div> | |
| 211 | + <p class="l_code">}</p> | |
| 212 | + </div> | |
| 213 | + </div> | |
| 214 | + <!--// Response--> | |
| 215 | +</div> | |
| 216 | + |
+++ src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab2.jsp
... | ... | @@ -0,0 +1,232 @@ |
| 1 | +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> | |
| 2 | + | |
| 3 | + <ul class="info"> | |
| 4 | + <li>- API를 통해서 다른 내용의 문자를 대량으로 전송할 수 있습니다.</li> | |
| 5 | + <li>- 발신번호는 문자온 사이트를 통해 사전등록 후 이용하실 수 있습니다.(마이페이지-발신번호 관리 메뉴 이용)</li> | |
| 6 | + <li>- 문자 내용이 "90byte"를 초과하는 경우 장문(LMS)으로 자동 전환됩니다.</li> | |
| 7 | + </ul> | |
| 8 | + | |
| 9 | + <div class="re_cont"> | |
| 10 | + <!--Request--> | |
| 11 | + <div class="req_title">Request</div> | |
| 12 | + <div class="box"> | |
| 13 | + <div class="text"> | |
| 14 | + <h4>Request</h4> | |
| 15 | + <table> | |
| 16 | + <caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption> | |
| 17 | + <colgroup> | |
| 18 | + <col style="width:20%;"> | |
| 19 | + <col style="width:80%;"> | |
| 20 | + </colgroup> | |
| 21 | + <tr> | |
| 22 | + <th>Http Method</th> | |
| 23 | + <td>POST</td> | |
| 24 | + </tr> | |
| 25 | + <tr> | |
| 26 | + <th>프로토콜</th> | |
| 27 | + <td>HTTP/1.1</td> | |
| 28 | + </tr> | |
| 29 | + <tr> | |
| 30 | + <th>HOST</th> | |
| 31 | + <td>api.munjaon.co.kr</td> | |
| 32 | + </tr> | |
| 33 | + <tr> | |
| 34 | + <th>Service Port</th> | |
| 35 | + <td>443</td> | |
| 36 | + </tr> | |
| 37 | + </table> | |
| 38 | + </div> | |
| 39 | + </div> | |
| 40 | + <div class="type_table"> | |
| 41 | + <table> | |
| 42 | + <caption>문자발송 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption> | |
| 43 | + <colgroup> | |
| 44 | + <col style="width: 20%;"> | |
| 45 | + <col style="width: 45%;"> | |
| 46 | + <col style="width: 25%"> | |
| 47 | + <col style="width: 10%"> | |
| 48 | + </colgroup> | |
| 49 | + <thead> | |
| 50 | + <tr> | |
| 51 | + <th>키</th> | |
| 52 | + <th>설명</th> | |
| 53 | + <th>타입</th> | |
| 54 | + <th>필수</th> | |
| 55 | + </tr> | |
| 56 | + </thead> | |
| 57 | + <tbody> | |
| 58 | + <tr> | |
| 59 | + <td><span class="font_b">mberId</span></td> | |
| 60 | + <td>사용자 ID</td> | |
| 61 | + <td>String</td> | |
| 62 | + <td><span class="select_o">O</span></td> | |
| 63 | + </tr> | |
| 64 | + <tr> | |
| 65 | + <td><span class="font_b">accessKey</span></td> | |
| 66 | + <td>인증용 API Key</td> | |
| 67 | + <td>String</td> | |
| 68 | + <td><span class="select_o">O</span></td> | |
| 69 | + </tr> | |
| 70 | + <tr> | |
| 71 | + <td><span class="font_b">senderKey</span></td> | |
| 72 | + <td>발신 프로필 Key</td> | |
| 73 | + <td>String</td> | |
| 74 | + <td><span class="select_o">O</span></td> | |
| 75 | + </tr> | |
| 76 | + </tbody> | |
| 77 | + </table> | |
| 78 | + <div class="table_info"> | |
| 79 | + <p>※ 문자 텍스트 용량(byte) : 한글 1자당 2byte, 영문/숫자 1자당 1byte</p> | |
| 80 | + </div> | |
| 81 | + </div> | |
| 82 | + <div class="box"> | |
| 83 | + <div class="title">[Example]</div> | |
| 84 | + <div class="code_view"> | |
| 85 | + <p>{</p> | |
| 86 | + <div class="indent"> | |
| 87 | + <p><span>"mberId"</span>:"홍길동"</p> | |
| 88 | + <p>,<span>"accessKey"</span>:"414050694b953XXXXXXXXXXXXXX"</p> | |
| 89 | + <p>,<span>"senderKey"</span>:"669143473b1af459628b8bdXXXXXXXXXXXXXX"</p> | |
| 90 | + </div> | |
| 91 | + <p class="l_code">}</p> | |
| 92 | + </div> | |
| 93 | + </div> | |
| 94 | + <!--// Request--> | |
| 95 | + <!-- Response--> | |
| 96 | + <div class="res_title">Response</div> | |
| 97 | + <div class="type_table"> | |
| 98 | + <table> | |
| 99 | + <caption>문자발송(대량) API Response 키 종류 및 설명, 타입 테이블</caption> | |
| 100 | + <colgroup> | |
| 101 | + <col style="width:20%;"> | |
| 102 | + <col style="width:60%;"> | |
| 103 | + <col style="width:20%;"> | |
| 104 | + </colgroup> | |
| 105 | + <thead> | |
| 106 | + <tr> | |
| 107 | + <th>키</th> | |
| 108 | + <th>설명</th> | |
| 109 | + <th>타입</th> | |
| 110 | + </tr> | |
| 111 | + </thead> | |
| 112 | + <tbody> | |
| 113 | + <tr> | |
| 114 | + <td><span class="font_b">resultCode</span></td> | |
| 115 | + <td>성공 여부("0" 아니면 실패)</td> | |
| 116 | + <td>String</td> | |
| 117 | + </tr> | |
| 118 | + <tr> | |
| 119 | + <td><span class="font_b">data</span></td> | |
| 120 | + <td>템플릿 정보 리스트</td> | |
| 121 | + <td>Array</td> | |
| 122 | + </tr> | |
| 123 | + <tr> | |
| 124 | + <td><span class="font_b">[data].senderKey</span></td> | |
| 125 | + <td>발신 프로필 키</td> | |
| 126 | + <td>String</td> | |
| 127 | + </tr> | |
| 128 | + <tr> | |
| 129 | + <td><span class="font_b">[data].templateCode</span></td> | |
| 130 | + <td>템플릿 코드</td> | |
| 131 | + <td>String</td> | |
| 132 | + </tr> | |
| 133 | + <tr> | |
| 134 | + <td><span class="font_b">[data].templateName</span></td> | |
| 135 | + <td>템플릿 이름</td> | |
| 136 | + <td>String</td> | |
| 137 | + </tr> | |
| 138 | + <tr> | |
| 139 | + <td><span class="font_b">[data].createdAt</span></td> | |
| 140 | + <td>생성일시</td> | |
| 141 | + <td>String</td> | |
| 142 | + </tr> | |
| 143 | + <tr> | |
| 144 | + <td><span class="font_b">[data].modifiedAt</span></td> | |
| 145 | + <td>수정일시</td> | |
| 146 | + <td>String</td> | |
| 147 | + </tr> | |
| 148 | + <tr> | |
| 149 | + <td><span class="font_b">[data].serviceStatus</span></td> | |
| 150 | + <td>템플릿 상태 <br>(REG: 등록, REQ: 검수요청, REJ: 반려, | |
| 151 | +STP: 차단, RDY: 발송전, ACT: 정상, DMT: 휴면, BLK: | |
| 152 | +차단)</td> | |
| 153 | + <td>String</td> | |
| 154 | + </tr> | |
| 155 | + </tbody> | |
| 156 | + </table> | |
| 157 | + <div class="table_info"> | |
| 158 | + <p>※ JSON 객체로 응답합니다.</p> | |
| 159 | + </div> | |
| 160 | + </div> | |
| 161 | + <div class="box"> | |
| 162 | + <div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div> | |
| 163 | + | |
| 164 | + <div class="code_view"> | |
| 165 | + <p>{</p> | |
| 166 | + <div class="indent"> | |
| 167 | + <p> | |
| 168 | + <span>"resultCode"</span>:"0" | |
| 169 | + </p> | |
| 170 | + <p> | |
| 171 | + ,<span>"data"</span>{ | |
| 172 | + </p> | |
| 173 | + <div class="indent_t1"> | |
| 174 | + <p> | |
| 175 | + ,<span>"senderKey"</span>:"669143473b1af459628xxxxxxxxxxxxxxxxxxxxx" | |
| 176 | + </p> | |
| 177 | + <p> | |
| 178 | + ,<span>"templateCode"</span>:"bizp_20250527112232xxxxxxxxxxxxx" | |
| 179 | + </p> | |
| 180 | + <p> | |
| 181 | + ,<span>"templateName"</span>:"템플릿 명" | |
| 182 | + </p> | |
| 183 | + <p> | |
| 184 | + ,<span>"createdAt"</span>:"2025-05-27 11:22:33" | |
| 185 | + </p> | |
| 186 | + <p> | |
| 187 | + ,<span>"modifiedAt"</span>:"2025-05-27 11:22:33" | |
| 188 | + </p> | |
| 189 | + <p> | |
| 190 | + ,<span>"serviceStatus"</span>:"REG(등록완료)" | |
| 191 | + </p> | |
| 192 | + </div> | |
| 193 | + <p>}</p> | |
| 194 | + <p>,{</p> | |
| 195 | + <div class="indent_t1"> | |
| 196 | + <p> | |
| 197 | + ,<span>"senderKey"</span>:"669143473b1af459628xxxxxxxxxxxxxxxxxxxxx" | |
| 198 | + </p> | |
| 199 | + <p> | |
| 200 | + ,<span>"templateCode"</span>:"bizp_20250527112232xxxxxxxxxxxxx" | |
| 201 | + </p> | |
| 202 | + <p> | |
| 203 | + ,<span>"templateName"</span>:"템플릿 명2" | |
| 204 | + </p> | |
| 205 | + <p> | |
| 206 | + ,<span>"createdAt"</span>:"2025-05-27 11:22:33" | |
| 207 | + </p> | |
| 208 | + <p> | |
| 209 | + ,<span>"modifiedAt"</span>:"2025-05-27 11:22:33" | |
| 210 | + </p> | |
| 211 | + <p> | |
| 212 | + ,<span>"serviceStatus"</span>:"RDY(대기)" | |
| 213 | + </p> | |
| 214 | + </div> | |
| 215 | + <p>}</p> | |
| 216 | + </div> | |
| 217 | + <p class="l_code">}</p> | |
| 218 | + </div> | |
| 219 | + </div> | |
| 220 | + <div class="box"> | |
| 221 | + <div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div> | |
| 222 | + <div class="code_view"> | |
| 223 | + <p>{</p> | |
| 224 | + <div class="indent"> | |
| 225 | + <p><span>"resultCode"</span>:"4099"</p> | |
| 226 | + <p>,<span>"msg"</span>:"기타 시스템 오류"</p> | |
| 227 | + </div> | |
| 228 | + <p class="l_code">}</p> | |
| 229 | + </div> | |
| 230 | + </div> | |
| 231 | + <!--// Response--> | |
| 232 | + </div> |
+++ src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab3.jsp
... | ... | @@ -0,0 +1,331 @@ |
| 1 | +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> | |
| 2 | + | |
| 3 | + <ul class="info"> | |
| 4 | + <li>- 문자온 사이트 및 API를 통해 전송된 문자 발송내역을 조회할 수 있습니다.</li> | |
| 5 | + <li>- 문자 발송내역은 날짜별로 조회되며, 최근 3개월까지만 조회 가능합니다.</li> | |
| 6 | + <li>- 발신번호별 문자 발송내역 조회 기능은 제공되지 않습니다.</li> | |
| 7 | + </ul> | |
| 8 | + | |
| 9 | + <div class="re_cont"> | |
| 10 | + <!--Request--> | |
| 11 | + <div class="req_title">Request</div> | |
| 12 | + <div class="box"> | |
| 13 | + <div class="text"> | |
| 14 | + <h4>Request</h4> | |
| 15 | + <table> | |
| 16 | + <caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption> | |
| 17 | + <colgroup> | |
| 18 | + <col style="width:20%;"> | |
| 19 | + <col style="width:80%;"> | |
| 20 | + </colgroup> | |
| 21 | + <tr> | |
| 22 | + <th>Http Method</th> | |
| 23 | + <td>POST</td> | |
| 24 | + </tr> | |
| 25 | + <tr> | |
| 26 | + <th>프로토콜</th> | |
| 27 | + <td>HTTP/1.1</td> | |
| 28 | + </tr> | |
| 29 | + <tr> | |
| 30 | + <th>HOST</th> | |
| 31 | + <td>api.munjaon.co.kr</td> | |
| 32 | + </tr> | |
| 33 | + <tr> | |
| 34 | + <th>Service Port</th> | |
| 35 | + <td>443</td> | |
| 36 | + </tr> | |
| 37 | + </table> | |
| 38 | + </div> | |
| 39 | + </div> | |
| 40 | + <div class="type_table"> | |
| 41 | + <table> | |
| 42 | + <caption>전송결과 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption> | |
| 43 | + <colgroup> | |
| 44 | + <col style="width:20%;"> | |
| 45 | + <col style="width:45%;"> | |
| 46 | + <col style="width:25%"> | |
| 47 | + <col style="width:10%"> | |
| 48 | + </colgroup> | |
| 49 | + <thead> | |
| 50 | + <tr> | |
| 51 | + <th>키</th> | |
| 52 | + <th>설명</th> | |
| 53 | + <th>타입</th> | |
| 54 | + <th>필수</th> | |
| 55 | + </tr> | |
| 56 | + </thead> | |
| 57 | + <tbody> | |
| 58 | + <tr> | |
| 59 | + <td><span class="font_b">mberId</span></td> | |
| 60 | + <td>사용자 ID</td> | |
| 61 | + <td>String</td> | |
| 62 | + <td><span class="select_o">O</span></td> | |
| 63 | + </tr> | |
| 64 | + <tr> | |
| 65 | + <td><span class="font_b">accessKey</span></td> | |
| 66 | + <td>인증용 API Key</td> | |
| 67 | + <td>String</td> | |
| 68 | + <td><span class="select_o">O</span></td> | |
| 69 | + </tr> | |
| 70 | + <tr> | |
| 71 | + <td><span class="font_b">senderKey</span></td> | |
| 72 | + <td>발신 프로필 Key</td> | |
| 73 | + <td>String</td> | |
| 74 | + <td><span class="select_o">O</span></td> | |
| 75 | + </tr> | |
| 76 | + <tr> | |
| 77 | + <td><span class="font_b">templateCode</span></td> | |
| 78 | + <td>템플릿 코드</td> | |
| 79 | + <td>String</td> | |
| 80 | + <td><span class="select_o">O</span></td> | |
| 81 | + </tr> | |
| 82 | + </tbody> | |
| 83 | + </table> | |
| 84 | + <div class="table_info"> | |
| 85 | + <p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p> | |
| 86 | + </div> | |
| 87 | + </div> | |
| 88 | + <div class="box"> | |
| 89 | + <div class="title">[Example]</div> | |
| 90 | + <div class="code_view"> | |
| 91 | + <p>{</p> | |
| 92 | + <div class="indent"> | |
| 93 | + <p><span>"mberId"</span>:"홍길동"</p> | |
| 94 | + <p>,<span>"accessKey"</span>:"414050694b953XXXXXXXXXXXXXX"</p> | |
| 95 | + <p>,<span>"senderKey"</span>:"669143473b1af459628b8bdXXXXXXXXXXXXXX"</p> | |
| 96 | + <p>,<span>"templateCode"</span>:"bizp_202503141052XXXXXXXXXXXXXX"</p> | |
| 97 | + </div> | |
| 98 | + <p class="l_code">}</p> | |
| 99 | + </div> | |
| 100 | + </div> | |
| 101 | + <!--// Request--> | |
| 102 | + <!-- Response--> | |
| 103 | + <div class="res_title">Response</div> | |
| 104 | + <div class="type_table"> | |
| 105 | + <table> | |
| 106 | + <caption>전송결과 조회 API Response 키 종류 및 설명, 타입 테이블</caption> | |
| 107 | + <colgroup> | |
| 108 | + <col style="width:20%;"> | |
| 109 | + <col style="width:60%;"> | |
| 110 | + <col style="width:20%;"> | |
| 111 | + </colgroup> | |
| 112 | + <thead> | |
| 113 | + <tr> | |
| 114 | + <th>키</th> | |
| 115 | + <th>설명</th> | |
| 116 | + <th>타입</th> | |
| 117 | + </tr> | |
| 118 | + </thead> | |
| 119 | + <tbody> | |
| 120 | + <tr> | |
| 121 | + <td><span class="font_b">resultCode</span></td> | |
| 122 | + <td>성공 여부("0" 아니면 실패)</td> | |
| 123 | + <td>String</td> | |
| 124 | + </tr> | |
| 125 | + <tr> | |
| 126 | + <td><span class="font_b">data</span></td> | |
| 127 | + <td>템플릿 정보 리스트</td> | |
| 128 | + <td>Array</td> | |
| 129 | + </tr> | |
| 130 | + <tr><td><span class="font_b">[data].templateCode</span></td><td>템플릿 코드</td><td>String</td></tr> | |
| 131 | + <tr><td><span class="font_b">[data].templateName</span></td><td>템플릿 이름</td><td>String</td></tr> | |
| 132 | + <tr><td><span class="font_b">[data].templateMessageType</span></td><td>템플릿 메시지 유형 (BA:기본형(default), EX:부가정보형, AD:광고추가형, MI:복합형)</td><td>String</td></tr> | |
| 133 | + <tr><td><span class="font_b">[data].templateEmphasizeType</span></td><td>템플릿 강조 유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, ITEM_LIST: 아이템리스트형)</td><td>String</td></tr> | |
| 134 | + <tr><td><span class="font_b">[data].templateContent</span></td><td>템플릿 내용</td><td>String</td></tr> | |
| 135 | + <tr><td><span class="font_b">[data].templateExtra</span></td><td>부가정보</td><td>String</td></tr> | |
| 136 | + <tr><td><span class="font_b">[data].templateAd</span></td><td>광고성 메시지</td><td>String</td></tr> | |
| 137 | + <tr><td><span class="font_b">[data].templateImageName</span></td><td>템플릿 이미지 파일명</td><td>String</td></tr> | |
| 138 | + <tr><td><span class="font_b">[data].templateImageUrl</span></td><td>템플릿 이미지 링크</td><td>String</td></tr> | |
| 139 | + <tr><td><span class="font_b">[data].templateTitle</span></td><td>템플릿 내용 중 강조 표기할 핵심 정보</td><td>String</td></tr> | |
| 140 | + <tr><td><span class="font_b">[data].templateSubtitle</span></td><td>강조 표기 보조 문구</td><td>String</td></tr> | |
| 141 | + <tr><td><span class="font_b">[data].templateHeader</span></td><td>헤더</td><td>String</td></tr> | |
| 142 | + | |
| 143 | + <tr><td><span class="font_b">[data].categoryCode</span></td><td>템플릿 카테고리 코드</td><td>String</td></tr> | |
| 144 | + <tr><td><span class="font_b">[data].securityFlag</span></td><td>보안 템플릿 여부 (true:설정)</td><td>Boolean</td></tr> | |
| 145 | + <tr><td><span class="font_b">[data].inspectionStatus</span></td><td>검수 상태 (REG: 등록, REQ: 검수요청, REJ: 반려, APR: 승인)</td><td>String</td></tr> | |
| 146 | + <tr><td><span class="font_b">[data].createdAt</span></td><td>생성일</td><td>String</td></tr> | |
| 147 | + <tr><td><span class="font_b">[data].modifiedAt</span></td><td>수정일</td><td>String</td></tr> | |
| 148 | + <tr><td><span class="font_b">[data].status</span></td><td>템플릿 상태(D:중지, A:정상, R:대기(발송전))</td><td>String</td></tr> | |
| 149 | + <tr><td><span class="font_b">[data].block</span></td><td>템플릿 차단 여부 (true:차단, false: 해제)</td><td>Boolean</td></tr> | |
| 150 | + <tr><td><span class="font_b">[data].dormant</span></td><td>템플릿 휴면 여부 (true:휴면, false: 해제)</td><td>Boolean</td></tr> | |
| 151 | + | |
| 152 | + <tr><td><span class="font_b">[data].templateItemHighlight</span></td><td>아이템 하이라이트</td><td>Object</td></tr> | |
| 153 | + <tr><td><span class="font_b">[data].templateItemHighlight.title</span></td><td>타이틀</td><td>String</td></tr> | |
| 154 | + <tr><td><span class="font_b">[data].templateItemHighlight.description</span></td><td>상세 설명</td><td>String</td></tr> | |
| 155 | + <tr><td><span class="font_b">[data].templateItemHighlight.imageUrl</span></td><td>썸네일 이미지 주소</td><td>String</td></tr> | |
| 156 | + | |
| 157 | + <tr><td><span class="font_b">[data].templateItem</span></td><td>아이템 정보</td><td>Object</td></tr> | |
| 158 | + <tr><td><span class="font_b">[data].templateItem.list[]</span></td><td>아이템 리스트</td><td>Array</td></tr> | |
| 159 | + <tr><td><span class="font_b">[data].templateItem.list[].title</span></td><td>타이틀</td><td>String</td></tr> | |
| 160 | + <tr><td><span class="font_b">[data].templateItem.list[].description</span></td><td>디스크립션</td><td>String</td></tr> | |
| 161 | + | |
| 162 | + <tr><td><span class="font_b">[data].templateItem.summary</span></td><td>아이템 요약 정보</td><td>Object</td></tr> | |
| 163 | + <tr><td><span class="font_b">[data].templateItem.summary.title</span></td><td>타이틀</td><td>String</td></tr> | |
| 164 | + <tr><td><span class="font_b">[data].templateItem.summary.description</span></td><td>디스크립션</td><td>String</td></tr> | |
| 165 | + | |
| 166 | + <!-- buttons --> | |
| 167 | + <tr><td><span class="font_b">[data].buttons[]</span></td><td>버튼 정보</td><td>Array</td></tr> | |
| 168 | + <tr><td><span class="font_b">[data].buttons[].name</span></td><td>버튼명</td><td>String</td></tr> | |
| 169 | + <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> | |
| 170 | + <tr><td><span class="font_b">[data].buttons[].linkAnd</span></td><td>Android 앱 링크 주소</td><td>String</td></tr> | |
| 171 | + <tr><td><span class="font_b">[data].buttons[].linkIos</span></td><td>IOS 앱 링크 주소</td><td>String</td></tr> | |
| 172 | + <tr><td><span class="font_b">[data].buttons[].linkMo</span></td><td>모바일 웹 링크 주소</td><td>String</td></tr> | |
| 173 | + <tr><td><span class="font_b">[data].buttons[].linkPc</span></td><td>PC 웹 링크 주소</td><td>String</td></tr> | |
| 174 | + <tr><td><span class="font_b">[data].buttons[].pluginId</span></td><td>플러그인 ID</td><td>String</td></tr> | |
| 175 | + | |
| 176 | + <!-- quickReplies --> | |
| 177 | + <tr><td><span class="font_b">[data].quickReplies[]</span></td><td>바로연결 정보</td><td>Array</td></tr> | |
| 178 | + <tr><td><span class="font_b">[data].quickReplies[].name</span></td><td>바로연결명</td><td>String</td></tr> | |
| 179 | + <tr><td><span class="font_b">[data].quickReplies[].linkType</span></td><td>바로연결 링크타입 (WL:웹링크, AL:앱링크, BK:봇키워드, MD: 메시지전달, BC: 상담톡전환, BT: 봇전환)</td><td>String</td></tr> | |
| 180 | + <tr><td><span class="font_b">[data].quickReplies[].linkAnd</span></td><td>Android 앱 링크 주소</td><td>String</td></tr> | |
| 181 | + <tr><td><span class="font_b">[data].quickReplies[].linkIos</span></td><td>IOS 앱 링크 주소</td><td>String</td></tr> | |
| 182 | + <tr><td><span class="font_b">[data].quickReplies[].linkMo</span></td><td>모바일 웹 링크 주소</td><td>String</td></tr> | |
| 183 | + <tr><td><span class="font_b">[data].quickReplies[].linkPc</span></td><td>PC 웹 링크 주소</td><td>String</td></tr> | |
| 184 | + | |
| 185 | + <!-- comments --> | |
| 186 | + <tr><td><span class="font_b">[data].comments[]</span></td><td>댓글 목록</td><td>Array</td></tr> | |
| 187 | + <tr><td><span class="font_b">[data].comments[].content</span></td><td>댓글 본문</td><td>String</td></tr> | |
| 188 | + <tr><td><span class="font_b">[data].comments[].createdAt</span></td><td>댓글 생성일</td><td>String</td></tr> | |
| 189 | + <tr><td><span class="font_b">[data].comments[].status</span></td><td>댓글 상태 (REQ:등록, INQ:문의, APR:승인, REJ:반려, REP:답변)</td><td>String</td></tr> | |
| 190 | + <tr><td><span class="font_b">[data].comments[].userName</span></td><td>댓글 작성자</td><td>String</td></tr> | |
| 191 | + <tr><td><span class="font_b">[data].comments[].attachment</span></td><td>첨부파일</td><td>Array</td></tr> | |
| 192 | + | |
| 193 | + <!-- attachment 내부 --> | |
| 194 | + <tr><td><span class="font_b">[data].comments[].attachment[]</span></td><td>첨부파일</td><td>Array</td></tr> | |
| 195 | + <tr><td><span class="font_b">[data].comments[].attachment[].originalFileName</span></td><td>업로드한 파일 이름</td><td>String</td></tr> | |
| 196 | + <tr><td><span class="font_b">[data].comments[].attachment[].filePath</span></td><td>파일 다운로드 경로</td><td>String</td></tr> | |
| 197 | + | |
| 198 | + | |
| 199 | + </tbody> | |
| 200 | + </table> | |
| 201 | + <div class="table_info"> | |
| 202 | + <p>※ JSON 객체로 응답합니다.</p> | |
| 203 | + </div> | |
| 204 | + </div> | |
| 205 | + <div class="box"> | |
| 206 | + <div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div> | |
| 207 | + <div class="code_view"> | |
| 208 | + <p>{</p> | |
| 209 | + <div class="indent"> | |
| 210 | + <p><span>"resultCode"</span>:"0"</p> | |
| 211 | + <p>,<span>"data"</span>:[</p> | |
| 212 | + <p>{</p> | |
| 213 | + <div class="indent_t1"> | |
| 214 | + <p><span>"templateCode"</span>: "bizp_20250314105XXXXXXXXXXXXXXX"</p> | |
| 215 | + <p>,<span>"templateName"</span>: "템플릿 명"</p> | |
| 216 | + <p>,<span>"templateMessageType"</span>: "BA"</p> | |
| 217 | + <p>,<span>"templateEmphasizeType"</span>: "TEXT"</p> | |
| 218 | + <p>,<span>"templateContent"</span>: "템플릿 내용 예시"</p> | |
| 219 | + <p>,<span>"templateExtra"</span>: "부가정보"</p> | |
| 220 | + <p>,<span>"templateAd"</span>: "광고성 문구"</p> | |
| 221 | + <p>,<span>"templateImageName"</span>: "template.jpg"</p> | |
| 222 | + <p>,<span>"templateImageUrl"</span>: "https://cdn.example.com/image.jpg"</p> | |
| 223 | + <p>,<span>"templateTitle"</span>: "강조 제목"</p> | |
| 224 | + <p>,<span>"templateSubtitle"</span>: "보조 문구"</p> | |
| 225 | + <p>,<span>"templateHeader"</span>: "템플릿 헤더"</p> | |
| 226 | + <p>,<span>"categoryCode"</span>: "005001"</p> | |
| 227 | + <p>,<span>"securityFlag"</span>: true</p> | |
| 228 | + <p>,<span>"inspectionStatus"</span>: "REG"</p> | |
| 229 | + <p>,<span>"createdAt"</span>: "2025-06-30 10:30:00"</p> | |
| 230 | + <p>,<span>"modifiedAt"</span>: "2025-07-01 11:00:00"</p> | |
| 231 | + <p>,<span>"status"</span>: "A"</p> | |
| 232 | + <p>,<span>"block"</span>: false</p> | |
| 233 | + <p>,<span>"dormant"</span>: false</p> | |
| 234 | + | |
| 235 | + <!-- templateItemHighlight --> | |
| 236 | + <p>,<span>"templateItemHighlight"</span>: {</p> | |
| 237 | + <div class="indent_t2"> | |
| 238 | + <p><span>"title"</span>: "하이라이트 제목"</p> | |
| 239 | + <p>,<span>"description"</span>: "하이라이트 설명"</p> | |
| 240 | + <p>,<span>"imageUrl"</span>: "https://cdn.example.com/thumb.jpg"</p> | |
| 241 | + </div> | |
| 242 | + <p>}</p> | |
| 243 | + | |
| 244 | + <!-- templateItem --> | |
| 245 | + <p>,<span>"templateItem"</span>: {</p> | |
| 246 | + <div class="indent_t2"> | |
| 247 | + <p><span>"list"</span>: [</p> | |
| 248 | + <div class="indent_t3"> | |
| 249 | + <p>{</p> | |
| 250 | + <p><span>"title"</span>: "아이템 제목"</p> | |
| 251 | + <p>,<span>"description"</span>: "아이템 설명"</p> | |
| 252 | + <p>}</p> | |
| 253 | + </div> | |
| 254 | + <p>],</p> | |
| 255 | + <p><span>"summary"</span>: {</p> | |
| 256 | + <div class="indent_t3"> | |
| 257 | + <p><span>"title"</span>: "요약 제목"</p> | |
| 258 | + <p>,<span>"description"</span>: "요약 설명"</p> | |
| 259 | + </div> | |
| 260 | + <p>}</p> | |
| 261 | + </div> | |
| 262 | + <p>}</p> | |
| 263 | + | |
| 264 | + <!-- buttons --> | |
| 265 | + <p>,<span>"buttons"</span>: [</p> | |
| 266 | + <div class="indent_t2"> | |
| 267 | + <p>{</p> | |
| 268 | + <p><span>"name"</span>: "버튼명"</p> | |
| 269 | + <p>,<span>"linkType"</span>: "WL"</p> | |
| 270 | + <p>,<span>"linkAnd"</span>: "https://aos.example.com"</p> | |
| 271 | + <p>,<span>"linkIos"</span>: "https://ios.example.com"</p> | |
| 272 | + <p>,<span>"linkMo"</span>: "https://m.example.com"</p> | |
| 273 | + <p>,<span>"linkPc"</span>: "https://www.example.com"</p> | |
| 274 | + <p>,<span>"pluginId"</span>: "plugin123"</p> | |
| 275 | + <p>}</p> | |
| 276 | + </div> | |
| 277 | + <p>]</p> | |
| 278 | + | |
| 279 | + <!-- quickReplies --> | |
| 280 | + <p>,<span>"quickReplies"</span>: [</p> | |
| 281 | + <div class="indent_t2"> | |
| 282 | + <p>{</p> | |
| 283 | + <p><span>"name"</span>: "빠른응답"</p> | |
| 284 | + <p>,<span>"linkType"</span>: "WL"</p> | |
| 285 | + <p>,<span>"linkAnd"</span>: "https://aos.quick.com"</p> | |
| 286 | + <p>,<span>"linkIos"</span>: "https://ios.quick.com"</p> | |
| 287 | + <p>,<span>"linkMo"</span>: "https://m.quick.com"</p> | |
| 288 | + <p>,<span>"linkPc"</span>: "https://www.quick.com"</p> | |
| 289 | + <p>}</p> | |
| 290 | + </div> | |
| 291 | + <p>]</p> | |
| 292 | + | |
| 293 | + <!-- comments --> | |
| 294 | + <p>,<span>"comments"</span>: [</p> | |
| 295 | + <div class="indent_t2"> | |
| 296 | + <p>{</p> | |
| 297 | + <p><span>"content"</span>: "댓글 예시입니다."</p> | |
| 298 | + <p>,<span>"createdAt"</span>: "2025-07-01 10:00:00"</p> | |
| 299 | + <p>,<span>"status"</span>: "REQ"</p> | |
| 300 | + <p>,<span>"userName"</span>: "관리자"</p> | |
| 301 | + <p>,<span>"attachment"</span>: [</p> | |
| 302 | + <div class="indent_t3"> | |
| 303 | + <p>{</p> | |
| 304 | + <p><span>"originalFileName"</span>: "example.pdf"</p> | |
| 305 | + <p>,<span>"filePath"</span>: "/download/example.pdf"</p> | |
| 306 | + <p>}</p> | |
| 307 | + </div> | |
| 308 | + <p>]</p> | |
| 309 | + <p>}</p> | |
| 310 | + </div> | |
| 311 | + <p>]</p> | |
| 312 | + </div> | |
| 313 | + <p class="l_code_t2">}</p> | |
| 314 | + <p>]</p> | |
| 315 | + </div> | |
| 316 | + <p class="l_code">}</p> | |
| 317 | + </div> | |
| 318 | + </div> | |
| 319 | + <div class="box"> | |
| 320 | + <div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div> | |
| 321 | + <div class="code_view"> | |
| 322 | + <p>{</p> | |
| 323 | + <div class="indent"> | |
| 324 | + <p><span>"resultCode"</span>:"4099"</p> | |
| 325 | + <p>,<span>"data"</span>:"기타 시스템 오류"</p> | |
| 326 | + </div> | |
| 327 | + <p class="l_code">}</p> | |
| 328 | + </div> | |
| 329 | + </div> | |
| 330 | + <!--// Response--> | |
| 331 | + </div> |
+++ src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab4.jsp
... | ... | @@ -0,0 +1,353 @@ |
| 1 | +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> | |
| 2 | + | |
| 3 | + <ul class="info"> | |
| 4 | + <li>- 전송결과 조회의 "msgGroupId"를 사용하여 전송된 문자의 상세결과를 수신번호별로 조회할 수 있습니다.</li> | |
| 5 | + <li>- 전송결과가 "대기"인 경우에는 최종 결과 확인까지 최대 72시간까지 소요됩니다.</li> | |
| 6 | + </ul> | |
| 7 | + | |
| 8 | + <div class="re_cont"> | |
| 9 | + <!--Request--> | |
| 10 | + <div class="req_title">Request</div> | |
| 11 | + <div class="box"> | |
| 12 | + <div class="text"> | |
| 13 | + <h4>Request</h4> | |
| 14 | + <table> | |
| 15 | + <caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption> | |
| 16 | + <colgroup> | |
| 17 | + <col style="width:20%;"> | |
| 18 | + <col style="width:80%;"> | |
| 19 | + </colgroup> | |
| 20 | + <tr> | |
| 21 | + <th>Http Method</th> | |
| 22 | + <td>POST</td> | |
| 23 | + </tr> | |
| 24 | + <tr> | |
| 25 | + <th>프로토콜</th> | |
| 26 | + <td>HTTP/1.1</td> | |
| 27 | + </tr> | |
| 28 | + <tr> | |
| 29 | + <th>HOST</th> | |
| 30 | + <td>api.munjaon.co.kr</td> | |
| 31 | + </tr> | |
| 32 | + <tr> | |
| 33 | + <th>Service Port</th> | |
| 34 | + <td>443</td> | |
| 35 | + </tr> | |
| 36 | + </table> | |
| 37 | + </div> | |
| 38 | + </div> | |
| 39 | + <div class="type_table"> | |
| 40 | + <table> | |
| 41 | + <caption>상세결과 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption> | |
| 42 | + <colgroup> | |
| 43 | + <col style="width:20%;"> | |
| 44 | + <col style="width:45%;"> | |
| 45 | + <col style="width:25%"> | |
| 46 | + <col style="width:10%"> | |
| 47 | + </colgroup> | |
| 48 | + <thead> | |
| 49 | + <tr> | |
| 50 | + <th>키</th> | |
| 51 | + <th>설명</th> | |
| 52 | + <th>타입</th> | |
| 53 | + <th>필수</th> | |
| 54 | + </tr> | |
| 55 | + </thead> | |
| 56 | + <tbody> | |
| 57 | + <tr> | |
| 58 | + <td><span class="font_b">mberId</span></td> | |
| 59 | + <td>사용자 ID</td> | |
| 60 | + <td>String</td> | |
| 61 | + <td><span class="select_o">O</span></td> | |
| 62 | + </tr> | |
| 63 | + <tr> | |
| 64 | + <td><span class="font_b">accessKey</span></td> | |
| 65 | + <td>인증용 API Key</td> | |
| 66 | + <td>String</td> | |
| 67 | + <td><span class="select_o">O</span></td> | |
| 68 | + </tr> | |
| 69 | + <tr> | |
| 70 | + <td><span class="font_b">msgGroupId</span></td> | |
| 71 | + <td>메시지 그룹 ID</td> | |
| 72 | + <td>String</td> | |
| 73 | + <td><span class="select_o">O</span></td> | |
| 74 | + </tr> | |
| 75 | + <tr> | |
| 76 | + <td><span class="font_b">page</span></td> | |
| 77 | + <td>페이지 번호</td> | |
| 78 | + <td>String</td> | |
| 79 | + <td><span class="select_x">X</span></td> | |
| 80 | + </tr> | |
| 81 | + <tr> | |
| 82 | + <td><span class="font_b">pageSize</span></td> | |
| 83 | + <td>페이지당 출력 개수</td> | |
| 84 | + <td>String</td> | |
| 85 | + <td><span class="select_x">X</span></td> | |
| 86 | + </tr> | |
| 87 | + <tr> | |
| 88 | + <td><span class="font_b">test_yn</span></td> | |
| 89 | + <td>테스트 데이터 여부</td> | |
| 90 | + <td>String</td> | |
| 91 | + <td><span class="select_x">X</span></td> | |
| 92 | + </tr> | |
| 93 | + </tbody> | |
| 94 | + </table> | |
| 95 | + <div class="table_info"> | |
| 96 | + <p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p> | |
| 97 | + </div> | |
| 98 | + </div> | |
| 99 | + <div class="box"> | |
| 100 | + <div class="title">[Example]</div> | |
| 101 | + <div class="code_view"> | |
| 102 | + <p>{</p> | |
| 103 | + <div class="indent"> | |
| 104 | + <p><span>"mberId"</span>:"홍길동"</p> | |
| 105 | + <p>,<span>"accessKey"</span>:"XXXXXXXXXXXXXX414050694b953"</p> | |
| 106 | + <p>,<span>"msgGroupId"</span>:"MSGGID_0000000011452"</p> | |
| 107 | + <p>,<span>"page"</span>:""</p> | |
| 108 | + <p>,<span>"pageSize"</span>:""</p> | |
| 109 | + <p>,<span>"test_yn"</span>:""</p> | |
| 110 | + </div> | |
| 111 | + <p class="l_code">}</p> | |
| 112 | + </div> | |
| 113 | + </div> | |
| 114 | + <!--// Request--> | |
| 115 | + <!-- Response--> | |
| 116 | + <div class="res_title">Response</div> | |
| 117 | + <div class="type_table"> | |
| 118 | + <table> | |
| 119 | + <caption>상세결과 조회 API Response 키 종류 및 설명, 타입 테이블</caption> | |
| 120 | + <colgroup> | |
| 121 | + <col style="width:20%;"> | |
| 122 | + <col style="width:60%;"> | |
| 123 | + <col style="width:20%;"> | |
| 124 | + </colgroup> | |
| 125 | + <thead> | |
| 126 | + <tr> | |
| 127 | + <th>키</th> | |
| 128 | + <th>설명</th> | |
| 129 | + <th>타입</th> | |
| 130 | + </tr> | |
| 131 | + </thead> | |
| 132 | + <tbody> | |
| 133 | + <tr> | |
| 134 | + <td><span class="font_b">resultCode</span></td> | |
| 135 | + <td>성공 여부("0" 아니면 실패)</td> | |
| 136 | + <td>String</td> | |
| 137 | + </tr> | |
| 138 | + <tr> | |
| 139 | + <td><span class="font_b">data</span></td> | |
| 140 | + <td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td> | |
| 141 | + <td>Object</td> | |
| 142 | + </tr> | |
| 143 | + <tr> | |
| 144 | + <td><span class="font_b">[data].message</span></td> | |
| 145 | + <td>문자</td> | |
| 146 | + <td>String</td> | |
| 147 | + </tr> | |
| 148 | + <tr> | |
| 149 | + <td><span class="font_b">[data].next_yn</span></td> | |
| 150 | + <td>다음 페이지 여부</td> | |
| 151 | + <td>String</td> | |
| 152 | + </tr> | |
| 153 | + <tr> | |
| 154 | + <td><span class="font_b">[data].objectList</span></td> | |
| 155 | + <td>결과값 목록</td> | |
| 156 | + <td>Object List</td> | |
| 157 | + </tr> | |
| 158 | + <tr> | |
| 159 | + <td><span class="font_b">[data].msgGroupId</span></td> | |
| 160 | + <td>메시지 그룹 ID</td> | |
| 161 | + <td>String</td> | |
| 162 | + </tr> | |
| 163 | + <tr> | |
| 164 | + <td><span class="font_b">[data].msgId</span></td> | |
| 165 | + <td>메시지 ID</td> | |
| 166 | + <td>String</td> | |
| 167 | + </tr> | |
| 168 | + <tr> | |
| 169 | + <td><span class="font_b">[data].msgTypeName</span></td> | |
| 170 | + <td>문자 구분명(단문, 장문, 그림)</td> | |
| 171 | + <td>String</td> | |
| 172 | + </tr> | |
| 173 | + <tr> | |
| 174 | + <td><span class="font_b">[data].msgType</span></td> | |
| 175 | + <td>메시지 타입(4 : 단문, 6 : 장문)</td> | |
| 176 | + <td>String</td> | |
| 177 | + </tr> | |
| 178 | + <tr> | |
| 179 | + <td><span class="font_b">[data].callFrom</span></td> | |
| 180 | + <td>발신자 번호</td> | |
| 181 | + <td>String</td> | |
| 182 | + </tr> | |
| 183 | + <tr> | |
| 184 | + <td><span class="font_b">[data].callTo</span></td> | |
| 185 | + <td>수신자 번호</td> | |
| 186 | + <td>String</td> | |
| 187 | + </tr> | |
| 188 | + <tr> | |
| 189 | + <td><span class="font_b">[data].msgGroupCnt</span></td> | |
| 190 | + <td>문자 발송 건수</td> | |
| 191 | + <td>String</td> | |
| 192 | + </tr> | |
| 193 | + <tr> | |
| 194 | + <td><span class="font_b">[data].sCnt</span></td> | |
| 195 | + <td>성공 건수</td> | |
| 196 | + <td>String</td> | |
| 197 | + </tr> | |
| 198 | + <tr> | |
| 199 | + <td><span class="font_b">[data].fCnt</span></td> | |
| 200 | + <td>실패 건수</td> | |
| 201 | + <td>String</td> | |
| 202 | + </tr> | |
| 203 | + <tr> | |
| 204 | + <td><span class="font_b">[data].wCnt</span></td> | |
| 205 | + <td>대기 건수</td> | |
| 206 | + <td>String</td> | |
| 207 | + </tr> | |
| 208 | + <tr> | |
| 209 | + <td><span class="font_b">[data].msgResult</span></td> | |
| 210 | + <td>발송 결과(성공 : S, 실패 : F)</td> | |
| 211 | + <td>String</td> | |
| 212 | + </tr> | |
| 213 | + <tr> | |
| 214 | + <td><span class="font_b">[data].smsTxt</span></td> | |
| 215 | + <td>문자 내용</td> | |
| 216 | + <td>String</td> | |
| 217 | + </tr> | |
| 218 | + <tr> | |
| 219 | + <td><span class="font_b">[data].subject</span></td> | |
| 220 | + <td>제목</td> | |
| 221 | + <td>String</td> | |
| 222 | + </tr> | |
| 223 | + <tr> | |
| 224 | + <td><span class="font_b">[data].reqdate</span></td> | |
| 225 | + <td>발송 일자</td> | |
| 226 | + <td>String</td> | |
| 227 | + </tr> | |
| 228 | + <tr> | |
| 229 | + <td><span class="font_b">[data].curState</span></td> | |
| 230 | + <td>전송 처리 결과값</td> | |
| 231 | + <td>String</td> | |
| 232 | + </tr> | |
| 233 | + <tr> | |
| 234 | + <td><span class="font_b">[data].userId</span></td> | |
| 235 | + <td>사용자 ID</td> | |
| 236 | + <td>String</td> | |
| 237 | + </tr> | |
| 238 | + <tr> | |
| 239 | + <td><span class="font_b">[data].regdate</span></td> | |
| 240 | + <td>등록 일자</td> | |
| 241 | + <td>String</td> | |
| 242 | + </tr> | |
| 243 | + <tr> | |
| 244 | + <td><span class="font_b">[data].reserveCYn</span></td> | |
| 245 | + <td>예약 취소 여부</td> | |
| 246 | + <td>String</td> | |
| 247 | + </tr> | |
| 248 | + <tr> | |
| 249 | + <td><span class="font_b">[data].ttlCnt</span></td> | |
| 250 | + <td>전체 요청 수</td> | |
| 251 | + <td>String</td> | |
| 252 | + </tr> | |
| 253 | + <tr> | |
| 254 | + <td><span class="font_b">[data].remainMsgCnt</span></td> | |
| 255 | + <td>남은 문자 건수</td> | |
| 256 | + <td>String</td> | |
| 257 | + </tr> | |
| 258 | + <tr> | |
| 259 | + <td><span class="font_b">[data].totMsgCnt</span></td> | |
| 260 | + <td>전체 문자 개수</td> | |
| 261 | + <td>String</td> | |
| 262 | + </tr> | |
| 263 | + </tbody> | |
| 264 | + </table> | |
| 265 | + <div class="table_info"> | |
| 266 | + <p>※ JSON 객체로 응답합니다.</p> | |
| 267 | + </div> | |
| 268 | + </div> | |
| 269 | + <div class="box"> | |
| 270 | + <div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div> | |
| 271 | + <div class="code_view"> | |
| 272 | + <p>{</p> | |
| 273 | + <div class="indent"> | |
| 274 | + <p><span>"resultCode"</span>:"0"</p> | |
| 275 | + <p>,<span>"data"</span>:[</p> | |
| 276 | + <p>{</p> | |
| 277 | + <div class="indent_t1"> | |
| 278 | + <p><span>"resultCode"</span>:"0"</p> | |
| 279 | + <p>,<span>"message"</span>: null</p> | |
| 280 | + <p>,<span>"next_yn"</span>:"n"</p> | |
| 281 | + <p>,<span>"msgGroupId"</span>:"MSGGID_0000000000000"</p> | |
| 282 | + <p>,<span>"objectList"</span>:[</p> | |
| 283 | + <p>{</p> | |
| 284 | + <div class="indent_t2"> | |
| 285 | + <p><span>"msgTypeName"</span>:"단문(SMS)"</p> | |
| 286 | + <p>,<span>"msgType"</span>:"4"</p> | |
| 287 | + <p>,<span>"callFrom"</span>:"01011112222"</p> | |
| 288 | + <p>,<span>"callTo"</span>:"01011112223"</p> | |
| 289 | + <p>,<span>"msgGroupCnt"</span>:"2"</p> | |
| 290 | + <p>,<span>"msgGroupId"</span>:"MSGGID_0000000013340"</p> | |
| 291 | + <p>,<span>"msgId"</span>:"MSGID_0000000000001"</p> | |
| 292 | + <p>,<span>"scnt"</span>:null</p> | |
| 293 | + <p>,<span>"fcnt"</span>:null</p> | |
| 294 | + <p>,<span>"wcnt"</span>:null</p> | |
| 295 | + <p>,<span>"msgResult"</span>:"S"</p> | |
| 296 | + <p>,<span>"smsTxt"</span>:"문자 내용 단문 예제"</p> | |
| 297 | + <p>,<span>"subject"</span>:null</p> | |
| 298 | + <p>,<span>"reqdate"</span>:"2023-06-13 17:48:08"</p> | |
| 299 | + <p>,<span>"curState"</span>:"3"</p> | |
| 300 | + <p>,<span>"userId"</span>:"testuser"</p> | |
| 301 | + <p>,<span>"regdate"</span>:"2023-06-13 17:48:07"</p> | |
| 302 | + <p>,<span>"reserveCYn"</span>:"N"</p> | |
| 303 | + <p>,<span>"ttlCnt"</span>:"10"</p> | |
| 304 | + <p>,<span>"remainMsgCnt"</span>:"0"</p> | |
| 305 | + <p>,<span>"totMsgCnt"</span>:"10"</p> | |
| 306 | + </div> | |
| 307 | + <p>}</p> | |
| 308 | + <p>,{</p> | |
| 309 | + <div class="indent_t2"> | |
| 310 | + <p><span>"msgTypeName"</span>:"단문(SMS)"</p> | |
| 311 | + <p>,<span>"msgType"</span>:"4"</p> | |
| 312 | + <p>,<span>"callFrom"</span>:"01011112222"</p> | |
| 313 | + <p>,<span>"callTo"</span>:"01011112223"</p> | |
| 314 | + <p>,<span>"msgGroupCnt"</span>:"2"</p> | |
| 315 | + <p>,<span>"msgGroupId"</span>:"MSGGID_0000000013340"</p> | |
| 316 | + <p>,<span>"msgId"</span>:"MSGID_0000000000002"</p> | |
| 317 | + <p>,<span>"scnt"</span>:null</p> | |
| 318 | + <p>,<span>"fcnt"</span>:null</p> | |
| 319 | + <p>,<span>"wcnt"</span>:null</p> | |
| 320 | + <p>,<span>"msgResult"</span>:"S"</p> | |
| 321 | + <p>,<span>"smsTxt"</span>:"문자 내용 단문 예제"</p> | |
| 322 | + <p>,<span>subject"</span>:null</p> | |
| 323 | + <p>,<span>reqdate"</span>:"2023-06-13 17:48:09"</p> | |
| 324 | + <p>,<span>"curState"</span>:"3"</p> | |
| 325 | + <p>,<span>"userId"</span>:"testuser"</p> | |
| 326 | + <p>,<span>"regdate"</span>:"2023-06-13 17:48:07"</p> | |
| 327 | + <p>,<span>"reserveCYn"</span>:"N"</p> | |
| 328 | + <p>,<span>"ttlCnt"</span>:"10"</p> | |
| 329 | + <p>,<span>"remainMsgCnt"</span>:"0"</p> | |
| 330 | + <p>,<span>"totMsgCnt"</span>:"10"</p> | |
| 331 | + <p>}</p> | |
| 332 | + </div> | |
| 333 | + <p>]</p> | |
| 334 | + </div> | |
| 335 | + <p class="l_code_t2">}</p> | |
| 336 | + <p>]</p> | |
| 337 | + </div> | |
| 338 | + <p class="l_code">}</p> | |
| 339 | + </div> | |
| 340 | + </div> | |
| 341 | + <div class="box"> | |
| 342 | + <div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div> | |
| 343 | + <div class="code_view"> | |
| 344 | + <p>{</p> | |
| 345 | + <div class="indent"> | |
| 346 | + <p><span>"resultCode"</span>:"4099"</p> | |
| 347 | + <p>,<span>"data"</span>:"기타 시스템 오류"</p> | |
| 348 | + </div> | |
| 349 | + <p class="l_code">}</p> | |
| 350 | + </div> | |
| 351 | + </div> | |
| 352 | + <!--// Response--> | |
| 353 | + </div> |
+++ src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab5.jsp
... | ... | @@ -0,0 +1,195 @@ |
| 1 | +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> | |
| 2 | + | |
| 3 | + <ul class="info"> | |
| 4 | + <li>- 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.</li> | |
| 5 | + <li>- 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.</li> | |
| 6 | + </ul> | |
| 7 | + | |
| 8 | + <div class="re_cont"> | |
| 9 | + <!--Request--> | |
| 10 | + <div class="req_title">Request</div> | |
| 11 | + <div class="box"> | |
| 12 | + <div class="text"> | |
| 13 | + <h4>Request</h4> | |
| 14 | + <table> | |
| 15 | + <caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption> | |
| 16 | + <colgroup> | |
| 17 | + <col style="width:20%;"> | |
| 18 | + <col style="width:80%;"> | |
| 19 | + </colgroup> | |
| 20 | + <tr> | |
| 21 | + <th>Http Method</th> | |
| 22 | + <td>POST</td> | |
| 23 | + </tr> | |
| 24 | + <tr> | |
| 25 | + <th>프로토콜</th> | |
| 26 | + <td>HTTP/1.1</td> | |
| 27 | + </tr> | |
| 28 | + <tr> | |
| 29 | + <th>HOST</th> | |
| 30 | + <td>api.munjaon.co.kr</td> | |
| 31 | + </tr> | |
| 32 | + <tr> | |
| 33 | + <th>Service Port</th> | |
| 34 | + <td>443</td> | |
| 35 | + </tr> | |
| 36 | + </table> | |
| 37 | + </div> | |
| 38 | + </div> | |
| 39 | + <div class="type_table"> | |
| 40 | + <table> | |
| 41 | + <caption>발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption> | |
| 42 | + <colgroup> | |
| 43 | + <col style="width:20%;"> | |
| 44 | + <col style="width:45%;"> | |
| 45 | + <col style="width:25%"> | |
| 46 | + <col style="width:10%"> | |
| 47 | + </colgroup> | |
| 48 | + <thead> | |
| 49 | + <tr> | |
| 50 | + <th>키</th> | |
| 51 | + <th>설명</th> | |
| 52 | + <th>타입</th> | |
| 53 | + <th>필수</th> | |
| 54 | + </tr> | |
| 55 | + </thead> | |
| 56 | + <tbody> | |
| 57 | + <tr> | |
| 58 | + <td><span class="font_b">mberId</span></td> | |
| 59 | + <td>사용자 ID</td> | |
| 60 | + <td>String</td> | |
| 61 | + <td><span class="select_o">O</span></td> | |
| 62 | + </tr> | |
| 63 | + <tr> | |
| 64 | + <td><span class="font_b">accessKey</span></td> | |
| 65 | + <td>인증용 API Key</td> | |
| 66 | + <td>String</td> | |
| 67 | + <td><span class="select_o">O</span></td> | |
| 68 | + </tr> | |
| 69 | + </tbody> | |
| 70 | + </table> | |
| 71 | + <div class="table_info"> | |
| 72 | + <p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p> | |
| 73 | + </div> | |
| 74 | + </div> | |
| 75 | + <div class="box"> | |
| 76 | + <div class="title">[Example]</div> | |
| 77 | + <div class="code_view"> | |
| 78 | + <p>{</p> | |
| 79 | + <div class="indent"> | |
| 80 | + <p><span>"mberId"</span>:"String"</p> | |
| 81 | + <p>,<span>"accessKey"</span>:"String"</p> | |
| 82 | + </div> | |
| 83 | + <p class="l_code">}</p> | |
| 84 | + </div> | |
| 85 | + </div> | |
| 86 | + <!--// Request--> | |
| 87 | + <!-- Response--> | |
| 88 | + <div class="res_title">Response</div> | |
| 89 | + <div class="type_table"> | |
| 90 | + <table> | |
| 91 | + <caption>발송가능 건수 API Response 키 종류 및 설명, 타입 테이블</caption> | |
| 92 | + <colgroup> | |
| 93 | + <col style="width:20%;"> | |
| 94 | + <col style="width:60%;"> | |
| 95 | + <col style="width:20%;"> | |
| 96 | + </colgroup> | |
| 97 | + <thead> | |
| 98 | + <tr> | |
| 99 | + <th>키</th> | |
| 100 | + <th>설명</th> | |
| 101 | + <th>타입</th> | |
| 102 | + </tr> | |
| 103 | + </thead> | |
| 104 | + <tbody> | |
| 105 | + <tr> | |
| 106 | + <td><span class="font_b">resultCode</span></td> | |
| 107 | + <td>성공 여부("0" 아니면 실패)</td> | |
| 108 | + <td>String</td> | |
| 109 | + </tr> | |
| 110 | + <tr> | |
| 111 | + <td><span class="font_b">data</span></td> | |
| 112 | + <td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td> | |
| 113 | + <td>Object</td> | |
| 114 | + </tr> | |
| 115 | + <tr> | |
| 116 | + <td><span class="font_b">[data].longPrice</span></td> | |
| 117 | + <td>장문 단가</td> | |
| 118 | + <td>String</td> | |
| 119 | + </tr> | |
| 120 | + <tr> | |
| 121 | + <td><span class="font_b">[data].longSendPsbltEa</span></td> | |
| 122 | + <td>장문 발송 가능 건수</td> | |
| 123 | + <td>String</td> | |
| 124 | + </tr> | |
| 125 | + <tr> | |
| 126 | + <td><span class="font_b">[data].mberMoney</span></td> | |
| 127 | + <td>현재 보유 금액</td> | |
| 128 | + <td>String</td> | |
| 129 | + </tr> | |
| 130 | + <tr> | |
| 131 | + <td><span class="font_b">[data].message</span></td> | |
| 132 | + <td>문자</td> | |
| 133 | + <td>String</td> | |
| 134 | + </tr> | |
| 135 | + <tr> | |
| 136 | + <td><span class="font_b">[data].picturePrice</span></td> | |
| 137 | + <td>그림문자 단가</td> | |
| 138 | + <td>String</td> | |
| 139 | + </tr> | |
| 140 | + <tr> | |
| 141 | + <td><span class="font_b">[data].pictureSendPsbltEa</span></td> | |
| 142 | + <td>그림문자 발송 가능 건수</td> | |
| 143 | + <td>String</td> | |
| 144 | + </tr> | |
| 145 | + <tr> | |
| 146 | + <td><span class="font_b">[data].shortPrice</span></td> | |
| 147 | + <td>단문 단가</td> | |
| 148 | + <td>String</td> | |
| 149 | + </tr> | |
| 150 | + <tr> | |
| 151 | + <td><span class="font_b">[data].shortSendPsbltEa</span></td> | |
| 152 | + <td>단문 발송 가능 건수</td> | |
| 153 | + <td>String</td> | |
| 154 | + </tr> | |
| 155 | + </tbody> | |
| 156 | + </table> | |
| 157 | + <div class="table_info"> | |
| 158 | + <p>※ JSON 객체로 응답합니다.</p> | |
| 159 | + </div> | |
| 160 | + </div> | |
| 161 | + <div class="box"> | |
| 162 | + <div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div> | |
| 163 | + <div class="code_view"> | |
| 164 | + <p>{</p> | |
| 165 | + <div class="indent"> | |
| 166 | + <p><span>"resultCode"</span>:"0"</p> | |
| 167 | + <p>,<span>"data"</span>{</p> | |
| 168 | + <div class="indent_t1"> | |
| 169 | + <p><span>"longPrice"</span>:"50"</p> | |
| 170 | + <p>,<span>"longSendPsbltEa"</span>:"19651"</p> | |
| 171 | + <p>,<span>"mberMoney"</span>:"982586.7"</p> | |
| 172 | + <p>,<span>"message"</span>:null</p> | |
| 173 | + <p>,<span>"picturePrice"</span>:"90"</p> | |
| 174 | + <p>,<span>"pictureSendPsbltEa"</span>:"10917"</p> | |
| 175 | + <p>,<span>"shortPrice"</span>:"18"</p> | |
| 176 | + <p>,<span>"shortSendPsbltEa"</span>:"54588"</p> | |
| 177 | + </div> | |
| 178 | + <p>}</p> | |
| 179 | + </div> | |
| 180 | + <p class="l_code">}</p> | |
| 181 | + </div> | |
| 182 | + </div> | |
| 183 | + <div class="box"> | |
| 184 | + <div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div> | |
| 185 | + <div class="code_view"> | |
| 186 | + <p>{</p> | |
| 187 | + <div class="indent"> | |
| 188 | + <p><span>"resultCode"</span>:"5099"</p> | |
| 189 | + <p>,<span>"data"</span>:"기타 시스템 오류"</p> | |
| 190 | + </div> | |
| 191 | + <p class="l_code">}</p> | |
| 192 | + </div> | |
| 193 | + </div> | |
| 194 | + <!--// Response--> | |
| 195 | + </div> |
+++ src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab6.jsp
... | ... | @@ -0,0 +1,195 @@ |
| 1 | +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> | |
| 2 | + | |
| 3 | + <ul class="info"> | |
| 4 | + <li>- 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.</li> | |
| 5 | + <li>- 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.</li> | |
| 6 | + </ul> | |
| 7 | + | |
| 8 | + <div class="re_cont"> | |
| 9 | + <!--Request--> | |
| 10 | + <div class="req_title">Request</div> | |
| 11 | + <div class="box"> | |
| 12 | + <div class="text"> | |
| 13 | + <h4>Request</h4> | |
| 14 | + <table> | |
| 15 | + <caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption> | |
| 16 | + <colgroup> | |
| 17 | + <col style="width:20%;"> | |
| 18 | + <col style="width:80%;"> | |
| 19 | + </colgroup> | |
| 20 | + <tr> | |
| 21 | + <th>Http Method</th> | |
| 22 | + <td>POST</td> | |
| 23 | + </tr> | |
| 24 | + <tr> | |
| 25 | + <th>프로토콜</th> | |
| 26 | + <td>HTTP/1.1</td> | |
| 27 | + </tr> | |
| 28 | + <tr> | |
| 29 | + <th>HOST</th> | |
| 30 | + <td>api.munjaon.co.kr</td> | |
| 31 | + </tr> | |
| 32 | + <tr> | |
| 33 | + <th>Service Port</th> | |
| 34 | + <td>443</td> | |
| 35 | + </tr> | |
| 36 | + </table> | |
| 37 | + </div> | |
| 38 | + </div> | |
| 39 | + <div class="type_table"> | |
| 40 | + <table> | |
| 41 | + <caption>발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption> | |
| 42 | + <colgroup> | |
| 43 | + <col style="width:20%;"> | |
| 44 | + <col style="width:45%;"> | |
| 45 | + <col style="width:25%"> | |
| 46 | + <col style="width:10%"> | |
| 47 | + </colgroup> | |
| 48 | + <thead> | |
| 49 | + <tr> | |
| 50 | + <th>키</th> | |
| 51 | + <th>설명</th> | |
| 52 | + <th>타입</th> | |
| 53 | + <th>필수</th> | |
| 54 | + </tr> | |
| 55 | + </thead> | |
| 56 | + <tbody> | |
| 57 | + <tr> | |
| 58 | + <td><span class="font_b">mberId</span></td> | |
| 59 | + <td>사용자 ID</td> | |
| 60 | + <td>String</td> | |
| 61 | + <td><span class="select_o">O</span></td> | |
| 62 | + </tr> | |
| 63 | + <tr> | |
| 64 | + <td><span class="font_b">accessKey</span></td> | |
| 65 | + <td>인증용 API Key</td> | |
| 66 | + <td>String</td> | |
| 67 | + <td><span class="select_o">O</span></td> | |
| 68 | + </tr> | |
| 69 | + </tbody> | |
| 70 | + </table> | |
| 71 | + <div class="table_info"> | |
| 72 | + <p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p> | |
| 73 | + </div> | |
| 74 | + </div> | |
| 75 | + <div class="box"> | |
| 76 | + <div class="title">[Example]</div> | |
| 77 | + <div class="code_view"> | |
| 78 | + <p>{</p> | |
| 79 | + <div class="indent"> | |
| 80 | + <p><span>"mberId"</span>:"String"</p> | |
| 81 | + <p>,<span>"accessKey"</span>:"String"</p> | |
| 82 | + </div> | |
| 83 | + <p class="l_code">}</p> | |
| 84 | + </div> | |
| 85 | + </div> | |
| 86 | + <!--// Request--> | |
| 87 | + <!-- Response--> | |
| 88 | + <div class="res_title">Response</div> | |
| 89 | + <div class="type_table"> | |
| 90 | + <table> | |
| 91 | + <caption>발송가능 건수 API Response 키 종류 및 설명, 타입 테이블</caption> | |
| 92 | + <colgroup> | |
| 93 | + <col style="width:20%;"> | |
| 94 | + <col style="width:60%;"> | |
| 95 | + <col style="width:20%;"> | |
| 96 | + </colgroup> | |
| 97 | + <thead> | |
| 98 | + <tr> | |
| 99 | + <th>키</th> | |
| 100 | + <th>설명</th> | |
| 101 | + <th>타입</th> | |
| 102 | + </tr> | |
| 103 | + </thead> | |
| 104 | + <tbody> | |
| 105 | + <tr> | |
| 106 | + <td><span class="font_b">resultCode</span></td> | |
| 107 | + <td>성공 여부("0" 아니면 실패)</td> | |
| 108 | + <td>String</td> | |
| 109 | + </tr> | |
| 110 | + <tr> | |
| 111 | + <td><span class="font_b">data</span></td> | |
| 112 | + <td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td> | |
| 113 | + <td>Object</td> | |
| 114 | + </tr> | |
| 115 | + <tr> | |
| 116 | + <td><span class="font_b">[data].longPrice</span></td> | |
| 117 | + <td>장문 단가</td> | |
| 118 | + <td>String</td> | |
| 119 | + </tr> | |
| 120 | + <tr> | |
| 121 | + <td><span class="font_b">[data].longSendPsbltEa</span></td> | |
| 122 | + <td>장문 발송 가능 건수</td> | |
| 123 | + <td>String</td> | |
| 124 | + </tr> | |
| 125 | + <tr> | |
| 126 | + <td><span class="font_b">[data].mberMoney</span></td> | |
| 127 | + <td>현재 보유 금액</td> | |
| 128 | + <td>String</td> | |
| 129 | + </tr> | |
| 130 | + <tr> | |
| 131 | + <td><span class="font_b">[data].message</span></td> | |
| 132 | + <td>문자</td> | |
| 133 | + <td>String</td> | |
| 134 | + </tr> | |
| 135 | + <tr> | |
| 136 | + <td><span class="font_b">[data].picturePrice</span></td> | |
| 137 | + <td>그림문자 단가</td> | |
| 138 | + <td>String</td> | |
| 139 | + </tr> | |
| 140 | + <tr> | |
| 141 | + <td><span class="font_b">[data].pictureSendPsbltEa</span></td> | |
| 142 | + <td>그림문자 발송 가능 건수</td> | |
| 143 | + <td>String</td> | |
| 144 | + </tr> | |
| 145 | + <tr> | |
| 146 | + <td><span class="font_b">[data].shortPrice</span></td> | |
| 147 | + <td>단문 단가</td> | |
| 148 | + <td>String</td> | |
| 149 | + </tr> | |
| 150 | + <tr> | |
| 151 | + <td><span class="font_b">[data].shortSendPsbltEa</span></td> | |
| 152 | + <td>단문 발송 가능 건수</td> | |
| 153 | + <td>String</td> | |
| 154 | + </tr> | |
| 155 | + </tbody> | |
| 156 | + </table> | |
| 157 | + <div class="table_info"> | |
| 158 | + <p>※ JSON 객체로 응답합니다.</p> | |
| 159 | + </div> | |
| 160 | + </div> | |
| 161 | + <div class="box"> | |
| 162 | + <div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div> | |
| 163 | + <div class="code_view"> | |
| 164 | + <p>{</p> | |
| 165 | + <div class="indent"> | |
| 166 | + <p><span>"resultCode"</span>:"0"</p> | |
| 167 | + <p>,<span>"data"</span>{</p> | |
| 168 | + <div class="indent_t1"> | |
| 169 | + <p><span>"longPrice"</span>:"50"</p> | |
| 170 | + <p>,<span>"longSendPsbltEa"</span>:"19651"</p> | |
| 171 | + <p>,<span>"mberMoney"</span>:"982586.7"</p> | |
| 172 | + <p>,<span>"message"</span>:null</p> | |
| 173 | + <p>,<span>"picturePrice"</span>:"90"</p> | |
| 174 | + <p>,<span>"pictureSendPsbltEa"</span>:"10917"</p> | |
| 175 | + <p>,<span>"shortPrice"</span>:"18"</p> | |
| 176 | + <p>,<span>"shortSendPsbltEa"</span>:"54588"</p> | |
| 177 | + </div> | |
| 178 | + <p>}</p> | |
| 179 | + </div> | |
| 180 | + <p class="l_code">}</p> | |
| 181 | + </div> | |
| 182 | + </div> | |
| 183 | + <div class="box"> | |
| 184 | + <div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div> | |
| 185 | + <div class="code_view"> | |
| 186 | + <p>{</p> | |
| 187 | + <div class="indent"> | |
| 188 | + <p><span>"resultCode"</span>:"5099"</p> | |
| 189 | + <p>,<span>"data"</span>:"기타 시스템 오류"</p> | |
| 190 | + </div> | |
| 191 | + <p class="l_code">}</p> | |
| 192 | + </div> | |
| 193 | + </div> | |
| 194 | + <!--// Response--> | |
| 195 | + </div> |
+++ src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab7.jsp
... | ... | @@ -0,0 +1,195 @@ |
| 1 | +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> | |
| 2 | + | |
| 3 | + <ul class="info"> | |
| 4 | + <li>- 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.</li> | |
| 5 | + <li>- 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.</li> | |
| 6 | + </ul> | |
| 7 | + | |
| 8 | + <div class="re_cont"> | |
| 9 | + <!--Request--> | |
| 10 | + <div class="req_title">Request</div> | |
| 11 | + <div class="box"> | |
| 12 | + <div class="text"> | |
| 13 | + <h4>Request</h4> | |
| 14 | + <table> | |
| 15 | + <caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption> | |
| 16 | + <colgroup> | |
| 17 | + <col style="width:20%;"> | |
| 18 | + <col style="width:80%;"> | |
| 19 | + </colgroup> | |
| 20 | + <tr> | |
| 21 | + <th>Http Method</th> | |
| 22 | + <td>POST</td> | |
| 23 | + </tr> | |
| 24 | + <tr> | |
| 25 | + <th>프로토콜</th> | |
| 26 | + <td>HTTP/1.1</td> | |
| 27 | + </tr> | |
| 28 | + <tr> | |
| 29 | + <th>HOST</th> | |
| 30 | + <td>api.munjaon.co.kr</td> | |
| 31 | + </tr> | |
| 32 | + <tr> | |
| 33 | + <th>Service Port</th> | |
| 34 | + <td>443</td> | |
| 35 | + </tr> | |
| 36 | + </table> | |
| 37 | + </div> | |
| 38 | + </div> | |
| 39 | + <div class="type_table"> | |
| 40 | + <table> | |
| 41 | + <caption>발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption> | |
| 42 | + <colgroup> | |
| 43 | + <col style="width:20%;"> | |
| 44 | + <col style="width:45%;"> | |
| 45 | + <col style="width:25%"> | |
| 46 | + <col style="width:10%"> | |
| 47 | + </colgroup> | |
| 48 | + <thead> | |
| 49 | + <tr> | |
| 50 | + <th>키</th> | |
| 51 | + <th>설명</th> | |
| 52 | + <th>타입</th> | |
| 53 | + <th>필수</th> | |
| 54 | + </tr> | |
| 55 | + </thead> | |
| 56 | + <tbody> | |
| 57 | + <tr> | |
| 58 | + <td><span class="font_b">mberId</span></td> | |
| 59 | + <td>사용자 ID</td> | |
| 60 | + <td>String</td> | |
| 61 | + <td><span class="select_o">O</span></td> | |
| 62 | + </tr> | |
| 63 | + <tr> | |
| 64 | + <td><span class="font_b">accessKey</span></td> | |
| 65 | + <td>인증용 API Key</td> | |
| 66 | + <td>String</td> | |
| 67 | + <td><span class="select_o">O</span></td> | |
| 68 | + </tr> | |
| 69 | + </tbody> | |
| 70 | + </table> | |
| 71 | + <div class="table_info"> | |
| 72 | + <p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p> | |
| 73 | + </div> | |
| 74 | + </div> | |
| 75 | + <div class="box"> | |
| 76 | + <div class="title">[Example]</div> | |
| 77 | + <div class="code_view"> | |
| 78 | + <p>{</p> | |
| 79 | + <div class="indent"> | |
| 80 | + <p><span>"mberId"</span>:"String"</p> | |
| 81 | + <p>,<span>"accessKey"</span>:"String"</p> | |
| 82 | + </div> | |
| 83 | + <p class="l_code">}</p> | |
| 84 | + </div> | |
| 85 | + </div> | |
| 86 | + <!--// Request--> | |
| 87 | + <!-- Response--> | |
| 88 | + <div class="res_title">Response</div> | |
| 89 | + <div class="type_table"> | |
| 90 | + <table> | |
| 91 | + <caption>발송가능 건수 API Response 키 종류 및 설명, 타입 테이블</caption> | |
| 92 | + <colgroup> | |
| 93 | + <col style="width:20%;"> | |
| 94 | + <col style="width:60%;"> | |
| 95 | + <col style="width:20%;"> | |
| 96 | + </colgroup> | |
| 97 | + <thead> | |
| 98 | + <tr> | |
| 99 | + <th>키</th> | |
| 100 | + <th>설명</th> | |
| 101 | + <th>타입</th> | |
| 102 | + </tr> | |
| 103 | + </thead> | |
| 104 | + <tbody> | |
| 105 | + <tr> | |
| 106 | + <td><span class="font_b">resultCode</span></td> | |
| 107 | + <td>성공 여부("0" 아니면 실패)</td> | |
| 108 | + <td>String</td> | |
| 109 | + </tr> | |
| 110 | + <tr> | |
| 111 | + <td><span class="font_b">data</span></td> | |
| 112 | + <td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td> | |
| 113 | + <td>Object</td> | |
| 114 | + </tr> | |
| 115 | + <tr> | |
| 116 | + <td><span class="font_b">[data].longPrice</span></td> | |
| 117 | + <td>장문 단가</td> | |
| 118 | + <td>String</td> | |
| 119 | + </tr> | |
| 120 | + <tr> | |
| 121 | + <td><span class="font_b">[data].longSendPsbltEa</span></td> | |
| 122 | + <td>장문 발송 가능 건수</td> | |
| 123 | + <td>String</td> | |
| 124 | + </tr> | |
| 125 | + <tr> | |
| 126 | + <td><span class="font_b">[data].mberMoney</span></td> | |
| 127 | + <td>현재 보유 금액</td> | |
| 128 | + <td>String</td> | |
| 129 | + </tr> | |
| 130 | + <tr> | |
| 131 | + <td><span class="font_b">[data].message</span></td> | |
| 132 | + <td>문자</td> | |
| 133 | + <td>String</td> | |
| 134 | + </tr> | |
| 135 | + <tr> | |
| 136 | + <td><span class="font_b">[data].picturePrice</span></td> | |
| 137 | + <td>그림문자 단가</td> | |
| 138 | + <td>String</td> | |
| 139 | + </tr> | |
| 140 | + <tr> | |
| 141 | + <td><span class="font_b">[data].pictureSendPsbltEa</span></td> | |
| 142 | + <td>그림문자 발송 가능 건수</td> | |
| 143 | + <td>String</td> | |
| 144 | + </tr> | |
| 145 | + <tr> | |
| 146 | + <td><span class="font_b">[data].shortPrice</span></td> | |
| 147 | + <td>단문 단가</td> | |
| 148 | + <td>String</td> | |
| 149 | + </tr> | |
| 150 | + <tr> | |
| 151 | + <td><span class="font_b">[data].shortSendPsbltEa</span></td> | |
| 152 | + <td>단문 발송 가능 건수</td> | |
| 153 | + <td>String</td> | |
| 154 | + </tr> | |
| 155 | + </tbody> | |
| 156 | + </table> | |
| 157 | + <div class="table_info"> | |
| 158 | + <p>※ JSON 객체로 응답합니다.</p> | |
| 159 | + </div> | |
| 160 | + </div> | |
| 161 | + <div class="box"> | |
| 162 | + <div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div> | |
| 163 | + <div class="code_view"> | |
| 164 | + <p>{</p> | |
| 165 | + <div class="indent"> | |
| 166 | + <p><span>"resultCode"</span>:"0"</p> | |
| 167 | + <p>,<span>"data"</span>{</p> | |
| 168 | + <div class="indent_t1"> | |
| 169 | + <p><span>"longPrice"</span>:"50"</p> | |
| 170 | + <p>,<span>"longSendPsbltEa"</span>:"19651"</p> | |
| 171 | + <p>,<span>"mberMoney"</span>:"982586.7"</p> | |
| 172 | + <p>,<span>"message"</span>:null</p> | |
| 173 | + <p>,<span>"picturePrice"</span>:"90"</p> | |
| 174 | + <p>,<span>"pictureSendPsbltEa"</span>:"10917"</p> | |
| 175 | + <p>,<span>"shortPrice"</span>:"18"</p> | |
| 176 | + <p>,<span>"shortSendPsbltEa"</span>:"54588"</p> | |
| 177 | + </div> | |
| 178 | + <p>}</p> | |
| 179 | + </div> | |
| 180 | + <p class="l_code">}</p> | |
| 181 | + </div> | |
| 182 | + </div> | |
| 183 | + <div class="box"> | |
| 184 | + <div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div> | |
| 185 | + <div class="code_view"> | |
| 186 | + <p>{</p> | |
| 187 | + <div class="indent"> | |
| 188 | + <p><span>"resultCode"</span>:"5099"</p> | |
| 189 | + <p>,<span>"data"</span>:"기타 시스템 오류"</p> | |
| 190 | + </div> | |
| 191 | + <p class="l_code">}</p> | |
| 192 | + </div> | |
| 193 | + </div> | |
| 194 | + <!--// Response--> | |
| 195 | + </div> |
+++ src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab8.jsp
... | ... | @@ -0,0 +1,195 @@ |
| 1 | +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> | |
| 2 | + | |
| 3 | + <ul class="info"> | |
| 4 | + <li>- 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.</li> | |
| 5 | + <li>- 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.</li> | |
| 6 | + </ul> | |
| 7 | + | |
| 8 | + <div class="re_cont"> | |
| 9 | + <!--Request--> | |
| 10 | + <div class="req_title">Request</div> | |
| 11 | + <div class="box"> | |
| 12 | + <div class="text"> | |
| 13 | + <h4>Request</h4> | |
| 14 | + <table> | |
| 15 | + <caption>API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블</caption> | |
| 16 | + <colgroup> | |
| 17 | + <col style="width:20%;"> | |
| 18 | + <col style="width:80%;"> | |
| 19 | + </colgroup> | |
| 20 | + <tr> | |
| 21 | + <th>Http Method</th> | |
| 22 | + <td>POST</td> | |
| 23 | + </tr> | |
| 24 | + <tr> | |
| 25 | + <th>프로토콜</th> | |
| 26 | + <td>HTTP/1.1</td> | |
| 27 | + </tr> | |
| 28 | + <tr> | |
| 29 | + <th>HOST</th> | |
| 30 | + <td>api.munjaon.co.kr</td> | |
| 31 | + </tr> | |
| 32 | + <tr> | |
| 33 | + <th>Service Port</th> | |
| 34 | + <td>443</td> | |
| 35 | + </tr> | |
| 36 | + </table> | |
| 37 | + </div> | |
| 38 | + </div> | |
| 39 | + <div class="type_table"> | |
| 40 | + <table> | |
| 41 | + <caption>발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블</caption> | |
| 42 | + <colgroup> | |
| 43 | + <col style="width:20%;"> | |
| 44 | + <col style="width:45%;"> | |
| 45 | + <col style="width:25%"> | |
| 46 | + <col style="width:10%"> | |
| 47 | + </colgroup> | |
| 48 | + <thead> | |
| 49 | + <tr> | |
| 50 | + <th>키</th> | |
| 51 | + <th>설명</th> | |
| 52 | + <th>타입</th> | |
| 53 | + <th>필수</th> | |
| 54 | + </tr> | |
| 55 | + </thead> | |
| 56 | + <tbody> | |
| 57 | + <tr> | |
| 58 | + <td><span class="font_b">mberId</span></td> | |
| 59 | + <td>사용자 ID</td> | |
| 60 | + <td>String</td> | |
| 61 | + <td><span class="select_o">O</span></td> | |
| 62 | + </tr> | |
| 63 | + <tr> | |
| 64 | + <td><span class="font_b">accessKey</span></td> | |
| 65 | + <td>인증용 API Key</td> | |
| 66 | + <td>String</td> | |
| 67 | + <td><span class="select_o">O</span></td> | |
| 68 | + </tr> | |
| 69 | + </tbody> | |
| 70 | + </table> | |
| 71 | + <div class="table_info"> | |
| 72 | + <p>※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.</p> | |
| 73 | + </div> | |
| 74 | + </div> | |
| 75 | + <div class="box"> | |
| 76 | + <div class="title">[Example]</div> | |
| 77 | + <div class="code_view"> | |
| 78 | + <p>{</p> | |
| 79 | + <div class="indent"> | |
| 80 | + <p><span>"mberId"</span>:"String"</p> | |
| 81 | + <p>,<span>"accessKey"</span>:"String"</p> | |
| 82 | + </div> | |
| 83 | + <p class="l_code">}</p> | |
| 84 | + </div> | |
| 85 | + </div> | |
| 86 | + <!--// Request--> | |
| 87 | + <!-- Response--> | |
| 88 | + <div class="res_title">Response</div> | |
| 89 | + <div class="type_table"> | |
| 90 | + <table> | |
| 91 | + <caption>발송가능 건수 API Response 키 종류 및 설명, 타입 테이블</caption> | |
| 92 | + <colgroup> | |
| 93 | + <col style="width:20%;"> | |
| 94 | + <col style="width:60%;"> | |
| 95 | + <col style="width:20%;"> | |
| 96 | + </colgroup> | |
| 97 | + <thead> | |
| 98 | + <tr> | |
| 99 | + <th>키</th> | |
| 100 | + <th>설명</th> | |
| 101 | + <th>타입</th> | |
| 102 | + </tr> | |
| 103 | + </thead> | |
| 104 | + <tbody> | |
| 105 | + <tr> | |
| 106 | + <td><span class="font_b">resultCode</span></td> | |
| 107 | + <td>성공 여부("0" 아니면 실패)</td> | |
| 108 | + <td>String</td> | |
| 109 | + </tr> | |
| 110 | + <tr> | |
| 111 | + <td><span class="font_b">data</span></td> | |
| 112 | + <td>결과값 객체(성공 : 데이터, 실패 : 메시지)</td> | |
| 113 | + <td>Object</td> | |
| 114 | + </tr> | |
| 115 | + <tr> | |
| 116 | + <td><span class="font_b">[data].longPrice</span></td> | |
| 117 | + <td>장문 단가</td> | |
| 118 | + <td>String</td> | |
| 119 | + </tr> | |
| 120 | + <tr> | |
| 121 | + <td><span class="font_b">[data].longSendPsbltEa</span></td> | |
| 122 | + <td>장문 발송 가능 건수</td> | |
| 123 | + <td>String</td> | |
| 124 | + </tr> | |
| 125 | + <tr> | |
| 126 | + <td><span class="font_b">[data].mberMoney</span></td> | |
| 127 | + <td>현재 보유 금액</td> | |
| 128 | + <td>String</td> | |
| 129 | + </tr> | |
| 130 | + <tr> | |
| 131 | + <td><span class="font_b">[data].message</span></td> | |
| 132 | + <td>문자</td> | |
| 133 | + <td>String</td> | |
| 134 | + </tr> | |
| 135 | + <tr> | |
| 136 | + <td><span class="font_b">[data].picturePrice</span></td> | |
| 137 | + <td>그림문자 단가</td> | |
| 138 | + <td>String</td> | |
| 139 | + </tr> | |
| 140 | + <tr> | |
| 141 | + <td><span class="font_b">[data].pictureSendPsbltEa</span></td> | |
| 142 | + <td>그림문자 발송 가능 건수</td> | |
| 143 | + <td>String</td> | |
| 144 | + </tr> | |
| 145 | + <tr> | |
| 146 | + <td><span class="font_b">[data].shortPrice</span></td> | |
| 147 | + <td>단문 단가</td> | |
| 148 | + <td>String</td> | |
| 149 | + </tr> | |
| 150 | + <tr> | |
| 151 | + <td><span class="font_b">[data].shortSendPsbltEa</span></td> | |
| 152 | + <td>단문 발송 가능 건수</td> | |
| 153 | + <td>String</td> | |
| 154 | + </tr> | |
| 155 | + </tbody> | |
| 156 | + </table> | |
| 157 | + <div class="table_info"> | |
| 158 | + <p>※ JSON 객체로 응답합니다.</p> | |
| 159 | + </div> | |
| 160 | + </div> | |
| 161 | + <div class="box"> | |
| 162 | + <div class="title_t1"><span class="ex">[Example]</span><span class="ex_success">O 성공 예시</span></div> | |
| 163 | + <div class="code_view"> | |
| 164 | + <p>{</p> | |
| 165 | + <div class="indent"> | |
| 166 | + <p><span>"resultCode"</span>:"0"</p> | |
| 167 | + <p>,<span>"data"</span>{</p> | |
| 168 | + <div class="indent_t1"> | |
| 169 | + <p><span>"longPrice"</span>:"50"</p> | |
| 170 | + <p>,<span>"longSendPsbltEa"</span>:"19651"</p> | |
| 171 | + <p>,<span>"mberMoney"</span>:"982586.7"</p> | |
| 172 | + <p>,<span>"message"</span>:null</p> | |
| 173 | + <p>,<span>"picturePrice"</span>:"90"</p> | |
| 174 | + <p>,<span>"pictureSendPsbltEa"</span>:"10917"</p> | |
| 175 | + <p>,<span>"shortPrice"</span>:"18"</p> | |
| 176 | + <p>,<span>"shortSendPsbltEa"</span>:"54588"</p> | |
| 177 | + </div> | |
| 178 | + <p>}</p> | |
| 179 | + </div> | |
| 180 | + <p class="l_code">}</p> | |
| 181 | + </div> | |
| 182 | + </div> | |
| 183 | + <div class="box"> | |
| 184 | + <div class="title_t1"><span class="ex">[Example]</span><span class="ex_fail">X 실패 예시</span></div> | |
| 185 | + <div class="code_view"> | |
| 186 | + <p>{</p> | |
| 187 | + <div class="indent"> | |
| 188 | + <p><span>"resultCode"</span>:"5099"</p> | |
| 189 | + <p>,<span>"data"</span>:"기타 시스템 오류"</p> | |
| 190 | + </div> | |
| 191 | + <p class="l_code">}</p> | |
| 192 | + </div> | |
| 193 | + </div> | |
| 194 | + <!--// Response--> | |
| 195 | + </div> |
Add a comment
Delete comment
Once you delete this comment, you won't be able to recover it. Are you sure you want to delete this comment?