QUICK MENU
카카오톡 친구맺기
텔레그램 메시지보내기
공지사항

문레터 이용 약관 개정 공지

★지금 가입하세요! 2999년까지 요금 고정!★

★2021 힘내소! 힘내소! 프로젝트! 캐시 10%로 더 드리겠소!★

API
문자 API
API 가이드
마이 API

고객센터

1811-7353

이용요금안내

이용가이드
  • 문자발송
  • 예약문자 발송 취소
  • 문자 리스트 조회
  • 문자 상세 조회
  • 문자 발송정보
API 기본정보
API명 문자발송
- SMS/LMS/MMS 문자 메시지를 발송합니다.
API URL POST - https://www.api.moonletter.co.kr/api/v1/sms/messages
주소 파라미터
항목 Mandatory Type 설명 비고
N/A
요청 헤더
항목 Mandatory Type 설명 비고
apiKey Mandatory String 인증키 발급 받은 인증키
apiUser Mandatory String 사용자 아이디 사용자 아이디
요청 파라미터
항목 Mandatory Type 설명 비고
typeMandatoryString문자 유형SMS:단문문자
LMS:장문문자
MMS:포토문자
sendNbMandatoryString발신번호사전 등록된 발신번호만 사용가능
messageMandatoryString메시지 내용SMS:최대 90byte
LMS,MMS:최대 2,000byte
광고 문자일 경우 '무료거부 0803070002'내용이 추가됩니다.
(광고)문구 붙어졌을 때 자동으로 광고 문자로 변환됩니다.
adYnMandatoryString문자 구분N:일반문자
Y:광고문자
receiveNbMandatoryString문자 수신번호문자 수신자 구분자 ^
예시: 010-0000-0001^010-0000-0002
최대 999건 문자 발송 가능
reserveYnOptionalString발송 형태N:즉시발송
Y:예약발송
reserveDtOptionalString예약 일시예약문자일 경우 입력(년월일시분)
예)202101010900
files.nameOptionalString파일명Jpg,jpeg, png 파일만 허용
최대 40자
파일 확장자 필수
files.bodyOptionalString파일 바디이미지를 Base64로 인코딩한 값
파일 최대 사이즈:300kbyte
groupIdOptionalString주소록 그룹 아이디주소록 그룹 전송 시 사용
요청 예시(Json)
요청 
{
    "message" : "messages"
    , "sendNb" : "010-0000-0001"
    , "receiveNb" : "010-0000-0002"
    , "type" : "SMS"
    , "adYn" : "N"
}

{
    "message" : "messages"
    , "sendNb" : "010-0000-0002"
    , "receiveNb" : "010-0000-0002"
    , "type" : "LMS"
    , "adYn" : "N"
}

{
    "message" : "messages"
    , "sendNb" : "010-0000-0003"
    , "receiveNb" : "010-0000-0002"
    , "type" : "MMS"
    , "adYn" : "N"
}
응답 파라미터
항목 Mandatory Type 설명 비고
codeMandatoryString응답 코드0:성공
그외:실패
messageMandatoryString응답 메시지성공:‘문자 발송에 성공하였습니다.’
기타:그 외 메시지
data.messageIdMandatoryInteger메세지 아이디예약문자 취소 시 사용
응답 예시(Json)
성공시 
{
    "code": "0",
    "message": "문자 발송에 성공하였습니다.",
    "data": {
        "messageId": 41074
    }
}
기타 
{
    "code": "VA050001",
    "message": "메세지 내용이 비어있습니다.",
    "data": null
}
예약문자 발송 취소
API명 예약문자 발송 취소
- 발송한 예약문자를 취소합니다.
API URL PUT - https://www.api.moonletter.co.kr/api/v1/sms/messages/{messageId}
주소 파라미터
항목 Mandatory Type 설명 비고
messageIdMandatoryInteger메세지 아이디예약문자 취소 시 사용
요청 헤더
항목 Mandatory Type 설명 비고
apiKey Mandatory String 인증키 발급 받은 인증키
apiUser Mandatory String 사용자 아이디 사용자 아이디
요청 파라미터
항목 Mandatory Type 설명 비고
N/A
요청 예시(Json)
요청 N/A
응답 파라미터
항목 Mandatory Type 설명 비고
codeMandatoryString응답 코드0:성공
그외:실패
messageMandatoryString응답 메시지성공:‘예약 문자 발송 취소에 성공하였습니다.’
기타:그 외 메시지
응답 예시(Json)
성공시 
{
    "code": "0",
    "message": "예약 문자 발송 취소에 성공하였습니다."
}
기타 
{
    "code": "",
    "message": "해당 문자가 존재하지 않습니다."
}
문자 리스트 조회
API명 문자 리스트 조회
- 발송한 문자 리스트를 조회합니다.
API URL GET - https://www.api.moonletter.co.kr/api/v1/sms/messages/list
주소 파라미터
항목 Mandatory Type 설명 비고
N/A
요청 헤더
항목 Mandatory Type 설명 비고
apiKey Mandatory String 인증키 발급 받은 인증키
apiUser Mandatory String 사용자 아이디 사용자 아이디
요청 파라미터
항목 Mandatory Type 설명 비고
typeOptionalString문자 유형SMS:단문문자
LMS:장문문자
MMS:포토문자
adYnOptionalString문자 구분N:일반문자
Y:광고문자
offsetOptionalInteger요청 레코드기본값:0
limitOptionalInteger요청 갯수요청 레코드부터 갯수(기본값:10 최대값:100)
요청 예시(Json)
요청 
{
    "type" : ""
    , "adYn" : ""
    , "offset" : 0
    , "limit" : 20
}
응답 파라미터
항목 Mandatory Type 설명 비고
codeMandatoryString응답 코드0:성공
그외:실패
messageMandatoryString응답 메시지성공:‘문자 발송 리스트 조회에 성공하였습니다.’
기타:그 외 메시지
dataListTotalCountMandatoryInteger데이터 리스트 총 카운트
dataList.messageIdOptionalInteger메세지 아이디예약문자 취소 시 사용
dataList.typeNmOptionalString문자 유형단문문자, 장문문자, 포토문자
dataList.sendNbOptionalString발신번호발신번호 : 하이픈 결합 후 전송
dataList.messageOptionalString문자 내용문자 내용
dataList.adNmOptionalString문자 구분일반, 광고
dataList.reserveNmOptionalString문자 발송 형태즉시발송, 예약발송
dataList.reserveDtOptionalString예약 일시예약문자일 경우
응답 예시(Json)
성공시 
{
    "code": "0",
    "message": "문자 발송 리스트 조회에 성공하였습니다.",
    "dataListTotalCount": 4,
    "dataList": [
        {
            "messageId": 41072,
            "typeNm": "단문문자",
            "sendNb": "010-0000-0009",
            "message": "(광고) 홍길동\r\n\r\n무료거부 0803070002",
            "adNm": "광고",
            "reserveNm": null,
            "reserveDt": null
        },
        {
            "messageId": 41071,
            "typeNm": "단문문자",
            "sendNb": "010-0000-0009",
            "message": "(광고) 홍길동\r\n\r\n무료거부 0803070002",
            "adNm": "광고",
            "reserveNm": null,
            "reserveDt": null
        },
        {
            "messageId": 41069,
            "typeNm": "단문문자",
            "sendNb": "010-0000-0009",
            "message": "(광고) 홍길동\r\nadd\r\n무료거부 0803070002",
            "adNm": "광고",
            "reserveNm": null,
            "reserveDt": null
        },
        {
            "messageId": 41068,
            "typeNm": "단문문자",
            "sendNb": "010-0000-0009",
            "message": "(광고) 홍길동\r\n\r\n무료거부 0803070002",
            "adNm": "광고",
            "reserveNm": null,
            "reserveDt": "2021-01-11 18:50"
        }
    ]
}
기타 
{
    "code": "0",
    "message": "문자 발송 리스트 조회에 성공하였습니다.",
    "dataListTotalCount": 0,
    "dataList": null
}
API 기본정보
API명 문자 상세 조회
- 발송한 문자 내용을 상세 조회합니다.
API URL GET - https://www.api.moonletter.co.kr/api/v1/sms/messages/{messageId}
주소 파라미터
항목 Mandatory Type 설명 비고
messageIdMandatoryInteger메세지 아이디예약문자 취소 시 사용
요청 헤더
항목 Mandatory Type 설명 비고
apiKey Mandatory String 인증키 발급 받은 인증키
apiUser Mandatory String 사용자 아이디 사용자 아이디
요청 파라미터
항목 Mandatory Type 설명 비고
offsetOptionalInteger요청 레코드기본값:0
limitOptionalInteger요청 갯수요청 레코드부터 갯수(기본값:10 최대값:100)
요청 예시(Json)
요청 
{
	"offset" : 0
	, "limit" : 20
}
응답 파라미터
항목 Mandatory type 설명 비고
codeMandatoryString응답 코드0:성공
그외:실패
messageMandatoryString응답 메시지성공:‘문자 발송 상세 조회에 성공하였습니다.’
기타:그 외 메시지
data.messageIdMandatoryInteger메세지 아이디예약문자 취소 시 사용
data.userIdMandatoryString사용자 아이디사용자 아이디
data.typeNmMandatoryString문자 구분단문문자, 장문문자, 포토문자
data.sendNbMandatoryString발신번호발신번호
data.subjectOptionalString문자 제목문자 제목
data.messageMandatoryString문자 내용문자 내용
data.adNmOptionalString문자 구분일반, 광고
data.reserveNmOptionalString문자 발송 형태즉시발송, 예약발송
data.reserveDtTmOptionalString예약 일시예약문자일 경우
예)2021-01-11 18:50
data.regDtTmOptionalString문자 발송문자 발송 일자 시간
예)2019-01-17 18:13
data.filesNmOptionalString파일명원본 파일명 최대3개까지 전송 가능
구분자: ‘^’
예)파일명1.jpg^파일명2.jpg
data.receiveListTotalCountOptionalInteger수신자 리스트총 카운트
data.receive.receiveNmOptionalString수신자 명수신자 명
data.receive.receiveNbOptionalString수신자 번호수신자 번호
data.receive.rsltCdOptionalString문자 수신 결과코드
data.receive.rsltMsgOptionalString문자 수신 결과코드명
응답 예시(Json)
성공시 
{
    "code": "0",
    "message": "문자 발송 상세 조회에 성공하였습니다.",
    "data": {
        "messageId": 41064,
        "userId": "test",
        "typeNm": "단문문자",
        "sendNb": "010-0000-0009",
        "subject": "테스트 제목 입니다.",
        "message": "테스트 메세지 입니다.",
        "adNm": "일반",
        "reserveNm": "즉시",
        "reserveDtTm": null,
        "regDtTm": "2021-01-11 11:10",
        "filesNm": null,
        "receiveListTotalCount": 2,
        "receive": [
            {
                "receiveNm": "홍길동",
                "receiveNb": "010-0000-0001",
                "rsltCd": "0",
                "rsltMsg": "성공"
            },
            {
                "receiveNm": "아무개",
                "receiveNb": "010-0000-0002",
                "rsltCd": "0",
                "rsltMsg": "성공"
            }
        ]
    }
}
기타 
{
    "code": "0",
    "message": "문자 발송 상세 조회에 성공하였습니다.",
    "data": null
}
API 기본정보
API명 문자 발송정보
- 발송 가능한 문자 건수 및 캐시 정보를 조회 합니다.
- 발신번호 리스트를 조회 합니다.
- 주소록 그룹 정보 리스트를 조회 합니다.
API URL GET - https://www.api.moonletter.co.kr/api/v1/sms/messages/send-info
주소 파라미터
항목 Mandatory Type 설명 비고
N/A
요청 헤더
항목 Mandatory Type 설명 비고
apiKey Mandatory String 인증키 발급 받은 인증키
apiUser Mandatory String 사용자 아이디 사용자 아이디
요청 파라미터
항목 Mandatory Type 설명 비고
N/A N/A N/A N/A N/A
요청 예시(Json)
요청 N/A
응답 파라미터
항목 Mandatory type 설명 비고
codeMandatoryString응답 코드0:성공
그외:실패
messageMandatoryString응답 메시지성공:‘문자 발송 정보 조회에 성공하였습니다.’
기타:그 외 메시지
data.userIdOptionalString사용자 아이디사용자 아이디
data.denyNbOptionalString무료수신거부번호광고 문자 발송 시 사용
data.cashOptionalDecimal보유 캐시
data.enableSmsCntOptionalInteger발송 가능SMS 문자 수
data.enableLmsCntOptionalInteger발송 가능LMS 문자 수
data.enableMmsCntOptionalInteger발송 가능MSM 문자 수
data.sendList.sendNbOptionalString발신번호핸드폰, 유선번호
data.sendList.sendNmOptionalString발신번호이름
data.sendList.repYnOptionalString발신번호대표번호 여부 Y/N
data.groupList.groupIdOptionalString주소록주소록 그룹 아이디
data.groupList.groupNmOptionalString주소록주소록 그릅 명
응답 예시(Json)
성공시 
{
    "code": "0",
    "message": "문자 발송 정보 조회에 성공하였습니다.",
    "data": {
        "userId": "test",
        "denyNb": "0803070002",
        "cash": 49921.4,
        "enableSmsCnt": 6746,
        "enableLmsCnt": 2062,
        "enableMmsCnt": 832,
        "sendList": [
            {
                "sendNm": "홍길동",
                "sendNb": "010-0000-0001",
                "repYn": "Y"
            }
        ],
        "groupList": [
            {
                "groupId": "5055",
                "groupNm": "기본그룹"
            }
        ]
    }
}
기타 
{
    "code": "0",
    "message": "문자 발송 정보 조회에 성공하였습니다.",
    "data": null
}