diff --git a/.claude/etc1.png b/.claude/etc1.png new file mode 100644 index 00000000..37a0c011 Binary files /dev/null and b/.claude/etc1.png differ diff --git a/.claude/etc2.png b/.claude/etc2.png new file mode 100644 index 00000000..f8ba5306 Binary files /dev/null and b/.claude/etc2.png differ diff --git a/src/main/java/itn/let/uat/uia/web/EgovMypageRESTAPIController.java b/src/main/java/itn/let/uat/uia/web/EgovMypageRESTAPIController.java index 9b388049..f776d60c 100644 --- a/src/main/java/itn/let/uat/uia/web/EgovMypageRESTAPIController.java +++ b/src/main/java/itn/let/uat/uia/web/EgovMypageRESTAPIController.java @@ -260,27 +260,20 @@ public class EgovMypageRESTAPIController{ } model.addAttribute("loginVO", loginVO); -// return "web/api/apiAtSpec"; return "web/api/apiAtSpec"; } - - /** - * @param model - * @return - * @throws Exception - */ - /* @RequestMapping(value="/web/api/apiAtSpec.do") - public String apiAtSpec(ModelMap model) - throws Exception { - LoginVO loginVO = EgovUserDetailsHelper.isAuthenticated()? (LoginVO)EgovUserDetailsHelper.getAuthenticatedUser():null; - - if(loginVO == null) { - return "redirect:/web/user/login/login.do"; - } - model.addAttribute("loginVO", loginVO); - - return "web/api/at/apiSpec"; - }*/ + @RequestMapping(value="/web/api/apiFtSpec.do") + public String apiFtSpec(ModelMap model) + throws Exception { + LoginVO loginVO = EgovUserDetailsHelper.isAuthenticated()? (LoginVO)EgovUserDetailsHelper.getAuthenticatedUser():null; + + if(loginVO == null) { + return "redirect:/web/user/login/login.do"; + } + model.addAttribute("loginVO", loginVO); + + return "web/api/apiFtSpec"; + } /** * @param model diff --git a/src/main/webapp/WEB-INF/jsp/web/api/apiAtSpec.jsp b/src/main/webapp/WEB-INF/jsp/web/api/apiAtSpec.jsp index 2ddc08aa..67e33492 100644 --- a/src/main/webapp/WEB-INF/jsp/web/api/apiAtSpec.jsp +++ b/src/main/webapp/WEB-INF/jsp/web/api/apiAtSpec.jsp @@ -112,67 +112,53 @@ $(document).ready(function(){ -
+
-
+
-
+
-
+
-
+
-
+
-
+
- - - -
diff --git a/src/main/webapp/WEB-INF/jsp/web/api/apiFtSpec.jsp b/src/main/webapp/WEB-INF/jsp/web/api/apiFtSpec.jsp new file mode 100644 index 00000000..b7b54720 --- /dev/null +++ b/src/main/webapp/WEB-INF/jsp/web/api/apiFtSpec.jsp @@ -0,0 +1,111 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%> +<%@ taglib prefix="ui" uri="http://egovframework.gov/ctl/ui"%> +<%@ taglib uri="http://java.sun.com/jsp/jstl/functions" prefix="fn"%> + + + + + + + +
+ +
+ + + + +
+
+

REST API 개발 가이드

+
+ + + +
+
+ +
    + +
    • +
    • +
    • +
    • +
    • + +
+
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ + +
+ +
+
+ +
+
+
diff --git a/src/main/webapp/WEB-INF/jsp/web/api/apiSpec.jsp b/src/main/webapp/WEB-INF/jsp/web/api/apiSpec.jsp index 1de0cb27..578163c3 100644 --- a/src/main/webapp/WEB-INF/jsp/web/api/apiSpec.jsp +++ b/src/main/webapp/WEB-INF/jsp/web/api/apiSpec.jsp @@ -91,77 +91,6 @@ $(document).ready(function(){ -
-
- -
    - -
    • -
    • -
    • -
    • - -
    • -
    • -
    • - -
-
- - -
- -
- - -
- -
- - -
- -
- - -
- -
- - -
- -
- - -
- -
- - -
- -
- - -
- -
-
- - - -
-
-
    -
    • -
    • -
    • -
    • -
    • -
-
-
diff --git a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab1.jsp b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab1.jsp index 3c9fde23..6ac17c3d 100644 --- a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab1.jsp +++ b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab1.jsp @@ -94,9 +94,9 @@ { - "mberId": "문자온", + "mberId": "홍길동", - "accessKey": "XXXXXXXXXXXXXXXXXXXXbaa01d8d91", + "accessKey": "XXXXXXXXXXXXXX414050694b953", "test_yn": "" } @@ -225,9 +225,9 @@ 

 {
 
-	"resultCode": "4010",
+	"resultCode": "2099",
 	
-	"data": "인증 정보가 올바르지 않습니다.(mberId/accessKey)"
+	"data": "기타 시스템 오류"
 	
 }
diff --git a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab2.jsp b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab2.jsp index 5aa101f7..bb219d70 100644 --- a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab2.jsp +++ b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab2.jsp @@ -3,10 +3,9 @@
@@ -101,11 +100,11 @@ { - "mberId": "dudgusw", + "mberId": "홍길동", - "accessKey": "3429312e6a2c732188d4cc7d15d8a1baa01d8d91", + "accessKey": "XXXXXXXXXXXXXX414050694b953", - "senderKey": "669143473b1af459628b8bdf2f48da090c8895de", + "senderKey": "XXXXXXXXXXXXXX669143473b1af", "test_yn": "" } diff --git a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab3.jsp b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab3.jsp index c9570ab3..e1121460 100644 --- a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab3.jsp +++ b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab3.jsp @@ -1,331 +1,687 @@ -<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> - -
    -
  • - 문자온 사이트 및 API를 통해 전송된 문자 발송내역을 조회할 수 있습니다.
    • -
  • - 문자 발송내역은 날짜별로 조회되며, 최근 3개월까지만 조회 가능합니다.
    • -
  • - 발신번호별 문자 발송내역 조회 기능은 제공되지 않습니다.
    • -
+<%@ page language="java" contentType="text/html; charset=UTF-8" + pageEncoding="UTF-8"%> -
- -
Request
-
-
-

Request

- - - - - - - - - - - - - - - - - - - - - - -
API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
Http MethodPOST
프로토콜HTTP/1.1
HOSTapi.munjaon.co.kr
Service Port443
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
전송결과 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
키설명타입필수
mberId사용자 IDStringO
accessKey인증용 API KeyStringO
senderKey발신 프로필 KeyStringO
templateCode템플릿 코드StringO
-
-

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

-
-
-
-
[Example]
-
-

｛

-
-

"mberId":"홍길동"

-

,"accessKey":"414050694b953XXXXXXXXXXXXXX"

-

,"senderKey":"669143473b1af459628b8bdXXXXXXXXXXXXXX"

-

,"templateCode":"bizp_202503141052XXXXXXXXXXXXXX"

-
-

｝

-
-
- - -
Response
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    +
  • - 문자온 사이트 및 API를 통해 전송된 문자 발송내역을 조회할 수 있습니다.
    • +
  • - 문자 발송내역은 날짜별로 조회되며, 최근 3개월까지만 조회 가능합니다.
    • +
  • - 발신번호별 문자 발송내역 조회 기능은 제공되지 않습니다.
    • +
- -
전송결과 조회 API Response 키 종류 및 설명, 타입 테이블
키설명타입
resultCode성공 여부("0" 아니면 실패)String
data템플릿 정보 리스트Array
[data].templateCode템플릿 코드String
[data].templateName템플릿 이름String
[data].templateMessageType템플릿 메시지 유형 (BA:기본형(default), EX:부가정보형, AD:광고추가형, MI:복합형)String
[data].templateEmphasizeType템플릿 강조 유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, ITEM_LIST: 아이템리스트형)String
[data].templateContent템플릿 내용String
[data].templateExtra부가정보String
[data].templateAd광고성 메시지String
[data].templateImageName템플릿 이미지 파일명String
[data].templateImageUrl템플릿 이미지 링크String
[data].templateTitle템플릿 내용 중 강조 표기할 핵심 정보String
[data].templateSubtitle강조 표기 보조 문구String
[data].templateHeader헤더String
[data].categoryCode템플릿 카테고리 코드String
[data].securityFlag보안 템플릿 여부 (true:설정)Boolean
[data].inspectionStatus검수 상태 (REG: 등록, REQ: 검수요청, REJ: 반려, APR: 승인)String
[data].createdAt생성일String
[data].modifiedAt수정일String
[data].status템플릿 상태(D:중지, A:정상, R:대기(발송전))String
[data].block템플릿 차단 여부 (true:차단, false: 해제)Boolean
[data].dormant템플릿 휴면 여부 (true:휴면, false: 해제)Boolean
[data].templateItemHighlight아이템 하이라이트Object
[data].templateItemHighlight.title타이틀String
[data].templateItemHighlight.description상세 설명String
[data].templateItemHighlight.imageUrl썸네일 이미지 주소String
[data].templateItem아이템 정보Object
[data].templateItem.list[]아이템 리스트Array
[data].templateItem.list[].title타이틀String
[data].templateItem.list[].description디스크립션String
[data].templateItem.summary아이템 요약 정보Object
[data].templateItem.summary.title타이틀String
[data].templateItem.summary.description디스크립션String
[data].buttons[]버튼 정보Array
[data].buttons[].name버튼명String
[data].buttons[].linkType버튼 링크타입 (DS:배송조회, WL:웹링크, AL:앱링크, BK:봇키워드, MD: 메시지전달, AC: 채널추가, BC: 상담톡전환, BT: 봇전환, P1: 이미지 보안전송 플러그인, P2: 개인정보이용 플러그인, P3: 원클릭 결제 플러그인)String
[data].buttons[].linkAndAndroid 앱 링크 주소String
[data].buttons[].linkIosIOS 앱 링크 주소String
[data].buttons[].linkMo모바일 웹 링크 주소String
[data].buttons[].linkPcPC 웹 링크 주소String
[data].buttons[].pluginId플러그인 IDString
[data].quickReplies[]바로연결 정보Array
[data].quickReplies[].name바로연결명String
[data].quickReplies[].linkType바로연결 링크타입 (WL:웹링크, AL:앱링크, BK:봇키워드, MD: 메시지전달, BC: 상담톡전환, BT: 봇전환)String
[data].quickReplies[].linkAndAndroid 앱 링크 주소String
[data].quickReplies[].linkIosIOS 앱 링크 주소String
[data].quickReplies[].linkMo모바일 웹 링크 주소String
[data].quickReplies[].linkPcPC 웹 링크 주소String
[data].comments[]댓글 목록Array
[data].comments[].content댓글 본문String
[data].comments[].createdAt댓글 생성일String
[data].comments[].status댓글 상태 (REQ:등록, INQ:문의, APR:승인, REJ:반려, REP:답변)String
[data].comments[].userName댓글 작성자String
[data].comments[].attachment첨부파일Array
[data].comments[].attachment[]첨부파일Array
[data].comments[].attachment[].originalFileName업로드한 파일 이름String
[data].comments[].attachment[].filePath파일 다운로드 경로String
-
-

※ JSON 객체로 응답합니다.

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

｛

-
-

"resultCode":"0"

-

,"data":［

-

｛

-
-

"templateCode": "bizp_20250314105XXXXXXXXXXXXXXX"

-

,"templateName": "템플릿 명"

-

,"templateMessageType": "BA"

-

,"templateEmphasizeType": "TEXT"

-

,"templateContent": "템플릿 내용 예시"

-

,"templateExtra": "부가정보"

-

,"templateAd": "광고성 문구"

-

,"templateImageName": "template.jpg"

-

,"templateImageUrl": "https://cdn.example.com/image.jpg"

-

,"templateTitle": "강조 제목"

-

,"templateSubtitle": "보조 문구"

-

,"templateHeader": "템플릿 헤더"

-

,"categoryCode": "005001"

-

,"securityFlag": true

-

,"inspectionStatus": "REG"

-

,"createdAt": "2025-06-30 10:30:00"

-

,"modifiedAt": "2025-07-01 11:00:00"

-

,"status": "A"

-

,"block": false

-

,"dormant": false

- - -

,"templateItemHighlight": {

-
-

"title": "하이라이트 제목"

-

,"description": "하이라이트 설명"

-

,"imageUrl": "https://cdn.example.com/thumb.jpg"

-
-

}

- - -

,"templateItem": {

-
-

"list": [

-
-

｛

-

"title": "아이템 제목"

-

,"description": "아이템 설명"

-

｝

-
-

],

-

"summary": {

-
-

"title": "요약 제목"

-

,"description": "요약 설명"

-
-

}

-
-

}

- - -

,"buttons": [

-
-

｛

-

"name": "버튼명"

-

,"linkType": "WL"

-

,"linkAnd": "https://aos.example.com"

-

,"linkIos": "https://ios.example.com"

-

,"linkMo": "https://m.example.com"

-

,"linkPc": "https://www.example.com"

-

,"pluginId": "plugin123"

-

｝

-
-

]

- - -

,"quickReplies": [

-
-

｛

-

"name": "빠른응답"

-

,"linkType": "WL"

-

,"linkAnd": "https://aos.quick.com"

-

,"linkIos": "https://ios.quick.com"

-

,"linkMo": "https://m.quick.com"

-

,"linkPc": "https://www.quick.com"

-

｝

-
-

]

- - -

,"comments": [

-
-

｛

-

"content": "댓글 예시입니다."

-

,"createdAt": "2025-07-01 10:00:00"

-

,"status": "REQ"

-

,"userName": "관리자"

-

,"attachment": [

-
-

｛

-

"originalFileName": "example.pdf"

-

,"filePath": "/download/example.pdf"

-

｝

-
-

]

-

｝

-
-

]

-
-

｝

-

］

-
-

｝

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

｛

-
-

"resultCode":"4099"

-

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

-
-

｝

-
-
- -
+
+ +
Request
+
+
+

Request

+ + + + + + + + + + + + + + + + + + + + + + +
API Request Http Method, 프로토콜, HOST, Service Port + 정보 테이블
Http MethodPOST
프로토콜HTTP/1.1
HOSTapi.munjaon.co.kr
Service Port443
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
전송결과 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
키설명타입필수
mberId사용자 IDStringO
accessKey인증용 API KeyStringO
senderKey발신 프로필 KeyStringO
templateCode템플릿 코드StringO
+
+

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

+
+
+
+
[Example]
+
+

｛

+
+

+ "mberId":"홍길동" +

+

+ ,"accessKey":"XXXXXXXXXXXXXX414050694b953" +

+

+ ,"senderKey":"XXXXXXXXXXXXXX669143473b1af" +

+

+ ,"templateCode":"bizp_202503141052XXXXXXXXXXXXXX" +

+
+

｝

+
+
+ + +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
전송결과 조회 API Response 키 종류 및 설명, 타입 테이블
키설명타입
resultCode성공 여부("0" 아니면 실패)String
data템플릿 정보 리스트Array
[data].templateCode템플릿 코드String
[data].templateName템플릿 이름String
[data].templateMessageType템플릿 메시지 유형
(BA:기본형(default), EX:부가정보형, AD:광고추가형, MI:복합형)		String
[data].templateEmphasizeType템플릿 강조 유형
(NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, + ITEM_LIST: 아이템리스트형)		String
[data].templateContent템플릿 내용String
[data].templateExtra부가정보String
[data].templateAd광고성 메시지String
[data].templateImageName템플릿 이미지 파일명String
[data].templateImageUrl템플릿 이미지 링크String
[data].templateTitle템플릿 내용 중 강조 표기할 핵심 정보String
[data].templateSubtitle강조 표기 보조 문구String
[data].templateHeader헤더String
[data].categoryCode템플릿 카테고리 코드String
[data].securityFlag보안 템플릿 여부 (true:설정)Boolean
[data].inspectionStatus검수 상태 (REG: 등록, REQ: 검수요청, REJ: 반려, APR: 승인)String
[data].createdAt생성일String
[data].modifiedAt수정일String
[data].status템플릿 상태(D:중지, A:정상, R:대기(발송전))String
[data].block템플릿 차단 여부 (true:차단, false: 해제)Boolean
[data].dormant템플릿 휴면 여부 (true:휴면, false: 해제)Boolean
[data].templateItemHighlight아이템 하이라이트Object
[data].templateItemHighlight.title타이틀String
[data].templateItemHighlight.description상세 설명String
[data].templateItemHighlight.imageUrl썸네일 이미지 주소String
[data].templateItem아이템 정보Object
[data].templateItem.list[]아이템 리스트Array
[data].templateItem.list[].title타이틀String
[data].templateItem.list[].description디스크립션String
[data].templateItem.summary아이템 요약 정보Object
[data].templateItem.summary.title타이틀String
[data].templateItem.summary.description디스크립션String
[data].buttons[]버튼 정보Array
[data].buttons[].name버튼명String
[data].buttons[].linkType버튼 링크타입 (DS:배송조회, WL:웹링크, AL:앱링크, BK:봇키워드, MD: 메시지전달, AC: + 채널추가, BC: 상담톡전환, BT: 봇전환, P1: 이미지 보안전송 플러그인, P2: 개인정보이용 플러그인, P3: + 원클릭 결제 플러그인)String
[data].buttons[].linkAndAndroid 앱 링크 주소String
[data].buttons[].linkIosIOS 앱 링크 주소String
[data].buttons[].linkMo모바일 웹 링크 주소String
[data].buttons[].linkPcPC 웹 링크 주소String
[data].buttons[].pluginId플러그인 IDString
[data].quickReplies[]바로연결 정보Array
[data].quickReplies[].name바로연결명String
[data].quickReplies[].linkType바로연결 링크타입 (WL:웹링크, AL:앱링크, BK:봇키워드, MD: 메시지전달, BC: 상담톡전환, + BT: 봇전환)String
[data].quickReplies[].linkAndAndroid 앱 링크 주소String
[data].quickReplies[].linkIosIOS 앱 링크 주소String
[data].quickReplies[].linkMo모바일 웹 링크 주소String
[data].quickReplies[].linkPcPC 웹 링크 주소String
[data].comments[]댓글 목록Array
[data].comments[].content댓글 본문String
[data].comments[].createdAt댓글 생성일String
[data].comments[].status댓글 상태 (REQ:등록, INQ:문의, APR:승인, REJ:반려, REP:답변)String
[data].comments[].userName댓글 작성자String
[data].comments[].attachment첨부파일Array
[data].comments[].attachment[]첨부파일Array
[data].comments[].attachment[].originalFileName업로드한 파일 이름String
[data].comments[].attachment[].filePath파일 다운로드 경로String
+
+

※ JSON 객체로 응답합니다.

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

｛

+
+

+ "resultCode":"0" +

+

+ ,"data":［ +

+

｛

+
+

+ "templateCode": "bizp_20250314105XXXXXXXXXXXXXXX" +

+

+ ,"templateName": "템플릿 명" +

+

+ ,"templateMessageType": "BA" +

+

+ ,"templateEmphasizeType": "TEXT" +

+

+ ,"templateContent": "템플릿 내용 예시" +

+

+ ,"templateExtra": "부가정보" +

+

+ ,"templateAd": "광고성 문구" +

+

+ ,"templateImageName": "template.jpg" +

+

+ ,"templateImageUrl": + "https://cdn.example.com/image.jpg" +

+

+ ,"templateTitle": "강조 제목" +

+

+ ,"templateSubtitle": "보조 문구" +

+

+ ,"templateHeader": "템플릿 헤더" +

+

+ ,"categoryCode": "005001" +

+

+ ,"securityFlag": true +

+

+ ,"inspectionStatus": "REG" +

+

+ ,"createdAt": "2025-06-30 10:30:00" +

+

+ ,"modifiedAt": "2025-07-01 11:00:00" +

+

+ ,"status": "A" +

+

+ ,"block": false +

+

+ ,"dormant": false +

+ + +

+ ,"templateItemHighlight": { +

+
+

+ "title": "하이라이트 제목" +

+

+ ,"description": "하이라이트 설명" +

+

+ ,"imageUrl": "https://cdn.example.com/thumb.jpg" +

+
+

}

+ + +

+ ,"templateItem": { +

+
+

+ "list": [ +

+
+

｛

+

+ "title": "아이템 제목" +

+

+ ,"description": "아이템 설명" +

+

｝

+
+

],

+

+ "summary": { +

+
+

+ "title": "요약 제목" +

+

+ ,"description": "요약 설명" +

+
+

}

+
+

}

+ + +

+ ,"buttons": [ +

+
+

｛

+

+ "name": "버튼명" +

+

+ ,"linkType": "WL" +

+

+ ,"linkAnd": "https://aos.example.com" +

+

+ ,"linkIos": "https://ios.example.com" +

+

+ ,"linkMo": "https://m.example.com" +

+

+ ,"linkPc": "https://www.example.com" +

+

+ ,"pluginId": "plugin123" +

+

｝

+
+

]

+ + +

+ ,"quickReplies": [ +

+
+

｛

+

+ "name": "빠른응답" +

+

+ ,"linkType": "WL" +

+

+ ,"linkAnd": "https://aos.quick.com" +

+

+ ,"linkIos": "https://ios.quick.com" +

+

+ ,"linkMo": "https://m.quick.com" +

+

+ ,"linkPc": "https://www.quick.com" +

+

｝

+
+

]

+ + +

+ ,"comments": [ +

+
+

｛

+

+ "content": "댓글 예시입니다." +

+

+ ,"createdAt": "2025-07-01 10:00:00" +

+

+ ,"status": "REQ" +

+

+ ,"userName": "관리자" +

+

+ ,"attachment": [ +

+
+

｛

+

+ "originalFileName": "example.pdf" +

+

+ ,"filePath": "/download/example.pdf" +

+

｝

+
+

]

+

｝

+
+

]

+
+

｝

+

］

+
+

｝

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

｛

+
+

+ "resultCode":"4099" +

+

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

+
+

｝

+
+
+ +
diff --git a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab4.jsp b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab4.jsp index aa127b65..79c59812 100644 --- a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab4.jsp +++ b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab4.jsp @@ -85,12 +85,6 @@ String O - - subMsgSendYn - 대체문자 발송 여부 (Y: 발송, N: 미발송) - String - X - callFrom 발신자 번호 @@ -115,6 +109,12 @@ String O + + subMsgSendYn + 대체문자 발송 여부 (Y: 발송, N: 미발송) + String + X + subMsgTxt_[i] 대체문자 내용 @@ -142,35 +142,35 @@ { - "mberId": "dudgusw", + "mberId": "홍길동", - "accessKey": "3429312e6a2c732188d4cc7d15d8a1baa01d8d91", + "accessKey": "XXXXXXXXXXXXXX414050694b953", - "senderKey": "669143473b1af459628b8bdf2f48da090c8895de", + "senderKey": "XXXXXXXXXXXXXX669143473b1af", - "templateCode": "bizp_2025031410525347794704159", - - "subMsgSendYn": "Y", + "templateCode": "bizp_2025031410525XXXXXXXXXXXXX", "callFrom": "010-9341-4986", - "callTo_1": "01083584250", + "callTo_1": "01000000000", "callTo_2": "01011111111", - "templateTitle_1": "테스트 이호영2222", + "templateTitle_1": "타이틀 테스트2222", - "templateTitle_2": "테스트 이호영2111", + "templateTitle_2": "타이틀 테스트2111", - "templateContent_1": "테스트 이호영\\n타이틀 버튼 치환 테스트입니다.", + "templateContent_1": "테스트 홍길동\\n템플릿 내용", - "templateContent_2": "테스트 이호영2\\n타이틀 버튼 치환 테스트입니다.", + "templateContent_2": "테스트 홍길동2\\n템플릿 내용", + + "subMsgSendYn": "Y", "subMsgTxt_1": "대체문자 발송", "subMsgTxt_2": "대체문자 발송2", - "test_yn": "YS" + "test_yn": "" } @@ -275,7 +275,7 @@ "msgType": "AT", - "test_yn": "YS" + "test_yn": "" }, diff --git a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab5.jsp b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab5.jsp deleted file mode 100644 index e31593b7..00000000 --- a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab5.jsp +++ /dev/null @@ -1,195 +0,0 @@ -<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> - -
    -
  • - 보11유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.
    • -
  • - 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.
    • -
- -
- -
Request
-
-
-

Request

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

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

-
-
-
-
[Example]
-
-

｛

-
-

"mberId":"String"

-

,"accessKey":"String"

-
-

｝

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

※ JSON 객체로 응답합니다.

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

｛

-
-

"resultCode":"0"

-

,"data"｛

-
-

"longPrice":"50"

-

,"longSendPsbltEa":"19651"

-

,"mberMoney":"982586.7"

-

,"message":null

-

,"picturePrice":"90"

-

,"pictureSendPsbltEa":"10917"

-

,"shortPrice":"18"

-

,"shortSendPsbltEa":"54588"

-
-

｝

-
-

｝

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

｛

-
-

"resultCode":"5099"

-

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

-
-

｝

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

Request

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

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

-
-
-
-
[Example]
-
-

｛

-
-

"mberId":"홍길동"

-

,"accessKey":"XXXXXXXXXXXXXX414050694b953"

-

,"page":""

-

,"pageSize":""

-

,"startDate":""

-

,"endDate":""

-

,"test_yn":""

-
-

｝

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

※ JSON 객체로 응답합니다.

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

｛

-
-

"resultCode":"0"

-

,"data":［

-

｛

-
-

"resultCode":"0"

-

,"message": null

-

,"next_yn":"n"

-

,"msgGroupId":"MSGGID_0000000000000"

-

,"objectList":［

-

｛

-
-

"msgTypeName":"단문(SMS)"

-

,"msgType":"4"

-

,"callFrom":"01011112222"

-

,"callTo":"01011112223"

-

,"msgGroupCnt":"2"

-

,"msgGroupId":"MSGGID_0000000013340"

-

,"msgId":"MSGID_0000000000001"

-

,"scnt":"2"

-

,"fcnt":"0"

-

,"wcnt":"0"

-

,"msgResult":"S"

-

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

-

,"subject":null

-

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

-

,"curState":"3"

-

,"userId":"testuser"

-

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

-

,"reserveCYn":"N"

-

,"ttlCnt":"1"

-

,"remainMsgCnt":"40"

-

,"totMsgCnt":"70"

-
-

｝

-

,｛

-
-

"msgTypeName":"장문(LMS)"

-

,"msgType":"6"

-

,"callFrom":"01011112222"

-

,"callTo":"01011112223"

-

,"msgGroupCnt":"1"

-

,"msgGroupId":"MSGGID_0000000013341"

-

,"msgId":"MSGID_0000000000002"

-

,"scnt":"1"

-

,"fcnt":"0"

-

,"wcnt":"0"

-

,"msgResult":"S"

-

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

-

,subject":null

-

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

-

,"curState":"3"

-

,"userId":"testuser"

-

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

-

,"reserveCYn":"N"

-

,"ttlCnt":"1"

-

,"remainMsgCnt":"40"

-

,"totMsgCnt":"70"

-

｝

-
-

］

-
-

｝

-

］

-
-

｝

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

｛

-
-

"resultCode":"3099"

-

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

-
-

｝

-
-
- -
+
    +
  • - 문자온 사이트 및 API를 통해 전송된 발송내역을 조회할 수 있습니다.
    • +
  • - 문자 발송내역은 날짜별로 조회되며, 최근 3개월까지만 조회 가능합니다.
    • +
  • - 발신번호별 문자 발송내역 조회 기능은 제공되지 않습니다.
    • +
+ +
+ +
Request
+
+
+

Request

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

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

+

※ Content-Type: application/json

+
+
+ +
+
[Example]
+
+ 
+				
+{
+
+	"mberId": "홍길동",
+	
+	"accessKey": "XXXXXXXXXXXXXX414050694b953",
+	
+	"page": "",
+	
+	"pageSize": "",
+	
+	"startDate": "",
+	
+	"endDate": "",
+	
+	"test_yn": ""
+}
+				
+
+
+
+ + + +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
전송결과 조회 API Response 키 종류 및 설명, 타입 테이블
키설명타입
resultCode성공 여부("0" 아니면 실패)String
data결과값 객체(성공 : 데이터, 실패 : 메시지)Object | String
[data].message메시지(필요 시)String
[data].next_yn다음 페이지 여부(Y/N)String
[data].objectList결과값 목록Array<Object>
[data].objectList[i].msgGroupId메시지 그룹 IDString
[data].objectList[i].msgId메시지 IDString
[data].objectList[i].msgTypeName문자 구분명(단문, 장문, 그림)String
[data].objectList[i].msgType메시지 타입(4: 단문, 5: 장문, 6: 그림)String | Number
[data].objectList[i].callFrom발신자 번호String
[data].objectList[i].callTo수신자 번호String
[data].objectList[i].msgGroupCnt발송 건수String | Number
[data].objectList[i].scnt성공 건수String | Number
[data].objectList[i].fcnt실패 건수String | Number
[data].objectList[i].wcnt대기 건수String | Number
[data].objectList[i].msgResult발송 결과(성공: S, 실패: F)String
[data].objectList[i].smsTxt문자 내용String
[data].objectList[i].subject제목String | null
[data].objectList[i].reqdate발송 일자(YYYY-MM-DD HH:mm:ss)String
[data].objectList[i].curState전송 처리 결과값String | Number
[data].objectList[i].userId사용자 IDString
[data].objectList[i].regdate등록 일자(YYYY-MM-DD HH:mm:ss)String
[data].objectList[i].reserveCYn예약 취소 여부(Y/N)String
[data].ttlCnt전체 요청 수String | Number
[data].remainMsgCnt남은 문자 건수String | Number
[data].totMsgCnt전체 문자 개수String | Number
+
+

※ JSON 객체로 응답합니다.

+
+
+ +
+
[Example]O 성공 예시
+
+ 
+				
+{
+	"resultCode": "0",
+	
+	"data": {
+	
+		"resultCode": "0",
+		
+		"message": null,
+		
+		"next_yn": "n",
+		
+		"msgGroupId": "MSGGID_0000000000000",
+		
+		"objectList": [
+		
+			{
+			
+				"msgTypeName": "단문(SMS)",
+				
+				"msgType": "4",
+				
+				"callFrom": "01011112222",
+				
+				"callTo": "01011112223",
+				
+				"msgGroupCnt": "2",
+				
+				"msgGroupId": "MSGGID_0000000013340",
+				
+				"msgId": "MSGID_0000000000001",
+				
+				"scnt": "2",
+				
+				"fcnt": "0",
+				
+				"wcnt": "0",
+				
+				"msgResult": "S",
+				
+				"smsTxt": "문자 내용 단문 예제",
+				
+				"subject": null,
+				
+				"reqdate": "2023-06-13 17:48:07",
+				
+				"curState": "3",
+				
+				"userId": "testuser",
+				
+				"regdate": "2023-06-13 17:48:07",
+				
+				"reserveCYn": "N",
+				
+				"ttlCnt": "1",
+				
+				"remainMsgCnt": "40",
+				
+				"totMsgCnt": "70"
+				
+			},
+			
+			{
+			
+				"msgTypeName": "장문(LMS)",
+				
+				"msgType": "5",
+				
+				"callFrom": "01011112222",
+				
+				"callTo": "01011112223",
+				
+				"msgGroupCnt": "1",
+				
+				"msgGroupId": "MSGGID_0000000013341",
+				
+				"msgId": "MSGID_0000000000002",
+				
+				"scnt": "1",
+				
+				"fcnt": "0",
+				
+				"wcnt": "0",
+				
+				"msgResult": "S",
+				
+				"smsTxt": "문자 내용 장문 예제",
+				
+				"subject": null,
+				
+				"reqdate": "2023-06-02 11:46:50",
+				
+				"curState": "3",
+				
+				"userId": "testuser",
+				
+				"regdate": "2023-06-02 11:46:49",
+				
+				"reserveCYn": "N",
+				
+				"ttlCnt": "1",
+				
+				"remainMsgCnt": "40",
+				
+				"totMsgCnt": "70"
+				
+			}
+			
+		]
+		
+	}
+}
+				
+
+
+
+ +
+
[Example]X 실패 예시
+
+ 
+				
+{
+
+	"resultCode": "3099",
+	
+	"data": "기타 시스템 오류"
+}
+				
+
+
+
+ +
diff --git a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab7.jsp b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab7.jsp index df406dc3..b868eaab 100644 --- a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab7.jsp +++ b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab7.jsp @@ -1,195 +1,342 @@ -<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> - -
    -
  • - 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.
    • -
  • - 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.
    • -
+<%@ page language="java" contentType="text/html; charset=UTF-8" + pageEncoding="UTF-8"%> -
- -
Request
-
-
-

Request

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

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

-
-
-
-
[Example]
-
-

｛

-
-

"mberId":"String"

-

,"accessKey":"String"

-
-

｝

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

※ JSON 객체로 응답합니다.

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

｛

-
-

"resultCode":"0"

-

,"data"｛

-
-

"longPrice":"50"

-

,"longSendPsbltEa":"19651"

-

,"mberMoney":"982586.7"

-

,"message":null

-

,"picturePrice":"90"

-

,"pictureSendPsbltEa":"10917"

-

,"shortPrice":"18"

-

,"shortSendPsbltEa":"54588"

-
-

｝

-
-

｝

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

｛

-
-

"resultCode":"5099"

-

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

-
-

｝

-
-
- -
+ +
    +
  • - API를 통해서 메시지 그룹 ID 기준의 상세 이력(개별 건) 목록을 조회할 수 있습니다.
    • +
+
+ +
Request
+
+
+

Request

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
API Request Http Method, 프로토콜, HOST, Service Port, Endpoint 정보 테이블
Http MethodPOST
프로토콜HTTPS/1.1
HOSTapi.munjaon.co.kr
Service Port443
Endpoint/api/inqry/hstryDetail
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
히스토리 상세 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
키설명타입필수
mberId사용자 IDStringO
accessKey인증용 API KeyStringO
msgGroupId메시지 그룹 IDStringO
+
+

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

+

※ Content-Type: application/json

+
+
+ +
+
[Example]
+
+ 
+					
+{
+
+	"mberId": "홍길동",
+	
+	"accessKey": "XXXXXXXXXXXXXX414050694b953",
+	
+	"msgGroupId": "MSGGID_XXXXXXX0000063"
+}
+					
+
+
+
+ + + +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
히스토리 상세 조회 API Response 키 종류 및 설명, 타입 테이블
키설명타입
resultCode성공 여부("0" 이외는 실패)String
data조회 결과 객체Object
[data].resultCode내부 처리 결과(0: 성공)Number | String
[data].objectList개별 메시지 상세 목록Array<Object>
[data].objectList[i].msgGroupId메시지 그룹 IDString
[data].objectList[i].msgId개별 메시지 IDString
[data].objectList[i].totMsgCnt총 발송 건수(그룹 기준)String
[data].objectList[i].msgType메시지 타입 코드(예: 8=AT)Number
[data].objectList[i].msgTypeName메시지 타입명String
[data].objectList[i].msgResult결과(F: 실패, S: 성공 등)String
[data].objectList[i].msgGroupCnt발송 건수Number
[data].objectList[i].smsTxt메시지 내용String
[data].objectList[i].callFrom발신 번호String
[data].objectList[i].callTo수신 번호String
[data].objectList[i].curState현재 상태 코드Number
[data].objectList[i].remainMsgCnt잔여 처리 건수Number
[data].objectList[i].reqdate요청 일시(YYYY-MM-DD HH:mm:ss)String
[data].objectList[i].regdate등록 일시(YYYY-MM-DD HH:mm:ss)String
[data].objectList[i].reserveCYn예약 취소 여부(Y/N)String
localDateTime서버 처리 일시(ISO-8601)String
+
+

※ JSON 객체로 응답합니다.

+
+
+ +
+
[Example]O 성공 예시
+
+ 
+					
+{
+	"resultCode": "0",
+	
+	"data": {
+	
+		"resultCode": 0,
+		
+		"objectList": [
+		
+			{
+			
+				"msgGroupId": "MSGGID_XXXXXXX0000063",
+				
+				"msgId": "MSGCID_XXXXXXX00001180",
+				
+				"totMsgCnt": "9",
+				
+				"msgType": 8,
+				
+				"msgTypeName": "알림톡(AT)",
+				
+				"msgResult": "F",
+				
+				"msgGroupCnt": 1,
+				
+				"smsTxt": "test",
+				
+				"callFrom": "01093414986",
+				
+				"callTo": "01059941669",
+				
+				"curState": 3,
+				
+				"remainMsgCnt": 0,
+				
+				"reqdate": "2025-09-05 11:45:45",
+				
+				"regdate": "2025-09-05 11:45:45",
+				
+				"reserveCYn": "N"
+				
+			},
+			
+			{
+			
+				"msgGroupId": "MSGGID_XXXXXXX0000063",
+				
+				"msgId": "MSGCID_XXXXXXX000001175",
+				
+				"totMsgCnt": "9",
+				
+				"msgType": 9,
+				
+				"msgTypeName": "친구톡(AT)",
+				
+				"msgResult": "F",
+				
+				"msgGroupCnt": 1,
+				
+				"smsTxt": "test",
+				
+				"callFrom": "01093414986",
+				
+				"callTo": "01098969885",
+				
+				"curState": 3,
+				
+				"remainMsgCnt": 0,
+				
+				"reqdate": "2025-09-05 11:45:45",
+				
+				"regdate": "2025-09-05 11:45:45",
+				
+				"reserveCYn": "N"
+				
+			},
+			
+		]
+		
+	},
+	
+	"localDateTime": "2025-09-16T10:47:20.4014362"
+	
+}
+					
+
+
+
+ +
+
[Example]X 실패 예시
+
+ 

+{
+
+	"resultCode": "4099",
+	
+	"data": "기타 시스템 오류"
+	
+}
+
+
+
+ +
+ diff --git a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab8.jsp b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab8.jsp index df406dc3..98d6d57e 100644 --- a/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab8.jsp +++ b/src/main/webapp/WEB-INF/jsp/web/api/at/apiSpec_tab8.jsp @@ -1,195 +1,303 @@ -<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> - -
    -
  • - 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.
    • -
  • - 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.
    • -
+<%@ page language="java" contentType="text/html; charset=UTF-8" + pageEncoding="UTF-8"%> -
- -
Request
-
-
-

Request

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

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

-
-
-
-
[Example]
-
-

｛

-
-

"mberId":"String"

-

,"accessKey":"String"

-
-

｝

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

※ JSON 객체로 응답합니다.

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

｛

-
-

"resultCode":"0"

-

,"data"｛

-
-

"longPrice":"50"

-

,"longSendPsbltEa":"19651"

-

,"mberMoney":"982586.7"

-

,"message":null

-

,"picturePrice":"90"

-

,"pictureSendPsbltEa":"10917"

-

,"shortPrice":"18"

-

,"shortSendPsbltEa":"54588"

-
-

｝

-
-

｝

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

｛

-
-

"resultCode":"5099"

-

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

-
-

｝

-
-
- -
+ +
    +
  • - 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS), 알림톡(AT), 친구톡(FT)별로 각각 확인할 수 있습니다.
    • + +
+ +
+ +
Request
+
+
+

Request

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

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

+

※ Content-Type: application/json

+
+
+ +
+
[Example]
+
+ 
+					
+{
+
+	"mberId": "홍길동",
+	
+	"accessKey": "XXXXXXXXXXXXXX414050694b953"
+}
+					
+
+
+
+ + + +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
가격/가능건수 조회 API Response 키 종류 및 설명, 타입 테이블
키설명타입
resultCode성공 여부("0" 이외는 실패)String
data조회 결과 객체(성공 시 가격/가능건수 정보)Object | String
[data].resultCode내부 처리 결과("0": 성공)String
[data].message메시지(필요 시)String
[data].localDateTime서버 처리 일시(ISO-8601)String
[data].shortPrice단문(SMS) 단가Number
[data].longPrice장문(LMS) 단가Number
[data].picturePrice사진(MMS) 단가Number
[data].kakaoAtPrice카카오 알림톡 단가Number
[data].kakaoFtPrice카카오 친구톡(텍스트) 단가Number
[data].kakaoFtImgPrice카카오 친구톡(이미지) 단가Number
[data].kakaoFtWideImgPrice카카오 친구톡(와이드 이미지) 단가Number
[data].mberMoney회원 보유 금액Number
[data].shortSendPsbltEa단문 발송 가능 건수Number
[data].longSendPsbltEa장문 발송 가능 건수Number
[data].pictureSendPsbltEa사진 발송 가능 건수Number
[data].kakaoAtSendPsbltEa알림톡 발송 가능 건수Number
[data].kakaoFtSendPsbltEa친구톡(텍스트) 발송 가능 건수Number
[data].kakaoFtImgSendPsbltEa친구톡(이미지) 발송 가능 건수Number
[data].kakaoFtWideImgSendPsbltEa친구톡(와이드 이미지) 발송 가능 건수Number
localDateTime서버 처리 일시(ISO-8601)String
+
+

※ JSON 객체로 응답합니다.

+
+
+ +
+
[Example]O 성공 예시
+
+ 
+					
+{
+	"resultCode": "0",
+	
+	"data": {
+	
+		"resultCode": "0",
+		
+		"message": "",
+		
+		"localDateTime": "2025-09-16T11:06:40.2556646",
+		
+		"shortPrice": 18.0,
+		
+		"longPrice": 50.0,
+		
+		"picturePrice": 90.0,
+		
+		"kakaoAtPrice": 6.9,
+		
+		"kakaoFtPrice": 13.8,
+		
+		"kakaoFtImgPrice": 19.9,
+		
+		"kakaoFtWideImgPrice": 22.9,
+		
+		"mberMoney": 6549661.26,
+		
+		"shortSendPsbltEa": 363870,
+		
+		"longSendPsbltEa": 130993,
+		
+		"pictureSendPsbltEa": 72774,
+		
+		"kakaoAtSendPsbltEa": 949226,
+		
+		"kakaoFtSendPsbltEa": 474613,
+		
+		"kakaoFtImgSendPsbltEa": 329128,
+		
+		"kakaoFtWideImgSendPsbltEa": 286011
+		
+	},
+	
+	"localDateTime": "2025-09-16T11:06:40.2556646"
+	
+}
+					
+
+
+
+ +
+
[Example]X 실패 예시
+
+ 

+{
+
+	"resultCode": "3099",
+	
+	"data": "기타 시스템 오류"
+	
+}
+
+
+
+ +
+ diff --git a/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab1.jsp b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab1.jsp index 6a4e1f99..6ac17c3d 100644 --- a/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab1.jsp +++ b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab1.jsp @@ -7,210 +7,233 @@ -
- -
Request
-
-
-

Request

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

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

-

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

-
-
-
-
[Example]
-
-

｛

-
-

- "mberId":"홍길동" -

-

- ,"accessKey":"XXXXXXXXXXXXXX414050694b953" -

+ +
Request
+
+
+

Request

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
API Request Http Method, 프로토콜, HOST, Service Port, Endpoint 정보 테이블
Http MethodPOST
프로토콜HTTPS/1.1
HOSTapi.munjaon.co.kr
Service Port443
Endpoint/api/kakao/inqry/chnlId
-

｝

-
- - -
Response
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
문자발송 API Response 키 종류 및 설명, 타입 테이블
키설명타입
resultCode성공 여부 ("0" 이면 성공, 그 외는 실패)String
data응답 결과 객체 (성공 시 배열, 실패 시 메시지)Array<Object>
data[].userId사용자 IDString
data[].senderKey발신자 키String
data[].phoneNumber수신자 전화번호String
data[].yellowId카카오톡 채널 IDString
data[].firstRegistPnttm최초 등록 시각 (yyyy‑MM‑dd HH:mm:ss)String
data[].firstRegisterId최초 등록자 IDString
-
-

※ JSON 객체로 응답합니다.

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

｛

-
-

- "resultCode":"0" -

-

- ,"data"｛ -

-
-

- ,"senderKey":"6691434xxxxxxxxxxxxxxxxxxxxxxxxx" -

-

- ,"phoneNumber":"010xxxxxxxx" -

-

- ,"yellowId":"@ID" -

-

- ,"firstRegistPnttm":"2025-10-05 18:08:58" -

-

- ,"firstRegisterId":"userId" -

-
-

｝

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
채널ID 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
키설명타입필수
mberId사용자 IDStringO
accessKey인증용 API KeyStringO
test_yn테스트 데이터 여부 (YS: 성공 테스트, YF: 실패 테스트)StringX
+
+

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

+

※ Content-Type: application/json

-

｝

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

｛

-
-

- "resultCode":"401" -

-

- ,"message":"Unauthorized" -

+ +
+
[Example]
+
+ 
+					
+{
+
+	"mberId": "홍길동",
+	
+	"accessKey": "XXXXXXXXXXXXXX414050694b953",
+	
+	"test_yn": ""
+}
+					
+
-

｝

+ + + +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
채널ID 조회 API Response 키 종류 및 설명, 타입 테이블
키설명타입
resultCode성공 여부("0" 이외는 실패)String
data조회 결과 목록(성공 시 배열, 실패 시 오류 메시지)Array | String
[data][i].senderKey발신 프로필 SenderKeyString
[data][i].phoneNumber대표 전화번호String
[data][i].yellowId카카오 채널(옐로아이디)String
[data][i].frstRegistPnttm최초 등록 일시(YYYY-MM-DD HH:mm:ss)String
[data][i].frstRegisterId최초 등록자 IDString
localDateTime서버 처리 일시(ISO-8601)String
+
+

※ JSON 객체로 응답합니다.

+
+
+ +
+
[Example]O 성공 예시
+
+ 
+					
+{
+	"resultCode": "0",
+	
+	"data": [
+	
+		{
+		
+			"senderKey": "test_sender_key_001",
+			
+			"phoneNumber": "02-1234-0000",
+			
+			"yellowId": "@test_channel_001",
+			
+			"frstRegistPnttm": "2025-09-09 12:44:21",
+			
+			"frstRegisterId": "test_id_one"
+			
+		},
+		
+		{
+		
+			"senderKey": "test_sender_key_002",
+			
+			"phoneNumber": "02-1234-0001",
+			
+			"yellowId": "@test_channel_002",
+			
+			"frstRegistPnttm": "2025-09-09 12:44:21",
+			
+			"frstRegisterId": "test_id_tow"
+			
+		}
+		
+	],
+	
+	"localDateTime": "2025-09-09T12:44:21.624464"
+	
+}
+					
+
+
+
+ +
+
[Example]X 실패 예시
+
+ 

+{
+
+	"resultCode": "2099",
+	
+	"data": "기타 시스템 오류"
+	
+}
+
+
+
+
-
diff --git a/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab2.jsp b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab2.jsp index 67d57e4a..e9f59634 100644 --- a/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab2.jsp +++ b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab2.jsp @@ -1,232 +1,326 @@ -<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> +<%@ page language="java" contentType="text/html; charset=UTF-8" + pageEncoding="UTF-8"%> + + +
    +
  • - API를 통해서 카카오 친구톡(FT)을 발송할 수 있습니다.
    • +
  • - 버튼 타입은 WL(웹링크), AL(앱링크)만 지원합니다.
    • +
  • - 대체문자(subMsgTxt) 발송 여부는 subMsgSendYn으로 제어합니다.
    • +
+
+ +
Request
+
+
+

Request

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
API Request Http Method, 프로토콜, HOST, Service Port, Endpoint 정보 테이블
Http MethodPOST
프로토콜HTTPS/1.1
HOSTapi.munjaon.co.kr
Service Port443
Endpoint/api/kakao/ft/sendMsg
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
친구톡 발송 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
키설명타입필수
mberId사용자 IDStringO
accessKey인증용 API KeyStringO
senderKey발신 프로필 SenderKeyStringO
adFlag광고 여부 (Y/N)StringO
subMsgSendYn대체문자 발송 여부 (Y/N)StringX
callFrom발신자 번호StringO
callTo_[i]수신자 번호StringO
templateContent_[i]친구톡 본문StringO
templateImage친구톡 이미지(PNG,JPG)FileX
subMsgTxt_[i]대체문자 내용StringX
button버튼 JSON 문자열(AL:앱링크, WL:웹링크 지원)String(JSON)X
test_yn테스트 데이터 여부 (YS: 성공 테스트, YF: 실패 테스트)StringX
+
+

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

+

※ Content-Type: application/json

+
+
+ +
+
[Example]
+
+ 
+					
+{
+
+	"mberId": "dudgusw",
+	
+	"accessKey": "3429312e6a2c732188d4cc7d15d8a1baa01d8d91",
+	
+	"senderKey": "e42e34ee013147720711b4add6d181adbe4ce45f",
+	
+	"adFlag": "N",
+	
+	"subMsgSendYn": "Y",
+	
+	"callFrom": "010-9341-4986",
+	
+	"callTo_1": "01083584250",
+	
+	"callTo_2": "01083584251",
+	
+	"templateContent_1": "친구톡 본문 1",
+	
+	"templateContent_2": "친구톡 본문 2",
+	
+	"subMsgTxt_1": "대체문자 발송1",
+	
+	"subMsgTxt_2": "대체문자 발송2",
+	
+	"{ button": [
+		
+		{
+		
+			"name": "주문조회",
 			
-                        
    
-                            
  • - API를 통해서 다른 내용의 문자를 대량으로 전송할 수 있습니다.
    • 
-                            
  • - 발신번호는 문자온 사이트를 통해 사전등록 후 이용하실 수 있습니다.(마이페이지-발신번호 관리 메뉴 이용)
    • 
-                            
  • - 문자 내용이 "90byte"를 초과하는 경우 장문(LMS)으로 자동 전환됩니다.
    • 
-                        

+			"linkType": "WL",
+			
+			"linkPc": "PC 링크",
+			
+			"linkMo": "모바일 링크"
+			
+		},
+		
+		{
+		
+			"name": "앱 열기",
+		
+			"linkType": "AL",
+		
+			"linkIos": "ios링크",
+		
+			"linkAnd": "Android 링크"
+		
+		}
+	]}"
+}
+					
+
+
+
+ -
- -
Request
-
-
-

Request

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

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

-
-
-
-
[Example]
-
-

｛

-
-

"mberId":"홍길동"

-

,"accessKey":"414050694b953XXXXXXXXXXXXXX"

-

,"senderKey":"669143473b1af459628b8bdXXXXXXXXXXXXXX"

-
-

｝

-
-
- - -
Response
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
문자발송(대량) API Response 키 종류 및 설명, 타입 테이블
키설명타입
resultCode성공 여부("0" 아니면 실패)String
data템플릿 정보 리스트Array
[data].senderKey발신 프로필 키String
[data].templateCode템플릿 코드String
[data].templateName템플릿 이름String
[data].createdAt생성일시String
[data].modifiedAt수정일시String
[data].serviceStatus템플릿 상태
(REG: 등록, REQ: 검수요청, REJ: 반려, -STP: 차단, RDY: 발송전, ACT: 정상, DMT: 휴면, BLK: -차단)		String
-
-

※ JSON 객체로 응답합니다.

-
-
-
-
[Example]O 성공 예시
+ +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
친구톡 발송 API Response 키 종류 및 설명, 타입 테이블
키설명타입
resultCode성공 여부("0" 이외는 실패)String
data발송 결과 객체Object
[data].resultCode내부 처리 결과("0": 성공)String
[data].msgType메시지 타입(FT: 친구톡)String
[data].msgGroupIdList발송된 메시지 그룹 ID 목록Array<String>
[data].successCnt성공 건수String | Number
[data].failCnt실패 건수String | Number
localDateTime서버 처리 일시(ISO-8601)String
+
+

※ JSON 객체로 응답합니다.

+
+
-
-

｛

-
-

- "resultCode":"0" -

-

- ,"data"｛ -

-
-

- ,"senderKey":"669143473b1af459628xxxxxxxxxxxxxxxxxxxxx" -

-

- ,"templateCode":"bizp_20250527112232xxxxxxxxxxxxx" -

-

- ,"templateName":"템플릿 명" -

-

- ,"createdAt":"2025-05-27 11:22:33" -

-

- ,"modifiedAt":"2025-05-27 11:22:33" -

-

- ,"serviceStatus":"REG(등록완료)" -

-
-

｝

-

,｛

-
-

- ,"senderKey":"669143473b1af459628xxxxxxxxxxxxxxxxxxxxx" -

-

- ,"templateCode":"bizp_20250527112232xxxxxxxxxxxxx" -

-

- ,"templateName":"템플릿 명2" -

-

- ,"createdAt":"2025-05-27 11:22:33" -

-

- ,"modifiedAt":"2025-05-27 11:22:33" -

-

- ,"serviceStatus":"RDY(대기)" -

-
-

｝

-
-

｝

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

｛

-
-

"resultCode":"4099"

-

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

-
-

｝

-
-
- -
+
+
[Example]O 성공 예시
+
+ 
+					
+{
+	"resultCode": "0",
+	
+	"data": {
+	
+		"resultCode": "0",
+		
+		"msgType": "FT",
+		
+		"msgGroupIdList": [
+		
+			"MSGGID_1758008282543",
+			
+			"MSGGID_1758008282543"
+			
+		],
+		
+		"successCnt": "2",
+		
+		"failCnt": "0"
+		
+	},
+	
+	"localDateTime": "2025-09-16T16:38:02.5436925"
+	
+}
+					
+
+
+
+ +
+
[Example]X 실패 예시
+
+ 

+{
+
+	"resultCode": "4420",
+	
+	"data": "버튼 타입은 WL/AL만 지원합니다.(button.linkType)"
+	
+}
+
+
+
+ +
+ +
diff --git a/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab3.jsp b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab3.jsp index c9570ab3..4b47c98b 100644 --- a/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab3.jsp +++ b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab3.jsp @@ -1,331 +1,433 @@ -<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> +<%@ page language="java" contentType="text/html; charset=UTF-8" + pageEncoding="UTF-8"%> + +
    +
  • - 문자온 사이트 및 API를 통해 전송된 발송내역을 조회할 수 있습니다.
    • +
  • - 문자 발송내역은 날짜별로 조회되며, 최근 3개월까지만 조회 가능합니다.
    • +
  • - 발신번호별 문자 발송내역 조회 기능은 제공되지 않습니다.
    • +
+ +
+ +
Request
+
+
+

Request

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

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

+

※ Content-Type: application/json

+
+
+ +
+
[Example]
+
+ 
+				
+{
+
+	"mberId": "홍길동",
+	
+	"accessKey": "XXXXXXXXXXXXXX414050694b953",
+	
+	"page": "",
+	
+	"pageSize": "",
+	
+	"startDate": "",
+	
+	"endDate": "",
+	
+	"test_yn": ""
+}
+				
+
+
+
+ + + +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
전송결과 조회 API Response 키 종류 및 설명, 타입 테이블
키설명타입
resultCode성공 여부("0" 아니면 실패)String
data결과값 객체(성공 : 데이터, 실패 : 메시지)Object | String
[data].message메시지(필요 시)String
[data].next_yn다음 페이지 여부(Y/N)String
[data].objectList결과값 목록Array<Object>
[data].objectList[i].msgGroupId메시지 그룹 IDString
[data].objectList[i].msgId메시지 IDString
[data].objectList[i].msgTypeName문자 구분명(단문, 장문, 그림)String
[data].objectList[i].msgType메시지 타입(4: 단문, 5: 장문, 6: 그림)String | Number
[data].objectList[i].callFrom발신자 번호String
[data].objectList[i].callTo수신자 번호String
[data].objectList[i].msgGroupCnt발송 건수String | Number
[data].objectList[i].scnt성공 건수String | Number
[data].objectList[i].fcnt실패 건수String | Number
[data].objectList[i].wcnt대기 건수String | Number
[data].objectList[i].msgResult발송 결과(성공: S, 실패: F)String
[data].objectList[i].smsTxt문자 내용String
[data].objectList[i].subject제목String | null
[data].objectList[i].reqdate발송 일자(YYYY-MM-DD HH:mm:ss)String
[data].objectList[i].curState전송 처리 결과값String | Number
[data].objectList[i].userId사용자 IDString
[data].objectList[i].regdate등록 일자(YYYY-MM-DD HH:mm:ss)String
[data].objectList[i].reserveCYn예약 취소 여부(Y/N)String
[data].ttlCnt전체 요청 수String | Number
[data].remainMsgCnt남은 문자 건수String | Number
[data].totMsgCnt전체 문자 개수String | Number
+
+

※ JSON 객체로 응답합니다.

+
+
+ +
+
[Example]O 성공 예시
+
+ 
+				
+{
+	"resultCode": "0",
+	
+	"data": {
+	
+		"resultCode": "0",
+		
+		"message": null,
+		
+		"next_yn": "n",
+		
+		"msgGroupId": "MSGGID_0000000000000",
+		
+		"objectList": [
+		
+			{
 			
-			 
    
-                            
  • - 문자온 사이트 및 API를 통해 전송된 문자 발송내역을 조회할 수 있습니다.
    • 
-                            
  • - 문자 발송내역은 날짜별로 조회되며, 최근 3개월까지만 조회 가능합니다.
    • 
-                            
  • - 발신번호별 문자 발송내역 조회 기능은 제공되지 않습니다.
    • 
-                        

+				"msgTypeName": "단문(SMS)",
+				
+				"msgType": "4",
+				
+				"callFrom": "01011112222",
+				
+				"callTo": "01011112223",
+				
+				"msgGroupCnt": "2",
+				
+				"msgGroupId": "MSGGID_0000000013340",
+				
+				"msgId": "MSGID_0000000000001",
+				
+				"scnt": "2",
+				
+				"fcnt": "0",
+				
+				"wcnt": "0",
+				
+				"msgResult": "S",
+				
+				"smsTxt": "문자 내용 단문 예제",
+				
+				"subject": null,
+				
+				"reqdate": "2023-06-13 17:48:07",
+				
+				"curState": "3",
+				
+				"userId": "testuser",
+				
+				"regdate": "2023-06-13 17:48:07",
+				
+				"reserveCYn": "N",
+				
+				"ttlCnt": "1",
+				
+				"remainMsgCnt": "40",
+				
+				"totMsgCnt": "70"
+				
+			},
+			
+			{
+			
+				"msgTypeName": "장문(LMS)",
+				
+				"msgType": "5",
+				
+				"callFrom": "01011112222",
+				
+				"callTo": "01011112223",
+				
+				"msgGroupCnt": "1",
+				
+				"msgGroupId": "MSGGID_0000000013341",
+				
+				"msgId": "MSGID_0000000000002",
+				
+				"scnt": "1",
+				
+				"fcnt": "0",
+				
+				"wcnt": "0",
+				
+				"msgResult": "S",
+				
+				"smsTxt": "문자 내용 장문 예제",
+				
+				"subject": null,
+				
+				"reqdate": "2023-06-02 11:46:50",
+				
+				"curState": "3",
+				
+				"userId": "testuser",
+				
+				"regdate": "2023-06-02 11:46:49",
+				
+				"reserveCYn": "N",
+				
+				"ttlCnt": "1",
+				
+				"remainMsgCnt": "40",
+				
+				"totMsgCnt": "70"
+				
+			}
+			
+		]
+		
+	}
+}
+				
+
+
+
-
- -
Request
-
-
-

Request

- - - - - - - - - - - - - - - - - - - - - - -
API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
Http MethodPOST
프로토콜HTTP/1.1
HOSTapi.munjaon.co.kr
Service Port443
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
전송결과 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
키설명타입필수
mberId사용자 IDStringO
accessKey인증용 API KeyStringO
senderKey발신 프로필 KeyStringO
templateCode템플릿 코드StringO
-
-

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

-
-
-
-
[Example]
-
-

｛

-
-

"mberId":"홍길동"

-

,"accessKey":"414050694b953XXXXXXXXXXXXXX"

-

,"senderKey":"669143473b1af459628b8bdXXXXXXXXXXXXXX"

-

,"templateCode":"bizp_202503141052XXXXXXXXXXXXXX"

-
-

｝

-
-
- - -
Response
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
+
[Example]X 실패 예시
+
+ 
+				
+{
 
-
-
전송결과 조회 API Response 키 종류 및 설명, 타입 테이블
키설명타입
resultCode성공 여부("0" 아니면 실패)String
data템플릿 정보 리스트Array
[data].templateCode템플릿 코드String
[data].templateName템플릿 이름String
[data].templateMessageType템플릿 메시지 유형 (BA:기본형(default), EX:부가정보형, AD:광고추가형, MI:복합형)String
[data].templateEmphasizeType템플릿 강조 유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, ITEM_LIST: 아이템리스트형)String
[data].templateContent템플릿 내용String
[data].templateExtra부가정보String
[data].templateAd광고성 메시지String
[data].templateImageName템플릿 이미지 파일명String
[data].templateImageUrl템플릿 이미지 링크String
[data].templateTitle템플릿 내용 중 강조 표기할 핵심 정보String
[data].templateSubtitle강조 표기 보조 문구String
[data].templateHeader헤더String
[data].categoryCode템플릿 카테고리 코드String
[data].securityFlag보안 템플릿 여부 (true:설정)Boolean
[data].inspectionStatus검수 상태 (REG: 등록, REQ: 검수요청, REJ: 반려, APR: 승인)String
[data].createdAt생성일String
[data].modifiedAt수정일String
[data].status템플릿 상태(D:중지, A:정상, R:대기(발송전))String
[data].block템플릿 차단 여부 (true:차단, false: 해제)Boolean
[data].dormant템플릿 휴면 여부 (true:휴면, false: 해제)Boolean
[data].templateItemHighlight아이템 하이라이트Object
[data].templateItemHighlight.title타이틀String
[data].templateItemHighlight.description상세 설명String
[data].templateItemHighlight.imageUrl썸네일 이미지 주소String
[data].templateItem아이템 정보Object
[data].templateItem.list[]아이템 리스트Array
[data].templateItem.list[].title타이틀String
[data].templateItem.list[].description디스크립션String
[data].templateItem.summary아이템 요약 정보Object
[data].templateItem.summary.title타이틀String
[data].templateItem.summary.description디스크립션String
[data].buttons[]버튼 정보Array
[data].buttons[].name버튼명String
[data].buttons[].linkType버튼 링크타입 (DS:배송조회, WL:웹링크, AL:앱링크, BK:봇키워드, MD: 메시지전달, AC: 채널추가, BC: 상담톡전환, BT: 봇전환, P1: 이미지 보안전송 플러그인, P2: 개인정보이용 플러그인, P3: 원클릭 결제 플러그인)String
[data].buttons[].linkAndAndroid 앱 링크 주소String
[data].buttons[].linkIosIOS 앱 링크 주소String
[data].buttons[].linkMo모바일 웹 링크 주소String
[data].buttons[].linkPcPC 웹 링크 주소String
[data].buttons[].pluginId플러그인 IDString
[data].quickReplies[]바로연결 정보Array
[data].quickReplies[].name바로연결명String
[data].quickReplies[].linkType바로연결 링크타입 (WL:웹링크, AL:앱링크, BK:봇키워드, MD: 메시지전달, BC: 상담톡전환, BT: 봇전환)String
[data].quickReplies[].linkAndAndroid 앱 링크 주소String
[data].quickReplies[].linkIosIOS 앱 링크 주소String
[data].quickReplies[].linkMo모바일 웹 링크 주소String
[data].quickReplies[].linkPcPC 웹 링크 주소String
[data].comments[]댓글 목록Array
[data].comments[].content댓글 본문String
[data].comments[].createdAt댓글 생성일String
[data].comments[].status댓글 상태 (REQ:등록, INQ:문의, APR:승인, REJ:반려, REP:답변)String
[data].comments[].userName댓글 작성자String
[data].comments[].attachment첨부파일Array
[data].comments[].attachment[]첨부파일Array
[data].comments[].attachment[].originalFileName업로드한 파일 이름String
[data].comments[].attachment[].filePath파일 다운로드 경로String
-
-

※ JSON 객체로 응답합니다.

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

｛

-
-

"resultCode":"0"

-

,"data":［

-

｛

-
-

"templateCode": "bizp_20250314105XXXXXXXXXXXXXXX"

-

,"templateName": "템플릿 명"

-

,"templateMessageType": "BA"

-

,"templateEmphasizeType": "TEXT"

-

,"templateContent": "템플릿 내용 예시"

-

,"templateExtra": "부가정보"

-

,"templateAd": "광고성 문구"

-

,"templateImageName": "template.jpg"

-

,"templateImageUrl": "https://cdn.example.com/image.jpg"

-

,"templateTitle": "강조 제목"

-

,"templateSubtitle": "보조 문구"

-

,"templateHeader": "템플릿 헤더"

-

,"categoryCode": "005001"

-

,"securityFlag": true

-

,"inspectionStatus": "REG"

-

,"createdAt": "2025-06-30 10:30:00"

-

,"modifiedAt": "2025-07-01 11:00:00"

-

,"status": "A"

-

,"block": false

-

,"dormant": false

- - -

,"templateItemHighlight": {

-
-

"title": "하이라이트 제목"

-

,"description": "하이라이트 설명"

-

,"imageUrl": "https://cdn.example.com/thumb.jpg"

-
-

}

- - -

,"templateItem": {

-
-

"list": [

-
-

｛

-

"title": "아이템 제목"

-

,"description": "아이템 설명"

-

｝

-
-

],

-

"summary": {

-
-

"title": "요약 제목"

-

,"description": "요약 설명"

-
-

}

-
-

}

- - -

,"buttons": [

-
-

｛

-

"name": "버튼명"

-

,"linkType": "WL"

-

,"linkAnd": "https://aos.example.com"

-

,"linkIos": "https://ios.example.com"

-

,"linkMo": "https://m.example.com"

-

,"linkPc": "https://www.example.com"

-

,"pluginId": "plugin123"

-

｝

-
-

]

- - -

,"quickReplies": [

-
-

｛

-

"name": "빠른응답"

-

,"linkType": "WL"

-

,"linkAnd": "https://aos.quick.com"

-

,"linkIos": "https://ios.quick.com"

-

,"linkMo": "https://m.quick.com"

-

,"linkPc": "https://www.quick.com"

-

｝

-
-

]

- - -

,"comments": [

-
-

｛

-

"content": "댓글 예시입니다."

-

,"createdAt": "2025-07-01 10:00:00"

-

,"status": "REQ"

-

,"userName": "관리자"

-

,"attachment": [

-
-

｛

-

"originalFileName": "example.pdf"

-

,"filePath": "/download/example.pdf"

-

｝

-
-

]

-

｝

-
-

]

-
-

｝

-

］

-
-

｝

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

｛

-
-

"resultCode":"4099"

-

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

-
-

｝

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

Request

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

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

-
-
-
-
[Example]
-
-

｛

-
-

"mberId":"홍길동"

-

,"accessKey":"XXXXXXXXXXXXXX414050694b953"

-

,"msgGroupId":"MSGGID_0000000011452"

-

,"page":""

-

,"pageSize":""

-

,"test_yn":""

-
-

｝

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

※ JSON 객체로 응답합니다.

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

｛

-
-

"resultCode":"0"

-

,"data":［

-

｛

-
-

"resultCode":"0"

-

,"message": null

-

,"next_yn":"n"

-

,"msgGroupId":"MSGGID_0000000000000"

-

,"objectList":［

-

｛

-
-

"msgTypeName":"단문(SMS)"

-

,"msgType":"4"

-

,"callFrom":"01011112222"

-

,"callTo":"01011112223"

-

,"msgGroupCnt":"2"

-

,"msgGroupId":"MSGGID_0000000013340"

-

,"msgId":"MSGID_0000000000001"

-

,"scnt":null

-

,"fcnt":null

-

,"wcnt":null

-

,"msgResult":"S"

-

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

-

,"subject":null

-

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

-

,"curState":"3"

-

,"userId":"testuser"

-

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

-

,"reserveCYn":"N"

-

,"ttlCnt":"10"

-

,"remainMsgCnt":"0"

-

,"totMsgCnt":"10"

-
-

｝

-

,｛

-
-

"msgTypeName":"단문(SMS)"

-

,"msgType":"4"

-

,"callFrom":"01011112222"

-

,"callTo":"01011112223"

-

,"msgGroupCnt":"2"

-

,"msgGroupId":"MSGGID_0000000013340"

-

,"msgId":"MSGID_0000000000002"

-

,"scnt":null

-

,"fcnt":null

-

,"wcnt":null

-

,"msgResult":"S"

-

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

-

,subject":null

-

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

-

,"curState":"3"

-

,"userId":"testuser"

-

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

-

,"reserveCYn":"N"

-

,"ttlCnt":"10"

-

,"remainMsgCnt":"0"

-

,"totMsgCnt":"10"

-

｝

-
-

］

-
-

｝

-

］

-
-

｝

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

｛

-
-

"resultCode":"4099"

-

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

-
-

｝

-
-
- -
+ +
    +
  • - API를 통해서 메시지 그룹 ID 기준의 상세 이력(개별 건) 목록을 조회할 수 있습니다.
    • +
+
+ +
Request
+
+
+

Request

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
API Request Http Method, 프로토콜, HOST, Service Port, Endpoint 정보 테이블
Http MethodPOST
프로토콜HTTPS/1.1
HOSTapi.munjaon.co.kr
Service Port443
Endpoint/api/inqry/hstryDetail
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
히스토리 상세 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
키설명타입필수
mberId사용자 IDStringO
accessKey인증용 API KeyStringO
msgGroupId메시지 그룹 IDStringO
+
+

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

+

※ Content-Type: application/json

+
+
+ +
+
[Example]
+
+ 
+					
+{
+
+	"mberId": "홍길동",
+	
+	"accessKey": "XXXXXXXXXXXXXX414050694b953",
+	
+	"msgGroupId": "MSGGID_XXXXXXX0000063"
+}
+					
+
+
+
+ + + +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
히스토리 상세 조회 API Response 키 종류 및 설명, 타입 테이블
키설명타입
resultCode성공 여부("0" 이외는 실패)String
data조회 결과 객체Object
[data].resultCode내부 처리 결과(0: 성공)Number | String
[data].objectList개별 메시지 상세 목록Array<Object>
[data].objectList[i].msgGroupId메시지 그룹 IDString
[data].objectList[i].msgId개별 메시지 IDString
[data].objectList[i].totMsgCnt총 발송 건수(그룹 기준)String
[data].objectList[i].msgType메시지 타입 코드(예: 8=AT)Number
[data].objectList[i].msgTypeName메시지 타입명String
[data].objectList[i].msgResult결과(F: 실패, S: 성공 등)String
[data].objectList[i].msgGroupCnt발송 건수Number
[data].objectList[i].smsTxt메시지 내용String
[data].objectList[i].callFrom발신 번호String
[data].objectList[i].callTo수신 번호String
[data].objectList[i].curState현재 상태 코드Number
[data].objectList[i].remainMsgCnt잔여 처리 건수Number
[data].objectList[i].reqdate요청 일시(YYYY-MM-DD HH:mm:ss)String
[data].objectList[i].regdate등록 일시(YYYY-MM-DD HH:mm:ss)String
[data].objectList[i].reserveCYn예약 취소 여부(Y/N)String
localDateTime서버 처리 일시(ISO-8601)String
+
+

※ JSON 객체로 응답합니다.

+
+
+ +
+
[Example]O 성공 예시
+
+ 
+					
+{
+	"resultCode": "0",
+	
+	"data": {
+	
+		"resultCode": 0,
+		
+		"objectList": [
+		
+			{
+			
+				"msgGroupId": "MSGGID_XXXXXXX0000063",
+				
+				"msgId": "MSGCID_XXXXXXX00001180",
+				
+				"totMsgCnt": "9",
+				
+				"msgType": 8,
+				
+				"msgTypeName": "알림톡(AT)",
+				
+				"msgResult": "F",
+				
+				"msgGroupCnt": 1,
+				
+				"smsTxt": "test",
+				
+				"callFrom": "01093414986",
+				
+				"callTo": "01059941669",
+				
+				"curState": 3,
+				
+				"remainMsgCnt": 0,
+				
+				"reqdate": "2025-09-05 11:45:45",
+				
+				"regdate": "2025-09-05 11:45:45",
+				
+				"reserveCYn": "N"
+				
+			},
+			
+			{
+			
+				"msgGroupId": "MSGGID_XXXXXXX0000063",
+				
+				"msgId": "MSGCID_XXXXXXX000001175",
+				
+				"totMsgCnt": "9",
+				
+				"msgType": 9,
+				
+				"msgTypeName": "친구톡(AT)",
+				
+				"msgResult": "F",
+				
+				"msgGroupCnt": 1,
+				
+				"smsTxt": "test",
+				
+				"callFrom": "01093414986",
+				
+				"callTo": "01098969885",
+				
+				"curState": 3,
+				
+				"remainMsgCnt": 0,
+				
+				"reqdate": "2025-09-05 11:45:45",
+				
+				"regdate": "2025-09-05 11:45:45",
+				
+				"reserveCYn": "N"
+				
+			},
+			
+		]
+		
+	},
+	
+	"localDateTime": "2025-09-16T10:47:20.4014362"
+	
+}
+					
+
+
+
+ +
+
[Example]X 실패 예시
+
+ 

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

Request

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

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

-
-
-
-
[Example]
-
-

｛

-
-

"mberId":"String"

-

,"accessKey":"String"

-
-

｝

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

※ JSON 객체로 응답합니다.

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

｛

-
-

"resultCode":"0"

-

,"data"｛

-
-

"longPrice":"50"

-

,"longSendPsbltEa":"19651"

-

,"mberMoney":"982586.7"

-

,"message":null

-

,"picturePrice":"90"

-

,"pictureSendPsbltEa":"10917"

-

,"shortPrice":"18"

-

,"shortSendPsbltEa":"54588"

-
-

｝

-
-

｝

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

｛

-
-

"resultCode":"5099"

-

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

-
-

｝

-
-
- -
+ +
    +
  • - 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS), 알림톡(AT), 친구톡(FT)별로 각각 확인할 수 있습니다.
    • + +
+ +
+ +
Request
+
+
+

Request

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

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

+

※ Content-Type: application/json

+
+
+ +
+
[Example]
+
+ 
+					
+{
+
+	"mberId": "홍길동",
+	
+	"accessKey": "XXXXXXXXXXXXXX414050694b953"
+}
+					
+
+
+
+ + + +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
가격/가능건수 조회 API Response 키 종류 및 설명, 타입 테이블
키설명타입
resultCode성공 여부("0" 이외는 실패)String
data조회 결과 객체(성공 시 가격/가능건수 정보)Object | String
[data].resultCode내부 처리 결과("0": 성공)String
[data].message메시지(필요 시)String
[data].localDateTime서버 처리 일시(ISO-8601)String
[data].shortPrice단문(SMS) 단가Number
[data].longPrice장문(LMS) 단가Number
[data].picturePrice사진(MMS) 단가Number
[data].kakaoAtPrice카카오 알림톡 단가Number
[data].kakaoFtPrice카카오 친구톡(텍스트) 단가Number
[data].kakaoFtImgPrice카카오 친구톡(이미지) 단가Number
[data].kakaoFtWideImgPrice카카오 친구톡(와이드 이미지) 단가Number
[data].mberMoney회원 보유 금액Number
[data].shortSendPsbltEa단문 발송 가능 건수Number
[data].longSendPsbltEa장문 발송 가능 건수Number
[data].pictureSendPsbltEa사진 발송 가능 건수Number
[data].kakaoAtSendPsbltEa알림톡 발송 가능 건수Number
[data].kakaoFtSendPsbltEa친구톡(텍스트) 발송 가능 건수Number
[data].kakaoFtImgSendPsbltEa친구톡(이미지) 발송 가능 건수Number
[data].kakaoFtWideImgSendPsbltEa친구톡(와이드 이미지) 발송 가능 건수Number
localDateTime서버 처리 일시(ISO-8601)String
+
+

※ JSON 객체로 응답합니다.

+
+
+ +
+
[Example]O 성공 예시
+
+ 
+					
+{
+	"resultCode": "0",
+	
+	"data": {
+	
+		"resultCode": "0",
+		
+		"message": "",
+		
+		"localDateTime": "2025-09-16T11:06:40.2556646",
+		
+		"shortPrice": 18.0,
+		
+		"longPrice": 50.0,
+		
+		"picturePrice": 90.0,
+		
+		"kakaoAtPrice": 6.9,
+		
+		"kakaoFtPrice": 13.8,
+		
+		"kakaoFtImgPrice": 19.9,
+		
+		"kakaoFtWideImgPrice": 22.9,
+		
+		"mberMoney": 6549661.26,
+		
+		"shortSendPsbltEa": 363870,
+		
+		"longSendPsbltEa": 130993,
+		
+		"pictureSendPsbltEa": 72774,
+		
+		"kakaoAtSendPsbltEa": 949226,
+		
+		"kakaoFtSendPsbltEa": 474613,
+		
+		"kakaoFtImgSendPsbltEa": 329128,
+		
+		"kakaoFtWideImgSendPsbltEa": 286011
+		
+	},
+	
+	"localDateTime": "2025-09-16T11:06:40.2556646"
+	
+}
+					
+
+
+
+ +
+
[Example]X 실패 예시
+
+ 

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

Request

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

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

-
-
-
-
[Example]
-
-

｛

-
-

"mberId":"String"

-

,"accessKey":"String"

-
-

｝

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

※ JSON 객체로 응답합니다.

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

｛

-
-

"resultCode":"0"

-

,"data"｛

-
-

"longPrice":"50"

-

,"longSendPsbltEa":"19651"

-

,"mberMoney":"982586.7"

-

,"message":null

-

,"picturePrice":"90"

-

,"pictureSendPsbltEa":"10917"

-

,"shortPrice":"18"

-

,"shortSendPsbltEa":"54588"

-
-

｝

-
-

｝

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

｛

-
-

"resultCode":"5099"

-

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

-
-

｝

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

Request

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

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

-
-
-
-
[Example]
-
-

｛

-
-

"mberId":"String"

-

,"accessKey":"String"

-
-

｝

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

※ JSON 객체로 응답합니다.

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

｛

-
-

"resultCode":"0"

-

,"data"｛

-
-

"longPrice":"50"

-

,"longSendPsbltEa":"19651"

-

,"mberMoney":"982586.7"

-

,"message":null

-

,"picturePrice":"90"

-

,"pictureSendPsbltEa":"10917"

-

,"shortPrice":"18"

-

,"shortSendPsbltEa":"54588"

-
-

｝

-
-

｝

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

｛

-
-

"resultCode":"5099"

-

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

-
-

｝

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

Request

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

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

-
-
-
-
[Example]
-
-

｛

-
-

"mberId":"String"

-

,"accessKey":"String"

-
-

｝

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

※ JSON 객체로 응답합니다.

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

｛

-
-

"resultCode":"0"

-

,"data"｛

-
-

"longPrice":"50"

-

,"longSendPsbltEa":"19651"

-

,"mberMoney":"982586.7"

-

,"message":null

-

,"picturePrice":"90"

-

,"pictureSendPsbltEa":"10917"

-

,"shortPrice":"18"

-

,"shortSendPsbltEa":"54588"

-
-

｝

-
-

｝

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

｛

-
-

"resultCode":"5099"

-

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

-
-

｝

-
-
- -
diff --git a/src/main/webapp/publish/js/highlight/styles/arta.css b/src/main/webapp/publish/js/highlight/styles/arta.css index 98a5b2b6..776f9eb5 100644 --- a/src/main/webapp/publish/js/highlight/styles/arta.css +++ b/src/main/webapp/publish/js/highlight/styles/arta.css @@ -1,66 +1,119 @@ pre code.hljs { - display: block; - overflow-x: auto; - padding: 1em + display: block; + overflow-x: auto; + padding: 1em } + code.hljs { - padding: 3px 5px + padding: 3px 5px } /* Date: 17.V.2011 Author: pumbur */ .hljs { - background: #222; - color: #aaa + background: #222; + color: #aaa } + .hljs-subst { - color: #aaa + color: #aaa } + .hljs-section { - color: #fff + color: #fff } -.hljs-comment, -.hljs-quote, -.hljs-meta { - color: #444 + +.hljs-comment, .hljs-quote, .hljs-meta { + color: #444 } -.hljs-string, -.hljs-symbol, -.hljs-bullet, -.hljs-regexp { - color: #ffcc33 + +.hljs-string, .hljs-symbol, .hljs-bullet, .hljs-regexp { + color: #ffcc33 } -.hljs-number, -.hljs-addition { - color: #00cc66 + +.hljs-number, .hljs-addition { + color: #00cc66 } -.hljs-built_in, -.hljs-literal, -.hljs-type, -.hljs-template-variable, -.hljs-attribute, -.hljs-link { - color: #32aaee + +.hljs-built_in, .hljs-literal, .hljs-type, .hljs-template-variable, + .hljs-attribute, .hljs-link { + color: #32aaee } -.hljs-keyword, -.hljs-selector-tag, -.hljs-name, -.hljs-selector-id, -.hljs-selector-class { - color: #6644aa + +.hljs-keyword, .hljs-selector-tag, .hljs-name, .hljs-selector-id, + .hljs-selector-class { + color: #6644aa } -.hljs-title, -.hljs-variable, -.hljs-deletion, -.hljs-template-tag { - color: #bb1166 + +.hljs-title, .hljs-variable, .hljs-deletion, .hljs-template-tag { + color: #bb1166 } -.hljs-section, -.hljs-doctag, -.hljs-strong { - font-weight: bold + +.hljs-section, .hljs-doctag, .hljs-strong { + font-weight: bold } + .hljs-emphasis { - font-style: italic + font-style: italic +} + +pre code.hljs { + display: block; + overflow-x: auto; + padding: 1em +} + +code.hljs { + padding: 3px 5px +} +/* +Date: 17.V.2011 +Author: pumbur +*/ +.hljs { + background: #222; + color: #aaa +} + +.hljs-subst { + color: #fff +} + +.hljs-section { + color: #fff +} + +.hljs-comment, .hljs-quote, .hljs-meta { + color: #444 +} + +.hljs-string, .hljs-symbol, .hljs-bullet, .hljs-regexp { + color: #ffcc33 +} + +.hljs-number, .hljs-addition { + color: #fff +} + +.hljs-built_in, .hljs-literal, .hljs-type, .hljs-template-variable, + .hljs-attribute, .hljs-link { + color: #32aaee +} + +.hljs-keyword, .hljs-selector-tag, .hljs-name, .hljs-selector-id, + .hljs-selector-class { + color: #6644aa +} + +.hljs-title, .hljs-variable, .hljs-deletion, .hljs-template-tag { + color: #bb1166 +} + +.hljs-section, .hljs-doctag, .hljs-strong { + font-weight: bold +} + +.hljs-emphasis { + font-style: italic } \ No newline at end of file