API

메시지 목록 조회

작성일 2026.03.01 | 수정일 2026.03.01

GET/messages/v4/list
Query
messagesId— 메시지 아이디
messageIds— 복수 메시지 아이디 (JSON 배열 형식)
groupId— 그룹 아이디
to— 수신번호
from— 발신번호
type— 메시지 타입
statusCode— 상태코드
chat

type 허용 값
`SMS`, `LMS`, `MMS`, `ATA`, `CTA`, `CTI`, `RCS_SMS`, `RCS_LMS`, `RCS_MMS`, `RCS_TPL`, `RCS_LTPL`, `RCS_ITPL`, `FAX`, `VOICE`


날짜 범위

NameTypedefaultDescription
startDateStringISO 8601조회 시작 일시
endDateStringISO 8601조회 종료 일시
dateTypeStringCREATEDCREATED 또는 UPDATED

페이지네이션

NameTypedefaultDescription
limitNumber20조회 개수 (최소: 1, 최대: 500)
startKeyString-다음 페이지 조회 키
이전 응답의 nextKey 값을 사용합니다

고급 검색 (criteria / cond / value)

세 파라미터를 세트로 사용하여 복합 조건 검색이 가능합니다. 각 값은 콤마(`,`)로 구분합니다

NameTypeDescription
criteriaString검색 대상 필드명 (콤마 구분)
condString비교 연산자 (콤마 구분)
valueString검색 값 (콤마 구분)

criteria 허용 필드 및 지원 연산자

NameDescriptionOperator
messageId메시지 아이디eq, ne
groupId그룹 아이디eq, ne
to수신번호eq, ne
from발신번호eq, ne
type메시지 타입eq, ne
statusCode상태 코드eq, ne, gt, gte, lt, lte
status메시지 상태eq, ne
dateCreated생성 일시eq, ne, gt, gte, lt, lte
dateUpdated수정 일시eq, ne, gt, gte, lt, lte
replacement대체 발송 여부eq, ne
kakaoTemplateId카카오 템플릿 IDeq, ne

cond 연산자

NameDescription
eq같음 (=)
ne같지 않음 (!=)
gt초과 (>)
gte이상 (>=)
lt미만 (<)
lte이하 (<=)


요청 예시

GET /messages/v4/list?limit=10
GET /messages/v4/list?to=01012345678
GET /messages/v4/list?startDate=2024-01-01T00:00:00Z&endDate=2024-01-31T23:59:59Z
GET /messages/v4/list?criteria=statusCode,type&cond=eq,eq&value=4000,SMS
GET /messages/v4/list?startKey=M4V20240525163506XXXXXXXXXXXXXXX&limit=20


Response

NameTypemustDescription
startKeystring|null*현재 목록을 불러올 기준이 되는 키
nextKeystring다음 페이지를 불러오기 위한 키. 다음 페이지가 없으면 미포함
limitnumber*한번에 불러올 메시지 개수
messageListobject*메시지 목록. messageId를 키로 사용하는 객체
<messageId>Object
messageIdstring*메시지 아이디
groupIdstring*메시지가 속한 그룹 아이디
accountIdstring*계정 고유번호
tostring*수신번호
fromstring|null*발신번호
textstring*메시지 내용
typestring|null*메시지 타입 (SMS, LMS, MMS, ATA, CTA, CTI, NSA, RCS_SMS, RCS_LMS, RCS_MMS, RCS_TPL, RCS_ITPL, RCS_LTPL, FAX, VOICE 등)
countrystring*발송 대상 국가번호 (기본: 82)
subjectstring|null*메시지 제목
imageIdstring|null*이미지 아이디
customFieldsobject*사용자 정의 확장 필드 (키 30자, 값 1,000자 제한)
statusstring*메시지 상태. PENDING(대기중), SENDING(전송중), COMPLETE(처리완료)
statusCodestring|null*메시지 상태 코드. 2000이면 접수 성공
networkCodestring|null*단말기 통신사 코드
replacementboolean*대체 발송 여부. true면 대체발송된 메시지
replacementsarray*대체 발송 정보
autoTypeDetectboolean*자동 타입 감지 여부. 기본값: true
unavailableSenderNumberboolean*미등록 발신번호 여부. true면 대체발송 차단
faxPageCountnumber*팩스 페이지 수
resendCountnumber*재전송 시도 횟수
voiceRepliednumber*음성 메시지 응답 (수신자가 누른 번호)
voiceDurationnumber*음성 메시지 통화 시간
queuesarray*전송에 사용된 큐 정보
namestring큐 이름
statusCodestring|null큐 상태 코드
uniqIdstring|null큐 고유 아이디
currentQueuestring|null*현재 처리에 사용된 큐 (라우팅된 메시지큐 이름)
dateProcesseddate|null*메시지 처리 일시 (통신사로 접수된 시각)
dateReporteddate|null*메시지 전송 결과 보고 일시 (리포트 수신 시각)
dateReceiveddate|null*단말기 수신 일시
dateCreateddate*메시지 생성 일시
dateUpdateddate*메시지 갱신 일시
logarray*메시지 로그
createAtdate로그 기록 일시
messagestring로그 메시지
kakaoOptionsobject*카카오톡 알림톡/친구톡 옵션
pfIdstring카카오톡 채널 연동 아이디
senderKeystring센더키 (하위 호환용)
templateIdstring알림톡 템플릿 연동 아이디
templateCodestring템플릿 코드 (하위 호환용)
titlestring강조표기 핵심문구
adFlagboolean광고 표시 여부
buttonNamestring버튼 이름 (하위 호환용)
buttonUrlstring버튼 URL (하위 호환용)
disableSmsboolean실패 시 문자 대체 발송 여부. 기본값: false (대체 발송 허용)
imageIdstring친구톡 이미지 아이디
buttonsarray알림톡/친구톡 버튼 목록
quickRepliesarray바로연결 버튼 정보
headerstring알림톡 헤더 (아이템 리스트형)
highlightobject하이라이트 정보
titlestring하이라이트 제목
descriptionstring하이라이트 설명
imageIdstring하이라이트 이미지 아이디
itemobject아이템리스트형 아이템 정보
listarray아이템 목록
titlestring아이템 제목
descriptionstring아이템 설명
summaryobject요약 정보
titlestring요약 제목
descriptionstring요약 내용
naverOptionsobject*네이버 스마트알림 옵션
talkIdstring네이버톡톡 채널 아이디
templateIdstring네이버 템플릿 아이디
disableSmsboolean실패 시 문자 대체 발송 여부. 기본값: false
buttonsarray버튼 정보
rcsOptionsobject*RCS 문자 옵션
brandIdstring브랜드 아이디
templateIdstringRCS 템플릿 아이디
mmsTypestring사진 문자 타입 (M3, S3, M4, S4, M5, S5, M6, S6)
copyAllowedboolean내용 복사 허용
commercialTypeboolean광고 여부. 기본값: false
disableSmsboolean실패 시 문자 대체 발송 여부. 기본값: false
additionalBodyarray슬라이드 정보
buttonsarray버튼 정보
faxOptionsobject*팩스 옵션
fileIdsstring[]팩스 내용 파일 아이디
voiceOptionsobject*음성 메시지 옵션
voiceTypestring보이스 타입 (MALE, FEMALE)
headerMessagestring머리말 (통화 시작 시 나오는 메시지)
tailMessagestring맺음말 (통화 종료 후 나오는 메시지)
replyRangenumber수신자에게 입력받을 숫자 범위 (1~9)
counselorNumberstring상담원 번호 (0번 누르면 연결)
reasonstring|null*메시지 상태 메시지. statusCode에 대응하는 설명 (조회 시 자동 생성)
networkNamestring*단말기 통신사 이름. networkCode에 대응하는 이름 (조회 시 자동 생성)
{
  "messageList": {
    "M4V20240525163506CQKNPHTPCX4P5E": {
      "messageId": "M4V20240525163506CQKNPHTPCX4P5E",
      "groupId": "G4V20240525163506ABCDEFGHIJKLMNO",
      "accountId": "24010100001234",
      "to": "01012345678",
      "from": "0212345678",
      "text": "테스트 메시지입니다.",
      "type": "SMS",
      "country": "82",
      "status": "COMPLETE",
      "statusCode": "4000",
      "reason": "정상 처리",
      "networkCode": "10001",
      "networkName": "SKT",
      "dateCreated": "2024-05-25T07:35:06.000Z",
      "dateUpdated": "2024-05-25T07:35:10.000Z",
      "dateReceived": "2024-05-25T07:35:10.000Z",
      "replacement": false
    }
  },
  "limit": 20,
  "startKey": null,
  "nextKey": "M4V20240525163500XXXXXXXXXXXXXXX"
}

`messageList`는 배열이 아닌 messageId를 key로 하는 객체 형태입니다.
`nextKey`가 `null`이면 마지막 페이지입니다.

Structures

{ "startKey": "string|null", "nextKey": "string", "limit": "number", "messageList": { "<messageId>": { "messageId": "string", "groupId": "string", "accountId": "string", "to": "string", "from": "string|null", "text": "string", "type": "string|null", "country": "string", "subject": "string|null", "imageId": "string|null", "customFields": "object", "status": "string", "statusCode": "string|null", "networkCode": "string|null", "replacement": "boolean", "replacements": [ { "to": "string", "from": "string", "text": "string", "customFields": "object" } ], "autoTypeDetect": "boolean", "unavailableSenderNumber": "boolean", "faxPageCount": "number", "resendCount": "number", "voiceReplied": "number", "voiceDuration": "number", "queues": [ { "name": "string", "statusCode": "string|null", "uniqId": "string|null" } ], "currentQueue": "string|null", "dateProcessed": "date|null", "dateReported": "date|null", "dateReceived": "date|null", "dateCreated": "date", "dateUpdated": "date", "log": [ { "createAt": "date", "message": "string" } ], "kakaoOptions": { "pfId": "string", "senderKey": "string", "templateId": "string", "templateCode": "string", "title": "string", "adFlag": "boolean", "buttonName": "string", "buttonUrl": "string", "disableSms": "boolean", "imageId": "string", "buttons": [ { "buttonName": "string", "buttonType": "string", "linkMo": "string", "linkPc": "string", "linkAnd": "string", "linkIos": "string", "chatExtra": "string", "targetOut": "boolean" } ], "quickReplies": [ { "name": "string", "linkType": "string", "linkMo": "string", "linkPc": "string", "linkAnd": "string", "linkIos": "string", "chatExtra": "string", "targetOut": "boolean" } ], "header": "string", "highlight": { "title": "string", "description": "string", "imageId": "string" }, "item": { "list": [ { "title": "string", "description": "string" } ], "summary": { "title": "string", "description": "string" } } }, "naverOptions": { "talkId": "string", "templateId": "string", "disableSms": "boolean", "buttons": [ { "buttonCode": "string", "buttonName": "string", "buttonType": "string", "linkMo": "string", "linkPc": "string", "linkAnd": "string", "linkIos": "string" } ] }, "rcsOptions": { "brandId": "string", "templateId": "string", "mmsType": "string", "copyAllowed": "boolean", "commercialType": "boolean", "disableSms": "boolean", "additionalBody": [ { "title": "string", "description": "string", "imageId": "string", "buttons": [ { "buttonType": "string", "buttonName": "string", "link": "string", "latitude": "string", "longitude": "string", "label": "string", "query": "string", "title": "string", "startTime": "date", "endTime": "date", "text": "string", "phone": "string" } ] } ], "buttons": [ { "buttonType": "string", "buttonName": "string", "link": "string", "latitude": "string", "longitude": "string", "label": "string", "query": "string", "title": "string", "startTime": "date", "endTime": "date", "text": "string", "phone": "string" } ] }, "faxOptions": { "fileIds": [ "string" ] }, "voiceOptions": { "voiceType": "string", "headerMessage": "string", "tailMessage": "string", "replyRange": "number", "counselorNumber": "string" }, "reason": "string|null", "networkName": "string" } } }