문레터-문자 서비스

TOP

전체메뉴

문자발송

광고문자발송

선거문자발송

카카오

주소록 관리

API연동

이용내역

마이페이지

고객센터

API연동

고객센터

1811-7353

문자발송
예약문자 발송 취소
문자 리스트 조회
문자 상세 조회
문자 발송정보

API 기본정보

API명	문자발송 - SMS/LMS/MMS 문자 메시지를 발송합니다.
API URL	POST - https://api.moonletter.co.kr/api/v1/sms/messages

공통 HEADER

항목	Mandatory	Type	설명	비고
apiUser	Mandatory	String	문레터 회원 ID
apiKey	Mandatory	String	발급받은 API KEY

주소 파라미터

항목	Mandatory	Type	설명	비고
N / A

요청 파라미터

항목	Mandatory	Type	설명	비고
type	Mandatory	String	문자 유형	SMS : 단문문자 LMS : 장문문자 MMS : 포토문자 REP : 치환문자 문자 내용에 치환변수 #{변수명}이 존재할 경우, type은 무조건 REP
sendNb	Mandatory	String	발신번호	사전 등록된 발신번호만 사용가능 (발신번호예외 신청자 제외)
message	Mandatory	String	메시지 내용	SMS : 최대 90byte LMS, MMS : 최대 2,000byte 광고문자 또는 선거문자 일 경우 '무료거부 0808700901'내용이 추가됩니다. (광고)문구 붙어졌을 때 자동으로 광고 문자로 변환됩니다. (선거운동정보)문구 붙어졌을 때 자동으로 선거 문자로 변환됩니다. 치환 변수는 최대 10개만 사용 가능
adYn	Optional	String	문자 구분	N : 일반문자 Y : 광고문자 @Deprecated messageGubun 사용 권고
messageGubun	Optional	String	문자 구분	N : 일반문자 A : 광고문자 E : 선거문자 DEFAULT 'N'
dupReceiveAllowYn	Optional	String	수신번호 중복 허용 여부	Y : 동일한 수신번호 존재할 경우 모두 발송 N : 동일한 수신번호 존재할 경우 중복 제거 DEFAULT 'N'
receiveNb	Optional	String	문자 수신번호	문자 수신자 구분자 ^ 예시: 010-0000-0001^010-0000-0002 최대 999건 문자 발송 가능 type이 SMS, LMS, MMS일 경우 사용 가능 groupId와 동시 사용 불가
groupId	Optional	String	주소록 그룹 아이디	주소록 그룹 전송 시 사용 type이 SMS, LMS, MMS일 경우 사용 가능 receiveNb와 동시 사용 불가
receiveList	Optional	Array <Object>	발신자 목록	치환변수를 이용하여 각기 다른 값 발송 시 사용 type이 REP일 경우 사용 가능 최대 999건 문자 발송 가능
receiveList.to	Mandatory	String	문자 수신 연락처	하나의 전화번호만 작성 가능
receiveList.rep	Mandatory	String	치환될 문자	치환문자가 하나 이상일 경우 파이프라인(\|)으로 연결 문자 내용에 포함된 치환변수와 비교하여 순서대로 변경 문자 내용의 치환변수의 수가 더 많을 경우 치환되지 않고 그대로 발송
reserveYn	Optional	String	발송 형태	N : 즉시발송 Y : 예약발송
reserveDtTm	Optional	String	예약 일시	예약문자일 경우 입력(년월일시분) 예)202101010900
subject	Optional	String	제목	장문, 포토문자로 발송될 경우에만 적용 치환문자가 변경될 경우에도 해당
divYn	Optional	String	분할전송여부	N : 일반전송 Y : 분할전송
divCnt	Optional	Integer	분할전송단위	일반전송일 경우 0
divGap	Optional	Integer	분할전송간격	일반전송일 경우 0, 분할전송일 경우, 단위는 분. 5 이상 55 이하 5의 배수
files	Optional	Array <Object>	파일 목록	MMS일 경우에만 사용 최대 첨부가능한 이미지는 3개
files.name	Optional	String	파일명	Jpg,jpeg, png 파일만 허용 최대 40자 파일 확장자 필수
files.body	Optional	String	파일 본문	이미지를 Base64로 인코딩한 값 파일 최대 사이즈 : 300kbyte PREFIX(data:image/jpeg;base64,) 포함할 것 가로:세로 최댓값 제한(1000:1000)

요청 예시(Json)

요청	{ "message" : "messages" , "sendNb" : "010-0000-2437" , "receiveNb" : "010-0000-0002" , "type" : "SMS" , "messageGubun" : "N" }

응답 파라미터

항목	Mandatory	Type	설명	비고
code	Mandatory	String	응답 코드	0 : 성공 그 외 : 실패
message	Mandatory	String	응답 메시지	성공 : '문자 발송에 성공하였습니다.' 기타 : 그 외 메시지
data.messageId	Mandatory	Integer	메시지 아이디	예약문자 취소 시 사용

응답 예시(Json)

성공시	{ "code": "0", "message": "문자 발송에 성공하였습니다.", "data": { "messageId": 41074 } }
기타	{ "code": "VA050001", "message": "메세지 내용이 비어있습니다.", "data": null }

예약문자 발송 취소

API명	예약문자 발송 취소 - 발송한 예약문자를 취소합니다.
API URL	PUT - https://api.moonletter.co.kr/api/v1/sms/messages/{messageId}

공통 HEADER

항목	Mandatory	Type	설명	비고
apiUser	Mandatory	String	문레터 회원 ID
apiKey	Mandatory	String	발급받은 API KEY

주소 파라미터

항목	Mandatory	Type	설명	비고
messageId	Mandatory	Integer	메세지 아이디	예약문자 취소 시 사용

요청 파라미터

항목	Mandatory	Type	설명	비고
N / A

요청 예시(Json)

요청	N / A

응답 파라미터

항목	Mandatory	Type	설명	비고
code	Mandatory	String	응답 코드	0 : 성공 그 외 : 실패
message	Mandatory	String	응답 메시지	성공 : '예약 문자 발송 취소에 성공하였습니다.' 기타 : 그 외 메시지

응답 예시(Json)

성공시	{ "code": "0", "message": "예약 문자 발송 취소에 성공하였습니다." }
기타	{ "code": "", "message": "존재 하지 않는 문자 입니다." }

문자 리스트 조회

API명	문자 리스트 조회 - 발송한 문자 리스트를 조회합니다.
API URL	GET - https://api.moonletter.co.kr/api/v1/sms/messages/list

공통 HEADER

항목	Mandatory	Type	설명	비고
apiUser	Mandatory	String	문레터 회원 ID
apiKey	Mandatory	String	발급받은 API KEY

주소 파라미터

항목	Mandatory	Type	설명	비고
N / A

요청 파라미터

항목	Mandatory	Type	설명	비고
type	Optional	String	문자 유형	SMS : 단문문자 LMS : 장문문자 MMS : 포토문자 REP : 치환문자 DEFAULT ''(전체조회)
fromDt	Optional	String	검색 일자(FROM)
toDt	Optional	String	검색 일자(TO)
adYn	Optional	String	문자 구분	N : 일반문자 Y : 광고문자 @Deprecated messageGubun 사용 권고
messageGubun	Optional	String	문자 구분	'' : 전체조회 N : 일반문자 A : 광고문자 E : 선거문자 DEFAULT ''
reserveYn	Optional	String	발송 형태	'' : 전체조회 N : 즉시발송조회 Y : 예약발송조회
offset	Optional	Integer	요청 레코드	기본값 : 0
limit	Optional	Integer	요청 갯수	요청 레코드부터 갯수(기본값 : 10 최대값 : 100)

요청 예시(Json)

요청	{ "type" : "" , "adYn" : "" , "offset" : 0 , "limit" : 20 }

응답 파라미터

항목	Mandatory	Type	설명	비고
code	Mandatory	String	응답 코드	0 : 성공 그 외 : 실패
message	Mandatory	String	응답 메시지	성공 : '문자 발송 리스트 조회에 성공하였습니다.' 기타 : 그 외 메시지
dataListTotalCount	Mandatory	Integer	데이터 리스트	총 카운트
dataList.messageId	Optional	Integer	메세지 아이디	예약문자 취소 시 사용
dataList.typeNm	Optional	String	문자 유형	단문문자, 장문문자, 포토문자, 치환문자
dataList.sendNb	Optional	String	발신번호	발신번호 : 하이픈 결합 후 전송
dataList.message	Optional	String	문자 내용	문자 내용
dataList.adNm	Optional	String	문자 구분	일반, 광고(선거 미포함) @Deprecated messageGubunNm 사용 권고
dataList.messageGubunNm	Optional	String	문자 구분	일반, 광고, 선거
dataList.totalCnt	Optional	Integer	총 발송수량
dataList.successCnt	Optional	Integer	발송 성공 수량
dataList.failCnt	Optional	Integer	발송 실패 수량
dataList.waitCnt	Optional	Integer	발송 대기 수량
dataList.regDtTm	Optional	String	문자 발송 일시	2021-01-10 12:00:00
dataList.reserveNm	Optional	String	문자 발송 형태	즉시발송, 예약발송
dataList.reserveDtTm	Optional	String	예약 일시	예약문자일 경우
dataList.divNm	Optional	String	분할전송여부	일반전송,분할전송
dataList.divCnt	Optional	Integer	분할전송단위	일반전송일 경우 0
dataList.divGap	Optional	Integer	분할전송간격	단위는 분, 일반전송일 경우 0

응답 예시(Json)

성공시	{ "code": "0", "message": "문자 발송 리스트 조회에 성공하였습니다.", "dataListTotalCount": 4, "dataList": [ { "messageId": 41072, "typeNm": "단문문자", "sendNb": "010-0000-0009", "message": "(광고) 홍길동\r\n\r\n무료거부 0803070002", "messageGubunNm": "광고", "totalCnt": 10, "successCnt": 5, "failCnt": 1, "waitCnt": 4, "regDtTm": "2021-01-10 10:00:00", "reserveNm": "즉시발송", "reserveDtTm": null, "divNm": "일반전송", "divCnt": 0, "divGap": 0 }, { "messageId": 41071, "typeNm": "단문문자", "sendNb": "010-0000-0009", "message": "(광고) 홍길동\r\n\r\n무료거부 0803070002", "messageGubunNm": "광고", "totalCnt": 5, "successCnt": 1, "failCnt": 3, "waitCnt": 1, "regDtTm": "2021-01-10 11:00:00", "reserveNm": "즉시발송", "reserveDtTm": null, "divNm": "일반전송", "divCnt": 0, "divGap": 0 }, { "messageId": 41069, "typeNm": "단문문자", "sendNb": "010-0000-0009", "message": "(광고) 홍길동\r\nadd\r\n무료거부 0803070002", "messageGubunNm": "광고", "totalCnt": 100, "successCnt": 99, "failCnt": 1, "waitCnt": 0, "regDtTm": "2021-01-10 12:00:00", "reserveNm": "즉시발송", "reserveDtTm": null, "divNm": "일반전송", "divCnt": 0, "divGap": 0 }, { "messageId": 41068, "typeNm": "단문문자", "sendNb": "010-0000-0009", "message": "(광고) 홍길동\r\n\r\n무료거부 0803070002", "messageGubunNm": "광고", "totalCnt": 100, "successCnt": 0, "failCnt": 0, "waitCnt": 100, "regDtTm": "2021-01-11 16:00:00", "reserveNm": "예약발송", "reserveDtTm": "2021-01-11 18:50", "divNm": "일반전송", "divCnt": 0, "divGap": 0 } ] }
기타	{ "code": "0", "message": "문자 발송 리스트 조회에 성공하였습니다.", "dataListTotalCount": 0, "dataList": null }

성공시

{
	    "code": "0",
	    "message": "문자 발송 리스트 조회에 성공하였습니다.",
	    "dataListTotalCount": 4,
	    "dataList": [
	        {
	            "messageId": 41072,
	            "typeNm": "단문문자",
	            "sendNb": "010-0000-0009",
	            "message": "(광고) 홍길동\r\n\r\n무료거부 0803070002",
	            "messageGubunNm": "광고",
	            "totalCnt": 10,
	            "successCnt": 5,
	            "failCnt": 1,
	            "waitCnt": 4,
	            "regDtTm": "2021-01-10 10:00:00",
	            "reserveNm": "즉시발송",
	            "reserveDtTm": null,
	            "divNm": "일반전송",
	            "divCnt": 0,
	            "divGap": 0
	        },
	        {
	            "messageId": 41071,
	            "typeNm": "단문문자",
	            "sendNb": "010-0000-0009",
	            "message": "(광고) 홍길동\r\n\r\n무료거부 0803070002",
	            "messageGubunNm": "광고",
	            "totalCnt": 5,
	            "successCnt": 1,
	            "failCnt": 3,
	            "waitCnt": 1,
	            "regDtTm": "2021-01-10 11:00:00",
	            "reserveNm": "즉시발송",
	            "reserveDtTm": null,
	            "divNm": "일반전송",
	            "divCnt": 0,
	            "divGap": 0
	        },
	        {
	            "messageId": 41069,
	            "typeNm": "단문문자",
	            "sendNb": "010-0000-0009",
	            "message": "(광고) 홍길동\r\nadd\r\n무료거부 0803070002",
	            "messageGubunNm": "광고",
	            "totalCnt": 100,
	            "successCnt": 99,
	            "failCnt": 1,
	            "waitCnt": 0,
	            "regDtTm": "2021-01-10 12:00:00",
	            "reserveNm": "즉시발송",
	            "reserveDtTm": null,
	            "divNm": "일반전송",
	            "divCnt": 0,
	            "divGap": 0
	        },
	        {
	            "messageId": 41068,
	            "typeNm": "단문문자",
	            "sendNb": "010-0000-0009",
	            "message": "(광고) 홍길동\r\n\r\n무료거부 0803070002",
	            "messageGubunNm": "광고",
	            "totalCnt": 100,
	            "successCnt": 0,
	            "failCnt": 0,
	            "waitCnt": 100,
	            "regDtTm": "2021-01-11 16:00:00",
	            "reserveNm": "예약발송",
	            "reserveDtTm": "2021-01-11 18:50",
	            "divNm": "일반전송",
	            "divCnt": 0,
	            "divGap": 0
	        }
	    ]
	}

기타

{
	    "code": "0",
	    "message": "문자 발송 리스트 조회에 성공하였습니다.",
	    "dataListTotalCount": 0,
	    "dataList": null
	}

API 기본정보

API명	문자 리스트 조회 - 발송한 문자 내용을 상세 조회합니다.
API URL	GET - https://api.moonletter.co.kr/api/v1/sms/messages/{messageId}

공통 HEADER

항목	Mandatory	Type	설명	비고
apiUser	Mandatory	String	문레터 회원 ID
apiKey	Mandatory	String	발급받은 API KEY

주소 파라미터

항목	Mandatory	Type	설명	비고
messageId	Mandatory	Integer	메세지 아이디	예약문자 취소 시 사용

요청 파라미터

항목	Mandatory	Type	설명	비고
offset	Optional	Integer	요청 레코드	기본값 : 0
limit	Optional	Integer	요청 갯수	요청 레코드부터 갯수(기본값 : 10 최대값 : 100)

요청 예시(Json)

요청	{ "offset" : 0 , "limit" : 20 }

응답 파라미터

항목	Mandatory	Type	설명	비고
code	Mandatory	String	응답 코드	0 : 성공 그 외 : 실패
message	Mandatory	String	응답 메시지	성공 : '문자 발송 상세 조회에 성공하였습니다.' 기타 : 그 외 메시지
data.messageId	Mandatory	Integer	메세지 아이디	예약문자 취소 시 사용
data.userId	Mandatory	String	사용자 아이디	사용자 아이디
data.typeNm	Mandatory	String	문자 구분	단문문자, 장문문자, 포토문자, 치환문자
data.sendNb	Mandatory	String	발신번호	발신번호
data.subject	Optional	String	문자 제목	문자 제목
data.message	Mandatory	String	문자 내용	문자 내용
data.adNm	Optional	String	문자 구분	일반, 광고(선거 미포함) @Deprecated messageGubunNm 사용 권고
data.messageGubunNm	Optional	String	문자 구분	일반, 광고, 선거
data.reserveNm	Optional	String	문자 발송 형태	즉시, 예약
data.reserveDtTm	Optional	String	예약 일시	예약문자일 경우 예)2021-01-11 18:50
data.regDtTm	Optional	String	문자 발송	문자 발송 일자 시간 예)2019-01-17 18:13
data.divNm	Optional	String	분할전송여부	일반전송,분할전송
data.divCnt	Optional	Integer	분할전송단위	일반전송일 경우 0
data.divGap	Optional	Integer	분할전송간격	일반전송일 경우 0
data.totalCnt	Optional	Integer	전체 발송 수량
data.successCnt	Optional	Integer	성공 수량
data.failCnt	Optional	Integer	실패 수량
data.waitCnt	Optional	Integer	대기 수량
data.dupReceiveAllowYnNm	Optional	String	수신번호 중복 허용 여부	Y : 중복허용 N : 중복제거
data.filesNm	Optional	String	파일명	원본 파일명 최대3개까지 전송 가능 구분자: ‘^’ 예)파일명1.jpg^파일명2.jpg
data.receiveListTotalCount	Optional	Integer	수신자 리스트	총 카운트
data.receiveList.receiveNm	Optional	String	수신자 명	수신자 명
data.receiveList.receiveNb	Optional	String	수신자 번호	수신자 번호
data.receiveList.rsltCd	Optional	String	문자 수신 결과	코드
data.receiveList.rsltMsg	Optional	String	문자 수신 결과	코드명
data.receiveList.actualSendType	Optional	String	실제 발송 문자 유형	SMS, LMS, MMS
data.receiveList.actualSendTypeNm	Optional	String	실제 발송 문자 유형	단문문자, 장문문자, 포토문자
data.receiveList.actualSendMessage	Optional	String	실제 발송 문자 내용	data.typeNm가 치환문자일 경우, 실제 발송된(치환변수가 치환된) 문자 내용

응답 예시(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", "divNm": "일반전송", "divCnt": 0, "divGap": 0, "totalCnt": 2, "successCnt": 2, "failCnt": 0, "waitCnt": 0, "dupReceiveAllowYnNm" : "중복제거", "filesNm": null, "receiveListTotalCount": 2, "receiveList": [ { "receiveNm": "홍길동", "receiveNb": "010-0000-0001", "rsltCd": "0", "rsltMsg": "전송 성공", "actualSendType" : "SMS", "actualSendTypeNm" : "단문문자", "actualSendMessage" : "테스트 메세지 입니다." }, { "receiveNm": "아무개", "receiveNb": "010-0000-0002", "rsltCd": "0", "rsltMsg": "전송 성공", "actualSendType" : "SMS", "actualSendTypeNm" : "단문문자", "actualSendMessage" : "테스트 메세지 입니다." } ] } }
기타	{ "code": "0", "message": "문자 발송 상세 조회에 성공하였습니다.", "data": null }

성공시

{
	    "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",
	        "divNm": "일반전송",
	        "divCnt": 0,
	        "divGap": 0,
	        "totalCnt": 2,
	        "successCnt": 2,
	        "failCnt": 0,
	        "waitCnt": 0,
	        "dupReceiveAllowYnNm" : "중복제거",
	        "filesNm": null,
	        "receiveListTotalCount": 2,
	        "receiveList": [
	            {
	                "receiveNm": "홍길동",
	                "receiveNb": "010-0000-0001",
	                "rsltCd": "0",
	                "rsltMsg": "전송 성공",
					"actualSendType" : "SMS",
					"actualSendTypeNm" : "단문문자",
					"actualSendMessage" : "테스트 메세지 입니다."
	            },
	            {
	                "receiveNm": "아무개",
	                "receiveNb": "010-0000-0002",
	                "rsltCd": "0",
	                "rsltMsg": "전송 성공",
					"actualSendType" : "SMS",
					"actualSendTypeNm" : "단문문자",
					"actualSendMessage" : "테스트 메세지 입니다."
	            }
	        ]
	    }
	}

기타

{
	    "code": "0",
	    "message": "문자 발송 상세 조회에 성공하였습니다.",
	    "data": null
	}

API 기본정보

API명	문자 리스트 조회 - 발송 가능한 문자 건수 및 캐시 정보를 조회 합니다. - 발신번호 리스트를 조회 합니다. - 주소록 그룹 정보 리스트를 조회 합니다.
API URL	GET - https://api.moonletter.co.kr/api/v1/sms/messages/send-info

공통 HEADER

항목	Mandatory	Type	설명	비고
apiUser	Mandatory	String	문레터 회원 ID
apiKey	Mandatory	String	발급받은 API KEY

주소 파라미터

항목	Mandatory	Type	설명	비고
N / A

요청 파라미터

항목	Mandatory	Type	설명	비고
N/A	N/A	N/A	N/A	N/A

요청 예시(Json)

요청	N/A

응답 파라미터

항목	Mandatory	Type	설명	비고
code	Mandatory	String	응답 코드	0 : 성공 그 외 : 실패
message	Mandatory	String	응답 메시지	성공 : '문자 발송 정보 조회에 성공하였습니다.' 기타 : 그 외 메시지
data.userId	Optional	String	사용자 아이디	사용자 아이디
data.denyNb	Optional	String	무료수신거부번호	광고 문자 발송 시 사용
data.cash	Optional	Decimal	보유 캐시
data.enableSmsCnt	Optional	Integer	발송 가능	SMS 문자 수(후불제회원일 경우 0)
data.enableLmsCnt	Optional	Integer	발송 가능	LMS 문자 수(후불제회원일 경우 0)
data.enableMmsCnt	Optional	Integer	발송 가능	MMS 문자 수(후불제회원일 경우 0)
data.deferPayYnNm	Optional	String	회원 구분명	선불요금제회원, 후불요금제회원
data.sendList.sendNb	Optional	String	발신번호	핸드폰, 유선번호
data.sendList.sendNm	Optional	String	발신번호	이름
data.sendList.repYn	Optional	String	발신번호	대표번호 여부 Y/N
data.sendList.sendNbUseYn	Optional	String	발신번호	발신번호 사용 가능 여부 Y/N
data.groupList.groupId	Optional	String	주소록	주소록 그룹 아이디
data.groupList.groupNm	Optional	String	주소록	주소록 그릅 명

응답 예시(Json)

성공시	{ "code": "0", "message": "문자 발송 정보 조회에 성공하였습니다.", "data": { "userId": "test", "denyNb": "0803070002", "cash": 49921.4, "enableSmsCnt": 6746, "enableLmsCnt": 2062, "enableMmsCnt": 832, "deferPayYnNm": "선불요금제회원", "sendList": [ { "sendNm": "홍길동", "sendNb": "010-0000-0001", "repYn": "Y", "sendNbUseYn": "Y" } ], "groupList": [ { "groupId": "5055", "groupNm": "기본그룹" } ] } }
기타	{ "code": "0", "message": "문자 발송 정보 조회에 성공하였습니다.", "data": null }

성공시

{
	    "code": "0",
	    "message": "문자 발송 정보 조회에 성공하였습니다.",
	    "data": {
	        "userId": "test",
	        "denyNb": "0803070002",
	        "cash": 49921.4,
	        "enableSmsCnt": 6746,
	        "enableLmsCnt": 2062,
	        "enableMmsCnt": 832,
	        "deferPayYnNm": "선불요금제회원",
	        "sendList": [
	            {
	                "sendNm": "홍길동",
	                "sendNb": "010-0000-0001",
	                "repYn": "Y",
	                "sendNbUseYn": "Y"
	            }
	        ],
	        "groupList": [
	            {
	                "groupId": "5055",
	                "groupNm": "기본그룹"
	            }
	        ]
	    }
	}

기타

{
	    "code": "0",
	    "message": "문자 발송 정보 조회에 성공하였습니다.",
	    "data": null
	}

서비스 신청