발송내역 상세 조회

API 목록

No	Method	API	Description
1	GET	/v1/openapi/message/{msgGrpNo}	발송내역 상세 조회 API

1. 발송내역 상세 조회

GEThttps://api.megabird.co.kr:8080/v1/openapi/message/{msgGrpNo}

1.1 Path Parameters

Name	Type	Required	Description	Example
msgGrpNo	String	Y	메시지그룹번호	101291

1.2 Request Example

https://api.megabird.co.kr:8080/v1/openapi/message/12345

1.3 Response Body Parameters

Name	Type	Description
msgGrpNo	Long	메시지그룹번호
tmplId	String	템플릿아이디
tmplTtl	String	템플릿제목
msgDvsCd	String	메시지구분코드 SLM - 문자 메시지, TKA - 알림톡, TKF - 친구톡, GLOBALSMS - 국제SMS
msgDvsCdNm	String	메시지구분코드명
svcKndCd	String	서비스종류코드 [SMS], [LMS], [MMS], [TKA]알림톡(텍스트), [TKI]알림톡(이미지), [TKT]친구톡(텍스트), [TKF]친구톡(이미지), [TKW]친구톡(와이드), [GLOBALSMS](국제SMS)
svcKndCdNm	String	서비스종류코드명
snPhnum	String	발신전화번호
msgTtl	String	메시지제목
msgCotn	String	메시지내용
msgGrpStsCd	String	메시지그룹상태코드 (MNR - 정상)
msgGrpStsCdNm	String	메시지그룹상태코드명
msgSndStsCd	String	메시지발송상태코드 (MGC - 완료 , MGD - 진행중, MGR - 예약)
msgSndStsCdNm	String	메시지발송상태코드명
adIncluYn	String	광고포함여부
chnId	String	채널아이디
entprNm	String	업체명
apiInstcId	String	API인스턴스아이디
addrGrpNmList	List<String>	수신그룹
subtxtUseYn	String	대체문자사용여부
subtxtTrsmPhnum	String	대체문자발신전화번호
subtxtTtl	String	대체문자제목
subtxtCotn	String	대체문자내용
subtxtMsgDvsCd	String	대체문자 메시지구분코드
subtxtMsgDvsCdNm	String	대체문자 메시지구분코드명
regDtt	LocalDateTime	등록일시
sndCnt	Integer	발송건수
sndCplDtt	LocalDateTime	발송완료일시
sndComplateCnt	Integer	발송완료건수
sndFailCnt	Integer	발송실패건수
sndRequestCnt	Integer	발송대기건수
sndPrice	BigDecimal	총 발송금액
subtxtSndComplateCnt	Integer	대체문자 발송완료건수
subtxtSndFailCnt	Integer	대체문자 발송실패건수
friendHistoryFile	Json	카카오톡 이미지 friendHistoryFile 상세
messageHistoryFileList	List	이미지 파일 상세 목록 messageHistoryFileList 상세
messageHistoryButtonList	List	카카오톡 버튼 목록 messageHistoryButtonList 상세

1.4 friendHistoryFile

Name	Description
msgGrpNo	메시지 그룹번호
flId	파일 아이디
sortNum	정렬 순번
flNm	파일명
flPath	파일경로
flVol	파일용량
regDtt	등록일시
regrId	등록자 아이디

1.5 messageHistoryFileList

Name	Description
msgGrpNo	메시지 그룹번호
flId	파일 아이디
sortNum	정렬 순번
flNm	파일명
flPath	파일경로
fileCotn	이미지 파일 내용 ( Base64로 인코딩된 문자열 )
flVol	파일용량
regDtt	등록일시
regrId	등록자 아이디

1.6 messageHistoryButtonList

Name	설명
msgGrpNo	메시지 그룹번호
btnKndCd	버튼 종류 코드
btnKndCdNm	버튼 종류 코드명
btnNm	버튼명
lk1Url	링크 1 URL
lk2Url	링크 2 URL
sortNum	정렬 순번

1.7 Response Example

SMS 발송내역

{
    "code": "0000",
    "result": {
        "msgGrpNo": 12345,
        "tmplId": null,
        "tmplTtl": null,
        "msgDvsCd": "SLM",
        "msgDvsCdNm": "문자메시지",
        "svcKndCd": "SMS",
        "svcKndCdNm": "SMS",
        "snPhnum": "12341234",
        "msgTtl": null,
        "msgCotn": "api sms test",
        "msgGrpStsCd": "MNR",
        "msgGrpStsCdNm": "정상",
        "msgSndStsCd": "MGC",
        "msgSndStsCdNm": "완료",
        "adIncluYn": "N",
        "chnId": null,
        "entprNm": null,
        "apiInstcId": "1k12jkl23465756k",
        "addrGrpNmList": [],
        "subtxtUseYn": null,
        "subtxtTrsmPhnum": "",
        "subtxtTtl": null,
        "subtxtCotn": null,
        "subtxtMsgDvsCd": null,
        "subtxtMsgDvsCdNm": null,
        "regDtt": "2024-01-01T15:06:59",
        "sndCnt": 1,
        "sndCplDtt": "2024-01-01T15:07:02",
        "sndComplateCnt": 0,
        "sndFailCnt": 1,
        "sndRequestCnt": 0,
        "sndPrice": 0.0,
        "subtxtSndComplateCnt": 0,
        "subtxtSndFailCnt": 0,
        "friendHistoryFile": null,
        "messageHistoryFileList": [],
        "messageHistoryButtonList": []
    }
}

MMS 발송내역

{
    "code": "0000",
    "result": {
        "msgGrpNo": 100000,
        "tmplId": null,
        "tmplTtl": null,
        "msgDvsCd": "SLM",
        "msgDvsCdNm": "문자메시지",
        "svcKndCd": "MMS",
        "svcKndCdNm": "MMS",
        "snPhnum": "12341234",
        "msgTtl": "mms test",
        "msgCotn": "mms test",
        "msgGrpStsCd": "MNR",
        "msgGrpStsCdNm": "정상",
        "msgSndStsCd": "MGD",
        "msgSndStsCdNm": "진행중",
        "adIncluYn": "N",
        "chnId": null,
        "entprNm": null,
        "apiInstcId": "1234asdfasd1234asdf",
        "addrGrpNmList": [],
        "subtxtUseYn": null,
        "subtxtTrsmPhnum": "",
        "subtxtTtl": null,
        "subtxtCotn": null,
        "subtxtMsgDvsCd": null,
        "subtxtMsgDvsCdNm": null,
        "regDtt": "2024-01-01T13:45:17",
        "sndCnt": 1,
        "sndCplDtt": null,
        "sndComplateCnt": 0,
        "sndFailCnt": 1,
        "sndRequestCnt": 0,
        "sndPrice": 0.0,
        "subtxtSndComplateCnt": 0,
        "subtxtSndFailCnt": 0,
        "friendHistoryFile": null,
        "messageHistoryFileList": [
            {
                "msgGrpNo": "105821",
                "flId": "a87198vhkhljkh12lvjhd",
                "sortNum": 1,
                "flNm": "15001500.jpg",
                "flPath": "/2024/09/a87198vhkhljkh12lvjhd.jpg",
                "fileCotn": "/9j/4QEyRXhpZgAATU0AKgAAAAgACQESAAMAAAABAAEAAAEaAAUAAAABAAAAegEbAAUAAAABAAAAggEoAAMAAAABAAIAAAExAAIAAAAkAAAAigE7AAIAAAAQAAAArgITAAMAAAABAAEAAIKYAAIAAAAQAAAAvodpAAQAAAABAAAAzgAAAAAAAABIAAAAAQAAAEgAAAABQWRvYmUgUGhvdG9zaG9wIEN,
                "flVol": 460551,
                "regDtt": "2024-01-01T18:12:11",
                "regrId": "a1274akkjh1289789as"
            }
        ],
        "messageHistoryButtonList": []
    }
}

버튼이 있는 발송 내역

{
    "code": "0000",
    "result": {
        "msgGrpNo": 111111,
        "tmplId": null,
        "tmplTtl": null,
        "msgDvsCd": "TKF",
        "msgDvsCdNm": "친구톡",
        "svcKndCd": "TKT",
        "svcKndCdNm": "친구톡(텍스트)",
        "snPhnum": "-",
        "msgTtl": null,
        "msgCotn": "친구톡 텍스트 dev",
        "msgGrpStsCd": "MNR",
        "msgGrpStsCdNm": "정상",
        "msgSndStsCd": "MGC",
        "msgSndStsCdNm": "완료",
        "adIncluYn": "N",
        "chnId": "@채널명",
        "entprNm": null,
        "apiInstcId": "1k3k6jkllkj2l7kk4",
        "addrGrpNmList": [],
        "subtxtUseYn": "N",
        "subtxtTrsmPhnum": "",
        "subtxtTtl": null,
        "subtxtCotn": null,
        "subtxtMsgDvsCd": null,
        "subtxtMsgDvsCdNm": null,
        "regDtt": "2024-01-01T17:11:57",
        "sndCnt": 1,
        "sndCplDtt": "2024-01-01T17:12:04",
        "sndComplateCnt": 0,
        "sndFailCnt": 1,
        "sndRequestCnt": 0,
        "sndPrice": 0.0,
        "subtxtSndComplateCnt": 0,
        "subtxtSndFailCnt": 0,
        "friendHistoryFile": null,
        "messageHistoryFileList": [],
        "messageHistoryButtonList": [
            {
                "msgGrpNo": "111111",
                "btnKndCd": "BTW",
                "btnKndCdNm": "웹링크",
                "btnNm": "웹버튼",
                "lk1Url": "https://www.megabird.com/",
                "lk2Url": "https://www.naver.com/",
                "sortNum": 1
            },
            {
                "msgGrpNo": "111111",
                "btnKndCd": "BTA",
                "btnKndCdNm": "앱링크",
                "btnNm": "앱버튼",
                "lk1Url": "https://www.naver.com/",
                "lk2Url": "https://www.megabird.com/",
                "sortNum": 2
            },
            {
                "msgGrpNo": "111111",
                "btnKndCd": "BTK",
                "btnKndCdNm": "봇키워드",
                "btnNm": "봇키워드",
                "lk1Url": null,
                "lk2Url": null,
                "sortNum": 3
            },
            {
                "msgGrpNo": "111111",
                "btnKndCd": "BTT",
                "btnKndCdNm": "버튼텍스트",
                "btnNm": "버튼텍스트",
                "lk1Url": null,
                "lk2Url": null,
                "sortNum": 4
            }
        ]
    }
}