diff --git a/src/main/webapp/publish/api_admin1.html b/src/main/webapp/publish/api_admin1.html new file mode 100644 index 00000000..448bf6de --- /dev/null +++ b/src/main/webapp/publish/api_admin1.html @@ -0,0 +1,333 @@ + + + + + + + 문자온 API 소개 + + + + + + + + + + + + + + + + + + +
+ 본문 바로가기 +
+ + +
+
+

QUICK
MENU

+

QUICK

+ + +
+
+ + +
+ +
+
+ + +
+
+ +
+
+

문자온 CI

+ +
+ 문자검색 + + +
+
+ +
+
+
+ + + +
+
+

인기검색어

+ +
+ +
+
+ +
+ +
+
+ + +
+
+ +
+ + + +
+
+ +
+ +
    +
    • +
    • +
    • +
    • +
+ + +
+
+

신청/관리

+
+ + + +
+
API 신청 정보
+
+ + + + + + + + + + + + + + + + + + + + + +
API 신청 일시, 승인 일시, 상태, 관리 테이블
신청 일시승인 일시상태관리
신청 내역이 없습니다.
+
+ +
+ + +
+
API KEY 관리
+
+ + + + + + + + + + + + + + + + + + + + + +
API KEY 생성 일시, API KEY, 상태, 관리 테이블
생성 일시API KEY상태관리
API KEY 발급 내역이 없습니다.
+
+

* API KEY는 계정당 1개만 제공됩니다.

+
+ + +
+
API 사용 IP 관리
+
+ + + + + + + + + + + + + + + + + + + +
IP 등록 일시, IP, 관리 테이블
등록 일시IP관리
사용 IP 등록 내역이 없습니다.
+
+
+ + +
+
+
+ +
+ + + + + + + + \ No newline at end of file diff --git a/src/main/webapp/publish/api_admin2.html b/src/main/webapp/publish/api_admin2.html new file mode 100644 index 00000000..ed76df4f --- /dev/null +++ b/src/main/webapp/publish/api_admin2.html @@ -0,0 +1,337 @@ + + + + + + + 문자온 API 소개 + + + + + + + + + + + + + + + + + + +
+ 본문 바로가기 +
+ + +
+
+

QUICK
MENU

+

QUICK

+ + +
+
+ + +
+ +
+
+ + +
+
+ +
+
+

문자온 CI

+ +
+ 문자검색 + + +
+
+ +
+
+
+ + + +
+
+

인기검색어

+ +
+ +
+
+ +
+ +
+
+ + +
+
+ +
+ + + +
+
+ +
+ +
    +
    • +
    • +
    • +
    • +
+ + +
+
+

신청/관리

+
+ + + +
+
API 신청 정보
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
API 신청 일시, 승인 일시, 상태, 관리 테이블
신청 일시승인 일시상태관리
2023-06-27 09:40:04.0-심사중
+
+
+ + + +
+
API KEY 관리
+
+ + + + + + + + + + + + + + + + + + + + + +
API KEY 생성 일시, API KEY, 상태, 관리 테이블
생성 일시API KEY상태관리
API KEY 발급 내역이 없습니다.
+
+

* API KEY는 계정당 1개만 제공됩니다.

+
+ + + +
+
API 사용 IP 관리
+
+ + + + + + + + + + + + + + + + + + + +
IP 등록 일시, IP, 관리 테이블
등록 일시IP관리
사용 IP 등록 내역이 없습니다.
+
+
+ + +
+
+
+ +
+ + + + + + + + \ No newline at end of file diff --git a/src/main/webapp/publish/api_admin3.html b/src/main/webapp/publish/api_admin3.html new file mode 100644 index 00000000..0b0831fa --- /dev/null +++ b/src/main/webapp/publish/api_admin3.html @@ -0,0 +1,346 @@ + + + + + + + 문자온 API 소개 + + + + + + + + + + + + + + + + + + +
+ 본문 바로가기 +
+ + +
+
+

QUICK
MENU

+

QUICK

+ + +
+
+ + +
+ +
+
+ + +
+
+ +
+
+

문자온 CI

+ +
+ 문자검색 + + +
+
+ +
+
+
+ + + +
+
+

인기검색어

+ +
+ +
+
+ +
+ +
+
+ + +
+
+ +
+ + + +
+
+ +
+ +
    +
    • +
    • +
    • +
    • +
+ + +
+
+

신청/관리

+
+ + + +
+
API 신청 정보
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
API 신청 일시, 승인 일시, 상태, 관리 테이블
신청 일시승인 일시상태관리
2023-06-27 09:40:04.02023-06-27 09:40:04.0사용중
+
+
+ + +
+
API KEY 관리
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
API KEY 생성 일시, API KEY, 상태, 관리 테이블
생성 일시API KEY상태관리
2023-06-27 09:40:04.0e515ad4d369b5d02e2ca397c5362ebece0bc34c5사용
+
+

* API KEY는 계정당 1개만 제공됩니다.

+
+ + + +
+
API 사용 IP 관리
+
+ + + + + + + + + + + + + + + + + + + +
IP 등록 일시, IP, 관리 테이블
등록 일시IP관리
사용 IP 등록 내역이 없습니다.
+
+ +
+
IP입력 :
+
+

* 대역 등록을 원하실 경우 상위 IP만 작성하시면 됩니다. ex） 92.168.255.0 ~ 192.168.255.255 대역을 등록할 경우 192.168. 255. 입력

+

* IP는 최대 10개까지 등록 가능합니다. 단, IP 대역은 1개의 IP로 계산합니다.

+ +
+ + +
+
+
+ +
+ + + + + + + + \ No newline at end of file diff --git a/src/main/webapp/publish/api_admin4.html b/src/main/webapp/publish/api_admin4.html new file mode 100644 index 00000000..431c30ba --- /dev/null +++ b/src/main/webapp/publish/api_admin4.html @@ -0,0 +1,349 @@ + + + + + + + 문자온 API 소개 + + + + + + + + + + + + + + + + + + +
+ 본문 바로가기 +
+ + +
+
+

QUICK
MENU

+

QUICK

+ + +
+
+ + +
+ +
+
+ + +
+
+ +
+
+

문자온 CI

+ +
+ 문자검색 + + +
+
+ +
+
+
+ + + +
+
+

인기검색어

+ +
+ +
+
+ +
+ +
+
+ + +
+
+ +
+ + + +
+
+ +
+ +
    +
    • +
    • +
    • +
    • +
+ + +
+
+

신청/관리

+
+ + + +
+
API 신청 정보
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
API 신청 일시, 승인 일시, 상태, 관리 테이블
신청 일시승인 일시상태관리
2023-06-27 09:40:04.02023-06-27 09:40:04.0사용중
+
+
+ + + +
+
API KEY 관리
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
API KEY 생성 일시, API KEY, 상태, 관리 테이블
생성 일시API KEY상태관리
2023-06-27 09:40:04.0e515ad4d369b5d02e2ca397c5362ebece0bc34c5사용
+
+

* API KEY는 계정당 1개만 제공됩니다.

+
+ + + +
+
API 사용 IP 관리
+
+ + + + + + + + + + + + + + + + + + + + + +
IP 등록 일시, IP, 관리 테이블
등록 일시IP관리
2023-06-27 09:40:04.0e515ad4d369b5d02e2ca397c5362ebece0bc34c5
+
+ +
+
IP입력 :
+
+

* 대역 등록을 원하실 경우 상위 IP만 작성하시면 됩니다. ex） 92.168.255.0 ~ 192.168.255.255 대역을 등록할 경우 192.168. 255. 입력

+

* IP는 최대 10개까지 등록 가능합니다. 단, IP 대역은 1개의 IP로 계산합니다.

+ +
+ + +
+
+
+ +
+ + + + + + + + \ No newline at end of file diff --git a/src/main/webapp/publish/api_download.html b/src/main/webapp/publish/api_download.html new file mode 100644 index 00000000..7475e50a --- /dev/null +++ b/src/main/webapp/publish/api_download.html @@ -0,0 +1,507 @@ + + + + + + + 문자온 API 소개 + + + + + + + + + + + + + + + + + + +
+ 본문 바로가기 +
+ + +
+
+

QUICK
MENU

+

QUICK

+ + +
+
+ + +
+ +
+
+ + +
+
+ +
+
+

문자온 CI

+ +
+ 문자검색 + + +
+
+ +
+
+
+ + + +
+
+

인기검색어

+ +
+ +
+
+ +
+ +
+
+ + +
+
+ +
+ + + +
+
+ +
+ +
    +
    • +
    • +
    • +
    • +
+ + +
+
+

예제 다운로드

+
+ + +
+
    +
  • - 아래 예제(JSP)를 참고하시어 쉽고 편리하게 API를 연동할 수 있습니다.
    • +
  • - JSP 외 타 예제는 계속해서 업데이트 될 예정입니다.
    • +
+ +
+ +
    +
  • +
    • +
+ +
+ + +
+
+
+

JSP Example

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
JSP 샘플 파일 설명 테이블
jsp_example_send_msg_r1.jsp문자보내기(여러명에게 동일한문자)
sp_example_send_msgs_r1.jsp문자보내기(여러명에게 다른문자)
jsp_example_hstry_r1.jsp전송내역조회
jsp_example_hstry_detail_r1.jsp상세전송내역조회
jsp_example_select_price_r1.jsp발송가능건수
+
+
+
+ +
+
+ + +
+
+
+

ASP Example

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
ASP 샘플 파일 설명 테이블
파일명파일 설명
파일명파일 설명
파일명파일 설명
파일명파일 설명
파일명파일 설명
+
+
+
+ +
+
+ + +
+
+
+

PHP Example

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
PHP 샘플 파일 설명 테이블
파일명파일 설명
파일명파일 설명
파일명파일 설명
파일명파일 설명
파일명파일 설명
+
+
+
+ +
+
+ + +
+
+
+

.NET Example

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
.NET 샘플 파일 설명 테이블
파일명파일 설명
파일명파일 설명
파일명파일 설명
파일명파일 설명
파일명파일 설명
+
+
+
+ +
+
+ + +
+
+
+

AOS Example

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AOS 샘플 파일 설명 테이블
파일명파일 설명
파일명파일 설명
파일명파일 설명
파일명파일 설명
파일명파일 설명
+
+
+
+ +
+
+ + +
+
+
+

IOS Example

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
IOS 샘플 파일 설명 테이블
파일명파일 설명
파일명파일 설명
파일명파일 설명
파일명파일 설명
파일명파일 설명
+
+
+
+ +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + \ No newline at end of file diff --git a/src/main/webapp/publish/api_guide.html b/src/main/webapp/publish/api_guide.html new file mode 100644 index 00000000..fde0167f --- /dev/null +++ b/src/main/webapp/publish/api_guide.html @@ -0,0 +1,1644 @@ + + + + + + + 문자온 API 소개 + + + + + + + + + + + + + + + + + + +
+ 본문 바로가기 +
+ + +
+
+

QUICK
MENU

+

QUICK

+ + +
+
+ + +
+ +
+
+ + +
+
+ +
+
+

문자온 CI

+ +
+ 문자검색 + + +
+
+ +
+
+
+ + + +
+
+

인기검색어

+ +
+ +
+
+ +
+ +
+
+ + +
+
+ +
+ + + +
+
+ +
+ +
    +
    • +
    • +
    • +
    • +
+ + +
+
+

API 사용안내

+
+ + + +
+
    +
    • +
    • +
    • +
    • +
    • +
+
+ + +
+
    +
  • - API를 통해서 동일한 내용의 문자를 대량으로 전송할 수 있습니다.
    • +
  • - 발신번호는 문자온 사이트를 통해 사전등록 후 이용하실 수 있습니다.(마이페이지-발신번호 관리 메뉴 이용)
    • +
  • - 문자 내용이 "90byte"를 초과하는 경우 장문(LMS)으로 자동 전환됩니다.
    • +
+ +
+ +
Request
+
+
+

Request

+ + + + + + + + + + + + + + + + + + + + + + +
API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
Http MethodPOST
프로토콜HHTP/1.1
HOSTapi.munjaon.co.kr
Service Port443
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
문자발송 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
키설명타입필수
mberId사용자 IDStringO
accessKey인증용 API KeyStringO
callFrom발신자 번호(아이디에 등록되어 있는 번호)StringO
callToList수신자 번호(콤마(,) 기준으로 입력)StringO
smsTxt메시지 내용String(1~2,000Byte)O
nameStr메시지 내용에 [*이름*]이 있으면 치환용 이름 입력( | 로 구분 )StringX
test_yn테스트 데이터 여부StringX
+
+

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

+

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

+
+
+
+
[Example]
+
+

｛

+
+

"mberId":"홍길동"

+

,"accessKey":"XXXXXXXXXXXXXX414050694b953"

+

,"callFrom":"01012341234"

+

,"callToList":"01011111111,01022222222,01033333333"

+

,"smsTxt":"문자 테스트~![*이름*]"

+

,"nameStr":"홍길동1|홍길동2|홍길동3"

+

,"test_yn":""

+
+

｝

+
+
+ + +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
문자발송 API Response 키 종류 및 설명, 타입 테이블
키설명타입
resultCode성공 여부("0" 아니면 실패)String
data결과값 객체(성공 : 데이터, 실패 : 메시지)Object
[data].msgGroupId메시지 그룹 IDString
[data].msgType메시지 타입(4 : 단문, 5 : 장문)String
[data].blockCnt수신거부 건수String
[data].failCnt전송 실패 건수String
[data].successCnt성공 건수String
[data].test_yn테스트 데이터 여부String
+
+

※ JSON 객체로 응답합니다.

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

｛

+
+

"resultCode":"0"

+

,"data"｛

+
+

"msgGroupId":"MSGGID_0000000000000"

+

,"msgType":"SMS"

+

,"resultCode":"0"

+

,"blockCnt":"0"

+

,"failCnt":"0"

+

,"successCnt":"3"

+

,"test_yn":null

+
+

｝

+
+

｝

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

｛

+
+

"resultCode":"1040"

+

,"data":"치환 데이터 오류"

+
+

｝

+
+
+ +
+
+ + +
+
    +
  • - API를 통해서 다른 내용의 문자를 대량으로 전송할 수 있습니다.
    • +
  • - 발신번호는 문자온 사이트를 통해 사전등록 후 이용하실 수 있습니다.(마이페이지-발신번호 관리 메뉴 이용)
    • +
  • - 문자 내용이 "90byte"를 초과하는 경우 장문(LMS)으로 자동 전환됩니다.
    • +
+ +
+ +
Request
+
+
+

Request

+ + + + + + + + + + + + + + + + + + + + + + +
API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
Http MethodPOST
프로토콜HHTP/1.1
HOSTapi.munjaon.co.kr
Service Port443
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
문자발송(대량) API Request 키 종류 및 설명, 타입, 필수 여부 테이블
키설명타입필수
mberId사용자 IDStringO
accessKey인증용 API KeyStringO
callFrom발신자 번호(아이디에 등록되어 있는 번호)StringO
test_yn테스트 데이터 여부StringX
callTo_1수신자 번호 1StringO
smsTxt_1메시지 내용 1 String(1~2,000Byte)O
............
callTo_100수신자 번호 100StringO
smsTxt_100메시지 내용 100String(1~2,000Byte)O
+
+

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

+
+
+
+
[Example]
+
+

｛

+
+

"mberId":"홍길동"

+

,"accessKey":"XXXXXXXXXXXXXX414050694b953"

+

,"callFrom":"01012341234"

+

,"test_yn":""

+

,"callTo_1":"01011111111"

+

,"smsTxt_1":"문자 테스트 1"

+

,"callTo_2":"01022222222"

+

,"smsTxt_2":"문자 테스트 2"

+
+

｝

+
+
+ + +
Response
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
문자발송(대량) API Response 키 종류 및 설명, 타입 테이블
키설명타입
resultCode성공 여부("0" 아니면 실패)String
data결과값 객체(성공 : 데이터, 실패 : 메시지)Object
[data].msgGroupIdList메시지 그룹 ID 리스트List String
[data].msgType메시지 타입(4 : 단문, 5 : 장문)String
[data].blockCnt수신거부 건수String
[data].failCnt전송 실패 건수String
[data].successCnt성공 건수String
[data].test_yn테스트 데이터 여부String
+
+

※ JSON 객체로 응답합니다.

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

｛

+
+

"resultCode":"0"

+

,"data":［

+
+

"msgGroupIdList":［

+

｛

+

"MSGGID_0000000013451"

+

｝

+

,｛

+

"MSGGID_0000000013452"

+

｝

+

］

+

,"msgTypeList":［

+

｛

+

"SMS"

+

｝

+

,｛

+

"SMS"

+

｝

+

］

+

,"resultCode":"0"

+

,"successCnt":"2"

+

,"failCnt":"0"

+

,"blockCnt":"0"

+

,"test_yn":null

+

］

+
+
+

｝

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

｛

+
+

"resultCode":"1040"

+

,"data":"치환 데이터 오류"

+
+

｝

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

Request

+ + + + + + + + + + + + + + + + + + + + + + +
API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
Http MethodPOST
프로토콜HHTP/1.1
HOSTapi.munjaon.co.kr
Service Port443
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
전송결과 조회 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 : 단문, 5 : 장문)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":"기타 시스템 오류"

+
+

｝

+
+
+ +
+
+ + +
+
    +
  • - 전송결과 조회의 "msgGroupId"를 사용하여 전송된 문자의 상세결과를 수신번호별로 조회할 수 있습니다.
    • +
  • - 전송결과가 "대기"인 경우에는 최종 결과 확인까지 최대 72시간까지 소요됩니다.
    • +
+ +
+ +
Request
+
+
+

Request

+ + + + + + + + + + + + + + + + + + + + + + +
API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
Http MethodPOST
프로토콜HHTP/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 : 단문, 5 : 장문)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":"기타 시스템 오류"

+
+

｝

+
+
+ +
+
+ + +
+
    +
  • - 보유캐시로 발송 가능한 문자의 건수를 단문(SMS), 장문(LMS), 그림(MMS)별로 각각 확인할 수 있습니다.
    • +
  • - 위 문자유형별 발송 가능건수는 개인별로 적용된 단가를 기준으로 산출되며, "첫결제 이벤트"는 적용되지 않습니다.
    • +
+ +
+ +
Request
+
+
+

Request

+ + + + + + + + + + + + + + + + + + + + + + +
API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
Http MethodPOST
프로토콜HHTP/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":"기타 시스템 오류"

+
+

｝

+
+
+ +
+
+ + +
+
+
+ +
+ + + + + + + + \ No newline at end of file diff --git a/src/main/webapp/publish/api_intro.html b/src/main/webapp/publish/api_intro.html new file mode 100644 index 00000000..51aa433a --- /dev/null +++ b/src/main/webapp/publish/api_intro.html @@ -0,0 +1,310 @@ + + + + + + + 문자온 API 소개 + + + + + + + + + + + + + + + + + + +
+ 본문 바로가기 +
+ + +
+
+

QUICK
MENU

+

QUICK

+ + +
+
+ + +
+ +
+
+ + +
+
+ +
+
+

문자온 CI

+ +
+ 문자검색 + + +
+
+ +
+
+
+ + + +
+
+

인기검색어

+ +
+ +
+
+ +
+ +
+
+ + +
+
+ +
+ + + +
+
+ +
+ +
    +
    • +
    • +
    • +
    • +
+ + +
+
+

문자 API 소개

+
+ + +
+ 문자 API도 이제 '문자온!'' 별도의 프로그램 설치 없이 누구나 쉽고 편리하게 문자를 발송할 수 있습니다. + + 문자 API 신청하기 + +
+ + +
+
+

문자 API 사용 절차

+
+ +
+
+
+
+ +
+
    +
  • +

    STEP 01

    +
    +
    문자 API 신청 아이콘
    +
    +
    문자 API 신청
    +
    관리자 승인 후 사용 가능
    +
    +
    +
    • +
  • +

    STEP 02

    +
    +
    관리자 승인 아이콘
    +
    +
    관리자 승인
    +
    승인 완료 시 문자 안내
    +
    +
    +
    • +
  • +

    STEP 03

    +
    +
    아이피(IP) 등록 아이콘
    +
    +
    아이피(IP) 등록
    +
    문자 API를 통해 문자 발송 서버 IP 등록
    +
    +
    +
    • +
  • +

    STEP 04

    +
    +
    API 연동 아이콘
    +
    +
    API 연동
    +
    API 사용 매뉴얼 및 샘플링을 통해 누구나 손쉽게 연동 가능
    + +
    +
    • +
+
+
+ + +
+
+
+ +
+ + + + + + + + \ No newline at end of file diff --git a/src/main/webapp/publish/guide_2022.html b/src/main/webapp/publish/guide_2022.html index 799605b9..46b19898 100644 --- a/src/main/webapp/publish/guide_2022.html +++ b/src/main/webapp/publish/guide_2022.html @@ -18,10 +18,14 @@