전체 발송내역 조회

API 목록

No	Method	API	Description
1	GET	/v1/openapi/message	발송내역 목록 조회 API

1. 발송내역 목록 조회

• 발송 내역은 항상 msgGrpNo기준 내림차순으로 정렬됩니다

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

1.1 Query String Parameters

Name	Type	Required	Description	Example
svcKndCd	String	N	서비스 유형코드 : SMS, LMS, MMS, TKA(알림톡 텍스트), TKI(알림톡 이미지), TKT(친구톡 텍스트), TKF(친구톡 이미지), TKW(친구톡 와이드), GLOBALSMS(국제 SMS)	TKA
msgSndStsCd	String	N	문자 발송 상태코드 : [''] 전체, [MGD] 진행중, [MGC] 완료	MGC
keyword	String	N	검색어 ( 메시지 제목 / 카카오 채널 ID / API ID / 발신번호 )	메가버드
snPhnum	String	N	발신전화번호	01012345678
sndBeginDate	String	N	발송일시 시작일 날짜 범위는 최대 한달까지이며 발송일시 범위 또는 결과수신 범위중 1가지는 반드시 지정해야합니다	2022-10-04
sndEndDate	String	N	발송일시 종료일 날짜 범위는 최대 한달까지이며 발송일시 범위 또는 결과수신 범위중 1가지는 반드시 지정해야합니다	2022-10-09
cplBeginDate	String	N	결과수신 시작일 날짜 범위는 최대 한달까지이며 발송일시 범위 또는 결과수신 범위중 1가지는 반드시 지정해야합니다	2022-10-04
cplEndDate	String	N	결과수신 종료일 날짜 범위는 최대 한달까지이며 발송일시 범위 또는 결과수신 범위중 1가지는 반드시 지정해야합니다	2022-10-09
pageSize	Integer	N	한번에 조회할 목록 수 ( Default : 100 )	1
lastSeenId	Long	N	마지막으로 확인된 메시지 그룹 아이디	100

1.2 Request Example

https://stg-api.aimegazone.com:8080/v1/openapi/message?svcKndCd=SMS&msgSndStsCd=MGC

1.3 Response Body Parameters

Name	Type	설명
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인스턴스아이디
subtxtUseYn	String	대체문자사용여부
subtxtTrsmPhnum	String	대체문자발신전화번호
subtxtTtl	String	대체문자제목
subtxtCotn	String	대체문자내용
subtxtMsgDvsCd	String	대체문자 메시지구분코드
subtxtMsgDvsCdNm	String	대체문자 메시지구분코드명
regDtt	LocalDateTime	등록일시
sndStartDtt	LocalDateTime	발송일시
sndCnt	Integer	발송건수
sndCplDtt	LocalDateTime	발송완료일시
sndComplateCnt	Integer	발송완료건수
sndFailCnt	Integer	발송실패건수
sndRequestCnt	Integer	발송대기건수
subtxtSndComplateCnt	Integer	대체문자 발송완료건수
subtxtSndFailCnt	Integer	대체문자 발송실패건수
sndPrice	BigDecimal	총 발송금액

1.4 Response Example

{
    "code": "0000",
    "result": {
        "totalCount": 1155,
        "result": [
            {
                "msgGrpNo": 105818,
                "tmplId": null,
                "tmplTtl": null,
                "msgDvsCd": "TKF",
                "msgDvsCdNm": "친구톡",
                "svcKndCd": "TKT",
                "svcKndCdNm": "친구톡(텍스트)",
                "snPhnum": "-",
                "msgTtl": null,
                "msgCotn": "친구톡 텍스트 dev",
                "msgGrpStsCd": "MNR",
                "msgGrpStsCdNm": "정상",
                "msgSndStsCd": "MGD",
                "msgSndStsCdNm": "진행중",
                "adIncluYn": "N",
                "chnId": "@므앙홈",
                "entprNm": null,
                "apiInstcId": "1dc9b95d6b464f88890b81981da3db1f",
                "subtxtUseYn": "N",
                "subtxtTrsmPhnum": "",
                "subtxtTtl": null,
                "subtxtCotn": null,
                "subtxtMsgDvsCd": null,
                "subtxtMsgDvsCdNm": null,
                "regDtt": "2024-09-10T13:18:51",
                "sndCnt": 1,
                "sndCplDtt": null,
                "sndComplateCnt": 0,
                "sndFailCnt": 0,
                "sndRequestCnt": 1,
                "sndPrice": 0.0,
                "subtxtSndComplateCnt": 0,
                "subtxtSndFailCnt": 0
            },
            {
                "msgGrpNo": 105817,
                "tmplId": "TKA0000116",
                "tmplTtl": "mts dev 기본값 테스트",
                "msgDvsCd": "TKA",
                "msgDvsCdNm": "알림톡",
                "svcKndCd": "TKA",
                "svcKndCdNm": "알림톡",
                "snPhnum": "-",
                "msgTtl": "mts dev 기본값 테스트",
                "msgCotn": "mts dev 기본값 테스트",
                "msgGrpStsCd": "MNR",
                "msgGrpStsCdNm": "정상",
                "msgSndStsCd": "MGC",
                "msgSndStsCdNm": "완료",
                "adIncluYn": "N",
                "chnId": "@므앙홈",
                "entprNm": null,
                "apiInstcId": "1dc9b95d6b464f88890b81981da3db1f",
                "subtxtUseYn": "Y",
                "subtxtTrsmPhnum": "15771577",
                "subtxtTtl": "알림톡 대체문자 제목",
                "subtxtCotn": "알림톡 대체문자 내용알림톡 대체문자 내용알림톡 대체문자 내용알림톡 대체문자 내용알림톡 대체문자 내용",
                "subtxtMsgDvsCd": "LMS",
                "subtxtMsgDvsCdNm": "LMS",
                "regDtt": "2024-09-10T13:13:15",
                "sndCnt": 1,
                "sndCplDtt": "2024-09-10T13:13:31",
                "sndComplateCnt": 0,
                "sndFailCnt": 1,
                "sndRequestCnt": 0,
                "sndPrice": 1.2,
                "subtxtSndComplateCnt": 1,
                "subtxtSndFailCnt": 0
            },
            {
                "msgGrpNo": 105819,
                "tmplId": null,
                "tmplTtl": null,
                "msgDvsCd": "SLM",
                "msgDvsCdNm": "문자메시지",
                "svcKndCd": "SMS",
                "svcKndCdNm": "SMS",
                "snPhnum": "15332698",
                "msgTtl": null,
                "msgCotn": "api sms test",
                "msgGrpStsCd": "MNR",
                "msgGrpStsCdNm": "정상",
                "msgSndStsCd": "MGR",
                "msgSndStsCdNm": "예약",
                "adIncluYn": "N",
                "chnId": null,
                "entprNm": null,
                "apiInstcId": "1dc9b95d6b464f88890b81981da3db1f",
                "subtxtUseYn": null,
                "subtxtTrsmPhnum": "",
                "subtxtTtl": null,
                "subtxtCotn": null,
                "subtxtMsgDvsCd": null,
                "subtxtMsgDvsCdNm": null,
                "regDtt": "2024-09-10T13:21:02",
                "sndCnt": 1,
                "sndCplDtt": null,
                "sndComplateCnt": 0,
                "sndFailCnt": 0,
                "sndRequestCnt": 1,
                "sndPrice": 0.0,
                "subtxtSndComplateCnt": 0,
                "subtxtSndFailCnt": 0
            }
        ]
    }
}