이지우 - 사용자 REST API 설명 > 전송내역조회 탭 수정
This commit is contained in:
jiwoo
parent
796a193649
commit
424ab64869
@ -13,7 +13,9 @@
|
|||||||
</br>
|
</br>
|
||||||
</br>
|
</br>
|
||||||
|
|
||||||
|
<p class="tType1_title">
|
||||||
|
<img src="/publish/images/content/icon_fee1.png" alt="문자이미지"> [Request]
|
||||||
|
</p>
|
||||||
<ul class="clause_list">
|
<ul class="clause_list">
|
||||||
<li class="list_open on">
|
<li class="list_open on">
|
||||||
<div class="clause_list_head">
|
<div class="clause_list_head">
|
||||||
@ -53,9 +55,9 @@
|
|||||||
HTTPS 프로토콜을 사용하여 POST로 요청합니다.
|
HTTPS 프로토콜을 사용하여 POST로 요청합니다.
|
||||||
</span>
|
</span>
|
||||||
|
|
||||||
<p class="tType1_title">
|
<!-- <p class="tType1_title">
|
||||||
<img src="/publish/images/content/icon_fee1.png" alt="문자이미지"> 문자
|
<img src="/publish/images/content/icon_fee1.png" alt="문자이미지"> 문자
|
||||||
</p>
|
</p> -->
|
||||||
<table class="tType2">
|
<table class="tType2">
|
||||||
<caption></caption>
|
<caption></caption>
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -86,26 +88,26 @@
|
|||||||
<td>O</td>
|
<td>O</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th>callFrom</th>
|
<th>page</th>
|
||||||
<td>발신자 번호 (아이디에 등록되어 있는 번호)</td>
|
<td>페이지 번호</td>
|
||||||
|
<td>String</td>
|
||||||
|
<td>X</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>pageSize</th>
|
||||||
|
<td>페이지당 출력개수</td>
|
||||||
|
<td>String</td>
|
||||||
|
<td>X</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>startDate</th>
|
||||||
|
<td>시작일자</td>
|
||||||
<td>String</td>
|
<td>String</td>
|
||||||
<td>O</td>
|
<td>O</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th>callToList</th>
|
<th>endDate</th>
|
||||||
<td>수신자 번호 (콤마(,) 기준으로 입력)</td>
|
<td>마감일자</td>
|
||||||
<td>String</td>
|
|
||||||
<td>O</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>smsTxt</th>
|
|
||||||
<td>메세지 내용</td>
|
|
||||||
<td>String (1~2,000Byte)</td>
|
|
||||||
<td>O</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>nameStr</th>
|
|
||||||
<td>메세지 내용에 [*이름*]이 있으면 치환용 이름 입력</td>
|
|
||||||
<td>String</td>
|
<td>String</td>
|
||||||
<td>X</td>
|
<td>X</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -124,7 +126,7 @@
|
|||||||
<li class="list_open on">
|
<li class="list_open on">
|
||||||
<div class="clause_list_head">
|
<div class="clause_list_head">
|
||||||
<div class="list_head_in">
|
<div class="list_head_in">
|
||||||
<span>Request</span>
|
<span>Example</span>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="clause_list_body">
|
<div class="clause_list_body">
|
||||||
@ -138,11 +140,10 @@
|
|||||||
{<br />
|
{<br />
|
||||||
<p>"mberId":"String"</p>
|
<p>"mberId":"String"</p>
|
||||||
<p>,"accessKey":"String"</p>
|
<p>,"accessKey":"String"</p>
|
||||||
<p>,"callFrom":"String"</p>
|
<p>,"page":"String"</p>
|
||||||
<p>,"callToList":"String"</p>
|
<p>,"pageSize":"String"</p>
|
||||||
<p>,"smsTxt":"String"</p>
|
<p>,"startDate":"String"</p>
|
||||||
<p>,"nameStr":"String"</p>
|
<p>,"endDate":"String"</p>
|
||||||
<p>,"callFrom":"String"</p>
|
|
||||||
<p>,"test_yn":"( YS | YF )"</p>
|
<p>,"test_yn":"( YS | YF )"</p>
|
||||||
}
|
}
|
||||||
</td>
|
</td>
|
||||||
@ -152,3 +153,215 @@
|
|||||||
</div>
|
</div>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
<p class="tType1_title">
|
||||||
|
<img src="/publish/images/content/icon_fee1.png" alt="문자이미지"> [Response]
|
||||||
|
</p>
|
||||||
|
<span class="reqTxt4">
|
||||||
|
JSON 객체로 응답 합니다.
|
||||||
|
</span>
|
||||||
|
<table class="tType2">
|
||||||
|
<caption></caption>
|
||||||
|
<colgroup>
|
||||||
|
<col style="width: 13%;">
|
||||||
|
<col style="width: auto;">
|
||||||
|
<col style="width: 20%;">
|
||||||
|
</colgroup>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>키</th>
|
||||||
|
<th>설명</th>
|
||||||
|
<th>타입</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<th>resultCode</th>
|
||||||
|
<td>성공 여부 ( "0" 아니면 실패 )</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>data</th>
|
||||||
|
<td>결과값 객체 ( 성공 : 데이터, 실패 : 메세지 )</td>
|
||||||
|
<td>Object</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].msgGroupId</th>
|
||||||
|
<td>메세지 그룹 ID</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].msgTypeName</th>
|
||||||
|
<td>문자 구분명(단문, 장문, 그림)</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].msgType</th>
|
||||||
|
<td>메세지 타입 ( 4: 단문, 5: 장문 )</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].callFrom</th>
|
||||||
|
<td>발신자 번호</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].msgGroupCnt</th>
|
||||||
|
<td>문자 발송 건수</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].msgGroupCnt</th>
|
||||||
|
<td>문자 발송 건수</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].sCnt</th>
|
||||||
|
<td>성공 건수</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].fCnt</th>
|
||||||
|
<td>실패 건수</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].wCnt</th>
|
||||||
|
<td>대기 건수</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].msgResult</th>
|
||||||
|
<td>발송결과( 성공 : S, 실패 : F)</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].smsTxt</th>
|
||||||
|
<td>문자내용</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].subject</th>
|
||||||
|
<td>제목</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].reqdate</th>
|
||||||
|
<td>발송 일자</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].curState</th>
|
||||||
|
<td>전송 처리 결과값</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].userId</th>
|
||||||
|
<td>사용자 ID</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].regdate</th>
|
||||||
|
<td>등록 일자</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].reserveCYn</th>
|
||||||
|
<td>예약 취소 여부</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].ttlCnt</th>
|
||||||
|
<td>전체 요청 수</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].remainMsgCnt</th>
|
||||||
|
<td>남은 문자 건수</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>[data].totMsgCnt</th>
|
||||||
|
<td>전체 문자 개수</td>
|
||||||
|
<td>String</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<span class="reqTxt4">* 성공 예시</span>
|
||||||
|
<ul class="clause_list">
|
||||||
|
<li class="list_open on">
|
||||||
|
<div class="clause_list_head">
|
||||||
|
<div class="list_head_in">
|
||||||
|
<span>Example</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="clause_list_body">
|
||||||
|
<table class="">
|
||||||
|
<colgroup>
|
||||||
|
<col style="width: auto;">
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td class="padding_add">
|
||||||
|
{
|
||||||
|
<p>"resultCode":"0"</p>
|
||||||
|
<p>, "data":[</p>
|
||||||
|
<div>
|
||||||
|
<p>"msgGroupId":"MSGGID_0000000000000"</p>
|
||||||
|
<p>, "msgTypeName":"단문(SMS)"</p>
|
||||||
|
<p>, "msgType":"4"</p>
|
||||||
|
<p>, "callFrom":"01011112222"</p>
|
||||||
|
<p>, "msgGroupCnt":"2"</p>
|
||||||
|
<p>, "sCnt":"2"</p>
|
||||||
|
<p>, "fCnt":"0"</p>
|
||||||
|
<p>, "wCnt":"0"</p>
|
||||||
|
<p>, "msgResult":"S"</p>
|
||||||
|
<p>, "smsTxt":"문자 내용"</p>
|
||||||
|
<p>, "subject":""</p>
|
||||||
|
<p>, "reqdate":"2023-04-05 00:00:00"</p>
|
||||||
|
<p>, "curState":"3"</p>
|
||||||
|
<p>, "userId":"testuser"</p>
|
||||||
|
<p>, "regdate":"3"</p>
|
||||||
|
<p>, "successCnt":"2023-04-04 16:10:19"</p>
|
||||||
|
<p>, "reserveCYn":"N"</p>
|
||||||
|
<p>, "ttlCnt":"4"</p>
|
||||||
|
<p>, "remainMsgCnt":"0"</p>
|
||||||
|
<p>, "totMsgCnt":"3"</p>
|
||||||
|
</div>
|
||||||
|
<p>]</p>
|
||||||
|
}
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<span class="reqTxt4">* 실패 예시</span>
|
||||||
|
<ul class="clause_list">
|
||||||
|
<li class="list_open on">
|
||||||
|
<div class="clause_list_head">
|
||||||
|
<div class="list_head_in">
|
||||||
|
<span>Example</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="clause_list_body">
|
||||||
|
<table class="">
|
||||||
|
<colgroup>
|
||||||
|
<col style="width: auto;">
|
||||||
|
</colgroup>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td class="padding_add">
|
||||||
|
{
|
||||||
|
<p>"resultCode":"1040"</p>
|
||||||
|
<p>,"data":"치환 데이터 오류"</p>
|
||||||
|
}
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user