diff --git a/src/main/webapp/publish/api_guide.html b/src/main/webapp/publish/api_guide.html index 0b084e01..b19fd7e1 100644 --- a/src/main/webapp/publish/api_guide.html +++ b/src/main/webapp/publish/api_guide.html @@ -198,7 +198,8 @@
@@ -1605,7 +1606,7 @@ - +
@@ -1613,11 +1614,10 @@
    • -
    • -
    • -
    • -
    • -
    • +
    • +
    • +
    • +
    • @@ -3400,8 +3400,995 @@
    + + + + +
    +
    + + + +
    +
    + + +
    + +
    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":"치환 데이터 오류"

    +
    +

    ｝

    +
    +
    + +
    + +
    +
    + + + +
    + +
    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":"기타 시스템 오류"

    +
    +

    ｝

    +
    +
    + +
    + +
    +
    + + + +
    + +
    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":"기타 시스템 오류"

    +
    +

    ｝

    +
    +
    + +
    +
    +
    + + + +
    + +
    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":"기타 시스템 오류"

    +
    +

    ｝

    +
    +
    + +
    +
    +
    +
    - +