문레터-문자 서비스

TOP

전체메뉴

문자발송

광고문자발송

선거문자발송

카카오

주소록 관리

API연동

이용내역

마이페이지

고객센터

API연동

고객센터

1811-7353

채널등록
템플릿 등록
카카오 메시지 발송
카카오 메시지 예약 취소
카카오 발송 조회/상세

채널 등록 인증번호 요청 API 기본정보

API명	채널 등록 인증번호 요청 - 카카오 채널 등록을 위한 인증번호를 요청합니다. - 카카오 채널 등록 전 반드시 필요한 과정입니다.
API URL	POST - https://api.moonletter.co.kr/api/v1/kakao/channel

API명

채널 등록 인증번호 요청
- 카카오 채널 등록을 위한 인증번호를 요청합니다.

- 카카오 채널 등록 전 반드시 필요한 과정입니다.

API URL

POST - https://api.moonletter.co.kr/api/v1/kakao/channel

공통 HEADER

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

주소 파라미터

항목	Mandatory	Type	설명	비고
N / A

요청 파라미터

항목	Mandatory	Type	설명	비고
channelId	Mandatory	String	채널 ID
adminPhone	Mandatory	String	채널 관리자 연락처	등록하고자 하는 채널의 관리자 휴대폰 번호 인증번호가 도착하는 연락처

요청 예시(Json)

요청	{ "channelId" : "@test" , "adminPhone" : "01000000000" }

응답 파라미터

항목	Mandatory	Type	설명	비고
code	Mandatory	String	응답 코드	0 : 성공 그 외 : 실패
message	Mandatory	String	응답 메시지	성공 : '채널 관리자로부터 인증번호가 정상 발급되었습니다.' 기타 : 그 외 메시지
data.channelId	Mandatory	String	채널 아이디	인증번호가 정상적으로 발급된 채널의 ID

응답 예시(Json)

성공시	{ "code": "0", "message": "채널 관리자로부터 인증번호가 정상 발급되었습니다", "data": { "channelId": "@test" } }
기타	{ "code": "VA000102", "message": "관리자 연락처가 비어있습니다.", "data": null }

성공시

{
    "code": "0",
    "message": "채널 관리자로부터 인증번호가 정상 발급되었습니다",
    "data": {
        "channelId": "@test"
    }
}

기타

{
    "code": "VA000102",
    "message": "관리자 연락처가 비어있습니다.",
    "data": null
}

채널 등록 API 기본정보

API명	채널 등록 - 카카오 채널을 등록합니다. - 호출 전에 반드시 인증번호를 요청받아야 합니다.
API URL	POST - https://api.moonletter.co.kr/api/v1/kakao/channel/{channelId}

API명

채널 등록
- 카카오 채널을 등록합니다.

- 호출 전에 반드시 인증번호를 요청받아야 합니다.

API URL

POST - https://api.moonletter.co.kr/api/v1/kakao/channel/{channelId}

주소 파라미터

항목	Mandatory	Type	설명	비고
channelId	Mandatory	String	등록할 채널 ID

공통 HEADER

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

요청 파라미터

항목	Mandatory	Type	설명	비고
adminPhone	Mandatory	String	채널 관리자 연락처	인증번호가 발송된 관리자 연락처
channelCtg	Mandatory	String	채널 카테고리	비즈니스 채널 등록 시 설정한 채널의 카테고리 정확히 일치하여야 함.
verifyCd	Mandatory	String	인증코드	관리자 연락처로 발송된 인증코드 일치하여야 함.

요청 예시(Json)

요청	POST /api/v1/kakao/channel/@test HTTP/1.1 Host: https://api.moonletter.co.kr { "adminPhone" : "01000000000" , "channelCtg" : "01300010001" , "verifyCd" : "718390" }

응답 파라미터

항목	Mandatory	Type	설명	비고
code	Mandatory	String	응답 코드	0 : 성공 그 외 : 실패
message	Mandatory	String	응답 메시지	성공 : '채널 등록이 완료되었습니다.' 기타 : 그 외 메시지
data.channelId	Mandatory	String	채널 아이디	등록된 채널 ID

응답 예시(Json)

성공시	{ "code": "0", "message": "채널 등록이 완료되었습니다.", "data": { "channelId": "@test" } }
기타	{ "code": "VA000106", "message": "인증 코드가 비어있습니다.", "data": null }

템플릿 등록 API 기본정보

API명	템플릿 등록 - 알림톡 템플릿을 등록합니다. - 등록과 동시에 검수요청 됩니다.
API URL	POST - https://api.moonletter.co.kr/api/v1/kakao/template

공통 HEADER

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

주소 파라미터

항목	Mandatory	Type	설명	비고
N / A

요청 파라미터

항목	Mandatory	Type	설명	비고
channelId	Mandatory	String	채널 ID	템플릿을 등록할 채널의 ID
templateName	Mandatory	String	템플릿 이름	동일한 채널, 동일한 템플릿 이름 중복 불가
templateType	Mandatory	String	템플릿 유형	BA : 기본형 EX : 부가정보형 AD : 광고추가형 MI : 복합형
templateContent	Mandatory	String	템플릿 본문	템플릿 내용 본문, 광고메시지, 부가정보의 크기의 합이 2000 byte를 초과 할 수 없음
templateExtraMsg	Optional	String	템플릿 부가정보	템플릿 부가정보 템플릿 유형이 EX 또는 MI일 경우 필수 입력 최대 500자 변수 사용 불가, URL 가능
templateAdMsg	Optional	String	템플릿 광고 메시지	템플릿 광고 메시지 템플릿 유형이 AD 또는 MI일 경우 필수 입력 최대 80자 변수 및 URL 사용 불가 @Deprecated 광고추가형 제거에 따라 미사용
templateCtgCd	Mandatory	String	템플릿 카테고리	템플릿 카테고리 조회 API 참조 유효한 카테고리 아닐 경우 검수 시 기타로 자동 변환
templateBtns	Optional	Array <Object>	템플릿 버튼	버튼 ARRAY 최대 5개 템플릿 유형이 AD 또는 MI일 경우 첫 번째 버튼은 채널추가유형(AC)일 것.
templateBtns.btnType	Optional	String	템플릿 버튼 유형	버튼 등록 시 필수 WL : 웹 링크 AL : 앱 링크 AC : 채널 추가 DS : 배송 조회 BK : 봇 키워드 MD : 메시지 전달
templateBtns.btnText	Optional	String	템플릿 버튼 텍스트	버튼 등록 시 필수 버튼 텍스트 24 Byte까지만 입력 가능
templateBtns .btnMobileUrl	Optional	String	모바일 웹 이동 URL	템플릿 버튼 유형이 WL일 경우 필수 모바일 웹 앱 이동 URL 최대 500 BYTE
templateBtns.btnPcUrl	Optional	String	웹 이동 URL	템플릿 버튼 유형이 WL일 경우 필수 PC 브라우저 이동 URL 최대 500 BYTE
templateBtns.btnIosAct	Optional	String	모바일 아이폰 액션	템플릿 버튼 유형이 AL일 경우 필수 아이폰일 경우의 액션 최대 500 BYTE
templateBtns .btnAndroidAct	Optional	String	모바일 안드로이드 액션	템플릿 버튼 유형이 AL일 경우 필수 안드로이드폰일 경우의 액션 최대 500 BYTE
templateEmpType	Optional	String	템플릿 강조 표기 유형	NONE : 강조표기문구 없음 TEXT : 강조표기문구 사용 IMAGE : 강조표기 이미지 사용 기본값 ‘NONE’
templateEmpTitle	Optional	String	템플릿 강조 표기 문구	본문 내용 중 강조되어야 하는 문구 강조표기유형이 TEXT 일 경우 필수 변수 사용 가능 최대 30 BYTE
templateEmpSubTitle	Optional	String	강조 표기 문구 부가 설명	강조표기문구 부가 설명 강조표기유형이 TEXT 일 경우 필수 변수 사용 불가
templateEmphasizeImage	Optional	Object	템플릿 강조유형 이미지	Object 템플릿 강조 표기 유형이 이미지일 경우 필수
templateEmphasizeImage .imageName	Optional	String	이미지 파일명	원본 이미지 파일이름 JPG, PNG 중 하나일 것 필수 입력
templateEmphasizeImage .imageBody64	Optional	String	이미지 파일 BASE64 인코딩문자열	이미지 파일 내용을 BASE64로 인코딩한 문자열 base64 인코딩 문구 반드시 포함할 것

요청 예시(Json)

요청	{ "channelId" : "@test" , "templateName" : "TEMPLATE테스트" , "templateContent" : "\"템플릿 테스트\"" , "templateType" : "BA" , "templateCtgCd" : "001002" }

응답 파라미터

항목	Mandatory	Type	설명	비고
code	Mandatory	String	응답 코드	0 : 성공 그 외 : 실패
message	Mandatory	String	응답 메시지	성공 : '알림톡 템플릿 등록을 완료하였습니다.' 기타 : 그 외 메시지
data.templateCd	Mandatory	String	템플릿 코드	등록에 성공한 템플릿 코드 자동으로 생성

응답 예시(Json)

성공시	{ "code": "0", "message": "알림톡 템플릿 등록을 완료하였습니다.", "data": { "templateCd": "A20210616004" } }
기타	{ "code": "VA000305", "message": "템플릿 유형이 비어있습니다.", "data": null }

성공시

{
    "code": "0",
    "message": "알림톡 템플릿 등록을 완료하였습니다.",
    "data": {
        "templateCd": "A20210616004"
    }
}

기타

{
    "code": "VA000305",
    "message": "템플릿 유형이 비어있습니다.",
    "data": null
}

API 기본정보

API명	카카오 메시지 발송 - 카카오 메시지(친구톡/알림톡/포토톡)를 발송합니다.
API URL	POST - https://api.moonletter.co.kr/api/v1/kakao/messages

공통 HEADER

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

주소 파라미터

항목	Mandatory	Type	설명	비고
N / A

요청 파라미터

항목	Mandatory	Type	설명	비고
channelId	Mandatory	String	채널 ID	템플릿을 등록할 채널의 ID
kakaoType	Mandatory	String	카카오 메시지 유형	FDT : 친구톡 FDP : 포토톡 NCT : 알림톡
sendNb	Mandatory	String	발신번호	사전 등록된 발신번호로만 발송 가능
message	Optional	String	메시지 본문	알림톡 발송 시 입력 불가 친구/포토톡 발송 시 필수 최대 2000 Byte
templateCd	Optional	String	알림톡 템플릿 코드	알림톡 발송 시 필수 그 외 입력 불가
reserveYn	Optional	String	예약 여부	N: 즉시발송 Y: 예약발송 (기본 ‘N’)
reserveDtTm	Optional	String	예약 일자	예약발송일 경우 입력 년월일시분 예) 202101010900
receivers	Optional	Array <Object>	커스텀 수신자 리스트	치환변수가 존재하는 메시지 발송 시 필수
receivers.receiverName	Optional	String	수신자 이름
receivers.receiverNb	Optional	String	수신자 번호	필수
receivers.receiverSubsList	Optional	Array <Object>	치환변수 리스트	치환변수가 존재할 경우 필수
receivers.receiverSubsList. subWord	Optional	String	치환문자	형태 : #{문자}
receivers.receiverSubsList. subValue	Optional	String	치환 값	해당 치환 문자가 치환되어야 하는 값
receiveGroup	Optional	String	주소록ID	그룹 전송 시 사용 ^로 구분 본문(템플릿)에 치환문자가 존재할 경우 사용 불가
receiveNb	Optional	String	수신번호	^로 구분 최대 999개 본문(템플릿)에 치환문자가 존재할 경우 사용 불가
file	Optional	String	첨부이미지	포토톡에서만 사용 파일의 크기는 최대 300KB
file.fileName	Optional	String	파일명	공백 사용 불가 Jpg, jpeg, png 파일만 허용 최대 40자
file.fileBody	Optional	String	파일내용	공백 사용 불가 Jpg, jpeg, png 이미지를 Base64로 인코딩한 값
btns	Optional	Array <Object>	메시지 버튼	알림톡일 경우 입력 불가
btns.btnType	Optional	String	버튼 유형	버튼 삽입 시 필수 WL : 웹 링크 AL : 앱 링크 AC : 채널 추가 DS : 배송 조회 BK : 봇 키워드 MD : 메시지 전달
btns.btnText	Optional	String	버튼 텍스트	버튼 삽입 시 필수 버튼 텍스트 24 Byte까지만 입력 가능
btns.btnMobileUrl	Optional	String	모바일 웹 이동 URL	버튼 유형이 WL일 경우 필수 모바일 웹 앱 이동 URL 최대 500 BYTE
btns.btnPcUrl	Optional	String	웹 이동 URL	버튼 유형이 WL일 경우 필수 PC 브라우저 이동 URL 최대 500 BYTE
btns.btnIosAct	Optional	String	모바일 아이폰 액션	버튼 유형이 AL일 경우 필수 아이폰일 경우의 액션 최대 500 BYTE
btns.btnAndroidAct	Optional	String	모바일 안드로이드 액션	버튼 유형이 AL일 경우 필수 안드로이드폰일 경우의 액션 최대 500 BYTE
divYn	Optional	String	분할 전송 여부	Y(분할전송) N(일괄전송) 기본값 : N
divCnt	Optional	String	분할 전송 개수	분할전송 시 한 번에 발송될 문자 수 분할 전송이 Y일 경우 1 이상
divGap	Optional	String	분할 전송 간격	분할 전송될 시간 간격 단위는 분 분할 전송 Y일 경우 0 초과 5의 배수(5~55)
smsReSendYn	Optional	String	문자 재전송 여부	카카오 메시지 전송 실패 시 문자 재전송 여부 Y(재전송) N(미전송) 기본값은 N(미전송)

요청 예시(Json)

요청	{ "channelId" : "@test" , "kakaoType" : "FDT" , "sendNb" : "01000000000" , "message" : "친구톡TEST\n#{변수1}" , "reserveYn" : "N" , "receivers" : [ { "receiverName" : "테스터" , "receiverNb" : "01000000001" , "receiverSubsList" : [ { "subWord" : "#{변수1}" , "subValue" : "변수1치환값" } ] } ] }

요청

{
    "channelId" : "@test"
    , "kakaoType" : "FDT"
    , "sendNb" : "01000000000"
    , "message" : "친구톡TEST\n#{변수1}"
    , "reserveYn" : "N"
    , "receivers" : [
                        {
                            "receiverName" : "테스터"
                          , "receiverNb" : "01000000001"
                          , "receiverSubsList" : [
                                                     {
                                                           "subWord" : "#{변수1}"
                                                         , "subValue" : "변수1치환값"
                                                     }
                                  ]
                        }
     ]
}

응답 파라미터

항목	Mandatory	Type	설명	비고
code	Mandatory	String	응답 코드	0 : 성공 그 외 : 실패
message	Mandatory	String	응답 메시지	성공 : '친구톡/포토톡/알림톡 발송을 완료하였습니다.' 기타 : 그 외 메시지
data.messageId	Mandatory	Integer	메시지 ID	발송된 메시지의 ID

응답 예시(Json)

성공시	{ "code": "0", "message": "친구톡 발송을 완료하였습니다.", "data": { "messageId": 1000001 } }
기타	{ "code": "VA000013", "message": "발송하고자 하는 카카오 유형이 비어있습니다.", "data": null }

성공시

{
    "code": "0",
    "message": "친구톡 발송을 완료하였습니다.",
    "data": {
        "messageId": 1000001
    }
}

기타

{
    "code": "VA000013",
    "message": "발송하고자 하는 카카오 유형이 비어있습니다.",
    "data": null
}

API 기본정보

API명	카카오 메시지 예약 취소 - 카카오 메시지(친구톡/포토톡/알림톡)의 예약을 취소합니다.
API URL	PUT - https://api.moonletter.co.kr/api/v1/kakao/messages/{messageId}

공통 HEADER

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

주소 파라미터

항목	Mandatory	Type	설명	비고
messageId	Mandatory	Integer	예약 발송 취소할 메시지 ID

요청 파라미터

항목	Mandatory	Type	설명	비고
N / A

요청 예시(Json)

요청	PUT /api/v1/kakao/messages/1000001 HTTP/1.1 Host: https://api.moonletter.co.kr

응답 파라미터

항목	Mandatory	Type	설명	비고
code	Mandatory	String	응답 코드	0 : 성공 그 외 : 실패
message	Mandatory	String	응답 메시지	성공 : '알림톡/친구톡/포토톡 발송 예약 취소를 완료하였습니다.' 기타 : 그 외 메시지

응답 예시(Json)

성공시	{ "code": "0", "message": "친구톡 발송 예약 취소를 완료하였습니다." }
기타	{ "code": "VA000505", "message": "해당 카카오 메시지는 이미 예약이 취소된 메시지 입니다." }

카카오 발송 조회 API 기본정보

API명	카카오 발송 조회 - 카카오 메시지(친구톡/포토톡/알림톡)의 발송 내역을 조회합니다. - 내림차순 정렬(메시지ID 기준)
API URL	GET - https://api.moonletter.co.kr/api/v1/kakao/messages

API명

카카오 발송 조회
- 카카오 메시지(친구톡/포토톡/알림톡)의 발송 내역을 조회합니다.

- 내림차순 정렬(메시지ID 기준)

API URL

GET - https://api.moonletter.co.kr/api/v1/kakao/messages

공통 HEADER

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

주소 파라미터

항목	Mandatory	Type	설명	비고
N / A

요청 파라미터

항목	Mandatory	Type	설명	비고
kakaoType	Optional	String	카카오 유형	미입력 시 전체 FDT : 친구톡 FDP : 포토톡 NCT : 알림톡
reserveYn	Optional	String	발송 형태	'' : 전체조회 N : 즉시발송조회 Y : 예약발송조회
smsReSendYn	Optional	String	재전송 여부	'' : 전체조회 N : 미전송 조회 Y : 실패건 재전송 조회
offset	Optional	Integer	요청 레코드	요청 레코드 (기본 0)
limit	Optional	Integer	요청 갯수	요청 레코드로부터 갯수 (기본 10 최대100)

요청 예시(Json)

요청	{ "offset": 0 , "limit": 10 , "kakaoType": ”FDT” }

응답 파라미터

항목	Mandatory	Type	설명	비고
code	Mandatory	String	응답 코드	0 : 성공 그 외 : 실패
message	Mandatory	String	응답 메시지	성공 : '카카오 메시지 발송 내역 조회를 완료하였습니다.' 기타 : 그 외 메시지
dataListTotalCount	Mandatory	Integer	전체 카운트
dataList	Optional	Array <Object>	결과 리스트	전체 카운트가 0일 경우 EMPTY
dataList.messageId	Mandatory	Integer	메시지 아이디	예약 취소 및 상세 조회에 사용
dataList.kakaoType	Mandatory	String	카카오 유형	FDT FDP NCT
dataList.kakaoTypeNm	Mandatory	String	카카오 유형 한글 설명	친구톡(FDT) 포토톡(FDP) 알림톡(NCT)
dataList.sendNb	Mandatory	String	발신번호	메시지 발송 번호
dataList.message	Mandatory	String	메시지 발송 내용	치환문자가 존재한다면 치환문자가 그대로 표시
dataList.sendDtTm	Mandatory	String	발송일시	예약문자일 경우 등록일시 예) 202105251000
dataList.smsReSendYn	Mandatory	String	실패건 문자 재전송 여부	Y N
dataList.smsReSendNm	Mandatory	String	실패건 문자 재전송 여부 한글 설명	전송(Y) 미전송(N)
dataList.reserveYn	Mandatory	String	예약여부	Y N
dataList.reserveNm	Mandatory	String	예약여부 한글 설명	예약발송(Y) 즉시발송(N)
dataList.reserveDtTm	Optional	String	예약일시	예) 202105251000 예약문자가 아닐 경우 공백
dataList.divYn	Mandatory	String	분할전송여부	Y N
dataList.divNm	Mandatory	String	분할전송여부 한글 설명	분할전송(Y) 일괄전송(N)
dataList.divCnt	Optional	Integer	분할전송 수량	한 번에 발송될 메시지 수량 분할전송일 경우 필수
dataList.divGap	Optional	Integer	분할전송 시간 간격	다음 발송까지의 시간 간격 분할전송일 경우 필수 단위는 분 5이상 55이하의 5의 배수
dataList.totalCnt	Mandatory	Integer	총 발송 수량
dataList.successCnt	Mandatory	Integer	발송 성공수량
dataList.waitCnt	Mandatory	Integer	발송 대기수량	발송 결과를 받기 전인 메시지 수량
dataList.failCnt	Mandatory	Integer	발송 실패수량

응답 예시(Json)

성공시	{ "code": ”0” , "message": ”카카오 메시지 발송 내역 조회를 완료하였습니다.” , "dataListTotalCount": 2 , "dataList": [ { "channelId": ”@test” , "messageId": 100 , "kakaoType": ”FDT” , "kakaoTypeNm": ”친구톡” , "sendNb": ”010-0000-0000” , "message": ”안녕하세요~” , "sendDtTm": ”202105201100” , "reserveYn": ”N” , "reserveNm": ”즉시발송” }, { "channelId": ”@test” , "messageId": 101 , "kakaoType": ”FDT” , "kakaoTypeNm": ”친구톡” , "sendNb": ”010-0000-0000” , "message": ”안녕하세요~ #{고객명}님 반갑습니다.” , "sendDtTm": ”202105231100” , "reserveYn": ”Y” , "reserveNm": ”예약발송” , "reserveDtTm": ”202105231145” } ] }
기타	{ "code": "VA000601", "message": "조회하고자 하는 카카오 유형을 올바르게 입력해주시기 바랍니다[NCT, FDT, FDP].", "dataListTotalCount": 0, "dataList": null }

성공시

{
    "code": ”0”
    , "message": ”카카오 메시지 발송 내역 조회를 완료하였습니다.”
    , "dataListTotalCount": 2
    , "dataList": [
            { 
                 "channelId": ”@test”
              , "messageId": 100
               , "kakaoType": ”FDT”
              , "kakaoTypeNm": ”친구톡”
              , "sendNb": ”010-0000-0000”
              , "message": ”안녕하세요~”
              , "sendDtTm": ”202105201100”
              , "reserveYn": ”N”
              , "reserveNm": ”즉시발송”
            }, 
            { 
                 "channelId": ”@test”
               , "messageId": 101
               , "kakaoType": ”FDT”
               , "kakaoTypeNm": ”친구톡”
               , "sendNb": ”010-0000-0000”
               , "message": ”안녕하세요~
                 #{고객명}님 반갑습니다.”
               , "sendDtTm": ”202105231100”
               , "reserveYn": ”Y”
               , "reserveNm": ”예약발송”
               , "reserveDtTm": ”202105231145”
            }
      ]
}

기타

{
    "code": "VA000601",
    "message": "조회하고자 하는 카카오 유형을 올바르게 입력해주시기 바랍니다[NCT, FDT, FDP].",
    "dataListTotalCount": 0,
    "dataList": null
}

카카오 발송 상세 조회 API 기본정보

API명	카카오 발송 상세 조회 - 카카오 메시지(친구톡/포토톡/알림톡)의 발송 내역을 상세하게 조회합니다. - 발신년월(예약)이 6개월이 경과했을 경우 수신목록 및 문자목록은 조회 할 수 없습니다.
API URL	GET - https://api.moonletter.co.kr/api/v1/kakao/messages/{messageId}

API명

카카오 발송 상세 조회
- 카카오 메시지(친구톡/포토톡/알림톡)의 발송 내역을 상세하게 조회합니다.

- 발신년월(예약)이 6개월이 경과했을 경우 수신목록 및 문자목록은 조회 할 수 없습니다.

API URL

GET - https://api.moonletter.co.kr/api/v1/kakao/messages/{messageId}

공통 HEADER

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

주소 파라미터

항목	Mandatory	Type	설명	비고
messageId	Mandatory	Integer	상세 조회할 메시지 ID

요청 파라미터

항목	Mandatory	Type	설명	비고
offset	Optional	Integer	요청 레코드	카카오 발송내역 요청 레코드
limit	Optional	Integer	요청 갯수	요청 레코드로부터 갯수 (기본 10 최대100) 카카오 발송내역 요청 갯수
offsetSms	Optional	Integer	요청 레코드 (문자 전송)	문자 재전송 발신 내역 요청 레코드 문자 재전송 메시지가 아닐 경우 효과 없음.
limitSms	Optional	Integer	요청 갯수 (문자 전송)	요청 레코드로부터 갯수 (기본 10 최대100) 문자 재전송 발신 내역 요청 갯수 문자 재전송 메시지가 아닐 경우 효과 없음.

요청 예시(Json)

요청	{ "offset": 0 , "limit": 10 , "offsetSms": 0 , "limitSms": 10 }

응답 파라미터

항목	Mandatory	Type	설명	비고
code	Mandatory	String	응답 코드	0 : 성공 그 외 : 실패
message	Mandatory	String	응답 메시지	성공 : '카카오 메시지 상세 발송 내역 조회를 완료하였습니다.' 기타 : 그 외 메시지
data.channelId	Mandatory	String	채널 ID
data.channelName	Mandatory	String	채널 이름
data.messageId	Mandatory	Integer	메시지 ID
data.kakaoType	Mandatory	String	카카오 유형	FDT FDP NCT
data.kakaoTypeNm	Mandatory	String	카카오 유형 한글 설명	친구톡(FDT) 포토톡(FDP) 알림톡(NCT)
data.templateCd	Optional	String	템플릿 코드	알림톡일 경우 필수 그 외 공백
data.sendNb	Mandatory	String	발신번호
data.message	Mandatory	String	메시지 내용
data.sendDt	Mandatory	String	발송일시 (예약문자일 경우 등록일시)	예) 202105251000
data.reserveYn	Mandatory	String	예약문자 여부	Y N
data.reserveNm	Mandatory	String	예약문자 여부 한글 설명	예약발송(Y) 즉시발송(N)
data.reserveDtTm	Optional	String	예약발송일시	예) 202105251100
data.file. fileName	Optional	String	파일이름	발송 시 등록한 파일의 실제 이름
data.file. fileBody	Optional	String	파일내용	발송된 파일을 BASE 64 인코딩한 문자열
data.divYn	Mandatory	String	분할전송여부	Y N
data.divNm	Mandatory	String	분할전송여부 한글 설명	분할전송(Y) 일괄전송(N)
data.divCnt	Optional	Integer	분할전송수량	분할전송일 경우 한 번에 발송될 수 아니면 0
data.divGap	Optional	Integer	분할전송간격	분할전송일 경우 5이상 55이하의 5의 배수 아니면 0
data.deleteYn	Optional	String	예약취소여부	Y N
data.deleteNm	Optional	String	예약취소여부 한글 설명	예약취소(Y) ""(N)
data.successCnt	Mandatory	Integer	발송 성공한 수신자수
data.waitCnt	Mandatory	Integer	발송 대기중인 수신자수
data.failCnt	Mandatory	Integer	발송에 실패한 수신자수
data.btnList	Optional	Array <Object>	발송된 버튼 LIST	알림톡일 경우 EMPTY
data.btnList. btnType	Optional	String	버튼 유형	WL AL AC DS BK MD
data.btnList. btnTypeNm	Optional	String	버튼 유형 한글 설명	WL : 웹 링크 AL : 앱 링크 AC : 채널 추가 DS : 배송 조회 BK : 봇 키워드 MD : 메시지 전달
data.btnList. btnText	Optional	String	버튼 텍스트
data.btnList. btnMobileUrl	Optional	String	모바일 웹 이동 URL
data.btnList. btnPcUrl	Optional	String	웹 이동 URL
data.btnList. btnIosAct	Optional	String	모바일 아이폰 액션
data.btnList. btnAndroidAct	Optional	String	모바일 안드로이드 액션
data.receiveListTotalCount	Mandatory	Integer	전체 수신자 수
data.receiveList	Mandatory	Array <Object>	수신자 LIST	offset, limit에 따라 달라진다.
data.receiveList. receiveName	Optional	String	수신자이름	주소록 또는 커스텀 수신자 필드를 사용하여 발신했을 경우
data.receiveList. receiveNb	Mandatory	String	수신자연락처
data.receiveList. rsltCd	Mandatory	String	수신결과	0 : 성공 -2 : 대기 그 외 : 실패
data.receiveList. message	Mandatory	String	수신자 별 받은 내용
data.smsReSendYn	Mandatory	String	문자 재전송 여부	Y N
data.smsReSendNm	Mandatory	String	문자 재전송 여부 한글 설명	전송(Y) 미전송(N)
data.smsTotalCnt	Optional	Integer	문자 재전송 총 수량
data.smsSuccessCnt	Optional	Integer	문자 재전송 성공수량
data.smsWaitCnt	Optional	Integer	문자 재전송 대기수량
data.smsFailCnt	Optional	Integer	문자 재전송 실패수량
data.smsListTotalCount	Mandatory	Integer	문자 재전송 목록 카운트
data.smsList	Optional	Array <Object>	문자 재전송 목록	발송일자,문자유형에 따라 생성 치환 문자가 있다면 치환 된 내용의 유형
data.smsList. smsType	Optional	String	재전송 문자 유형	SMS LMS MMS(포토톡)
data.smsList. smsTypeNm	Optional	String	재전송 문자 유형	단문(SMS) 장문(LMS) 포토(MMS)
data.smsList. sendDt	Optional	String	문자 재전송 일시	예)202101010900
data.smsList. message	Optional	String	재전송된 문자 내용	치환문자가 있을 경우 치환문자 포함
data.smsList. smsReceiveListTotalCount	Optional	Integer	문자 수신자 수	날짜별로 달라짐
data.smsList. smsReceiveList	Optional	Array <Object>	문자 전송 받은 수신자 LIST	offsetSms, limitSms에 영향받음
data.smsList. smsReceiveList.receiveNb	Mandatory	String	문자 전송 받은 수신자 연락처
data.smsList. smsReceiveList.receiveName	Optional	String	문자 전송 받은 수신자 이름
data.smsList. smsReceiveList.message	Optional	String	수신자별 재전송 받은 문자 내용	치환문자가 없을 경우 NULL
data.smsList. smsReceiveList.rsltCd	Mandatory	String	수신자별 문자 재전송 결과	0 : 성공 -2 : 대기 그 외 : 실패

응답 예시(Json)

성공시	{ "code": "0", "message": "카카오 메시지 발송 상세 내역 조회를 완료하였습니다.", "data": { "channelId": "@test", "channelName": "테스트", "messageId": 205, "kakaoType": "FDT", "kakaoTypeNm": "친구톡", "sendNb": "01000000000", "message": "친구톡 테스트", "templateCd": "", "sendDt": "202106111423", "reserveYn": "N", "reserveNm": "즉시발송", "reserveDtTm": "", "deleteYn": "N", "deleteNm": "", "file": null, "divYn": "N", "divNm": "일반전송", "divCnt": 0, "divGap": 5, "successCnt": 0, "failCnt": 1220, "waitCnt": 41678, "receiveListTotalCount": 42898, "receiveList": [ { "receiveName": "홍길동", "receiveNb": "01022220001", "message": "친구톡 테스트", "rsltCd": "4" }, { "receiveName": "테스트13016", "receiveNb": "01000013016", "message": "친구톡 테스트", "rsltCd": "-2" }, { "receiveName": "테스트13016", "receiveNb": "01000013016", "message": "친구톡 테스트", "rsltCd": "-2" }, { "receiveName": "테스트13016", "receiveNb": "01000013016", "message": "친구톡 테스트", "rsltCd": "-2" }, { "receiveName": "테스트13015", "receiveNb": "01000013015", "message": "친구톡 테스트", "rsltCd": "-2" }, { "receiveName": "테스트13015", "receiveNb": "01000013015", "message": "친구톡 테스트", "rsltCd": "-2" }, { "receiveName": "테스트13015", "receiveNb": "01000013015", "message": "친구톡 테스트", "rsltCd": "-2" }, { "receiveName": "테스트13014", "receiveNb": "01000013014", "message": "친구톡 테스트", "rsltCd": "-2" }, { "receiveName": "테스트13014", "receiveNb": "01000013014", "message": "친구톡 테스트", "rsltCd": "-2" }, { "receiveName": "테스트13014", "receiveNb": "01000013014", "message": "친구톡 테스트", "rsltCd": "-2" } ], "smsReSendYn": "Y", "smsReSendNm": "전송", "smsTotalCnt": 1220, "smsSuccessCnt": 0, "smsFailCnt": 0, "smsWaitCnt": 1220, "smsListTotalCount": 1, "smsList": [ { "smsType": "SMS", "smsTypeNm": "단문", "sendDt": "202106111435", "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000", "smsReceiveListTotalCount": 1220, "smsReceiveList": [ { "receiveNb": "01000000992", "receiveName": "테스트0992", "smsType": "SMS", "smsTypeNm": "단문", "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000", "rsltCd": "-2" }, { "receiveNb": "01000000991", "receiveName": "테스트0991", "smsType": "SMS", "smsTypeNm": "단문", "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000", "rsltCd": "-2" }, { "receiveNb": "01000000990", "receiveName": "테스트0990", "smsType": "SMS", "smsTypeNm": "단문", "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000", "rsltCd": "-2" }, { "receiveNb": "01000000989", "receiveName": "테스트0989", "smsType": "SMS", "smsTypeNm": "단문", "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000", "rsltCd": "-2" }, { "receiveNb": "01000000988", "receiveName": "테스트0988", "smsType": "SMS", "smsTypeNm": "단문", "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000", "rsltCd": "-2" }, { "receiveNb": "01000000987", "receiveName": "테스트0987", "smsType": "SMS", "smsTypeNm": "단문", "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000", "rsltCd": "-2" }, { "receiveNb": "01000000986", "receiveName": "테스트0986", "smsType": "SMS", "smsTypeNm": "단문", "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000", "rsltCd": "-2" }, { "receiveNb": "01000000985", "receiveName": "테스트0985", "smsType": "SMS", "smsTypeNm": "단문", "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000", "rsltCd": "-2" }, { "receiveNb": "01000000984", "receiveName": "테스트0984", "smsType": "SMS", "smsTypeNm": "단문", "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000", "rsltCd": "-2" }, { "receiveNb": "01000000983", "receiveName": "테스트0983", "smsType": "SMS", "smsTypeNm": "단문", "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000", "rsltCd": "-2" } ] } ] } }

성공시

{
    "code": "0",
    "message": "카카오 메시지 발송 상세 내역 조회를 완료하였습니다.",
    "data": {
         "channelId": "@test",
         "channelName": "테스트",
        "messageId": 205,
        "kakaoType": "FDT",
        "kakaoTypeNm": "친구톡",
        "sendNb": "01000000000",
        "message": "친구톡 테스트",
        "templateCd": "",
        "sendDt": "202106111423",
        "reserveYn": "N",
        "reserveNm": "즉시발송",
        "reserveDtTm": "",
        "deleteYn": "N",
        "deleteNm": "",
        "file": null,
        "divYn": "N",
        "divNm": "일반전송",
        "divCnt": 0,
        "divGap": 5,
        "successCnt": 0,
        "failCnt": 1220,
        "waitCnt": 41678,
        "receiveListTotalCount": 42898,
        "receiveList": [
            {
                "receiveName": "홍길동",
                "receiveNb": "01022220001",
                "message": "친구톡 테스트",
                "rsltCd": "4"
            },
            {
                "receiveName": "테스트13016",
                "receiveNb": "01000013016",
                "message": "친구톡 테스트",
                "rsltCd": "-2"
            },
            {
                "receiveName": "테스트13016",
                "receiveNb": "01000013016",
                "message": "친구톡 테스트",
                "rsltCd": "-2"
            },
            {
                "receiveName": "테스트13016",
                "receiveNb": "01000013016",
                "message": "친구톡 테스트",
                "rsltCd": "-2"
            },
            {
                "receiveName": "테스트13015",
                "receiveNb": "01000013015",
                "message": "친구톡 테스트",
                "rsltCd": "-2"
            },
            {
                "receiveName": "테스트13015",
                "receiveNb": "01000013015",
                "message": "친구톡 테스트",
                "rsltCd": "-2"
            },
            {
                "receiveName": "테스트13015",
                "receiveNb": "01000013015",
                "message": "친구톡 테스트",
                "rsltCd": "-2"
            },
            {
                "receiveName": "테스트13014",
                "receiveNb": "01000013014",
                "message": "친구톡 테스트",
                "rsltCd": "-2"
            },
            {
                "receiveName": "테스트13014",
                "receiveNb": "01000013014",
                "message": "친구톡 테스트",
                "rsltCd": "-2"
            },
            {
                "receiveName": "테스트13014",
                "receiveNb": "01000013014",
                "message": "친구톡 테스트",
                "rsltCd": "-2"
            }
        ],
        "smsReSendYn": "Y",
        "smsReSendNm": "전송",
        "smsTotalCnt": 1220,
        "smsSuccessCnt": 0,
        "smsFailCnt": 0,
        "smsWaitCnt": 1220,
        "smsListTotalCount": 1,
        "smsList": [
            {
                "smsType": "SMS",
                "smsTypeNm": "단문",
                "sendDt": "202106111435",
                "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000",
                "smsReceiveListTotalCount": 1220,
                "smsReceiveList": [
                    {
                        "receiveNb": "01000000992",
                        "receiveName": "테스트0992",
                        "smsType": "SMS",
                        "smsTypeNm": "단문",
                        "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000",
                        "rsltCd": "-2"
                    },
                    {
                        "receiveNb": "01000000991",
                        "receiveName": "테스트0991",
                        "smsType": "SMS",
                        "smsTypeNm": "단문",
                        "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000",
                        "rsltCd": "-2"
                    },
                    {
                        "receiveNb": "01000000990",
                        "receiveName": "테스트0990",
                        "smsType": "SMS",
                        "smsTypeNm": "단문",
                        "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000",
                        "rsltCd": "-2"
                    },
                    {
                        "receiveNb": "01000000989",
                        "receiveName": "테스트0989",
                        "smsType": "SMS",
                        "smsTypeNm": "단문",
                        "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000",
                        "rsltCd": "-2"
                    },
                    {
                        "receiveNb": "01000000988",
                        "receiveName": "테스트0988",
                        "smsType": "SMS",
                        "smsTypeNm": "단문",
                        "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000",
                        "rsltCd": "-2"
                    },
                    {
                        "receiveNb": "01000000987",
                        "receiveName": "테스트0987",
                        "smsType": "SMS",
                        "smsTypeNm": "단문",
                        "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000",
                        "rsltCd": "-2"
                    },
                    {
                        "receiveNb": "01000000986",
                        "receiveName": "테스트0986",
                        "smsType": "SMS",
                        "smsTypeNm": "단문",
                        "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000",
                        "rsltCd": "-2"
                    },
                    {
                        "receiveNb": "01000000985",
                        "receiveName": "테스트0985",
                        "smsType": "SMS",
                        "smsTypeNm": "단문",
                        "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000",
                        "rsltCd": "-2"
                    },
                    {
                        "receiveNb": "01000000984",
                        "receiveName": "테스트0984",
                        "smsType": "SMS",
                        "smsTypeNm": "단문",
                        "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000",
                        "rsltCd": "-2"
                    },
                    {
                        "receiveNb": "01000000983",
                        "receiveName": "테스트0983",
                        "smsType": "SMS",
                        "smsTypeNm": "단문",
                        "message": "(광고)\r\n친구톡 테스트\r\n무료거부 0800000000",
                        "rsltCd": "-2"
                    }
                ]
            }
        ]
    }
}

서비스 신청