메시지 발송 목록 조회

Classic/VPC 환경에서 이용 가능합니다.

메시지 발송 요청 목록을 조회합니다. 최근 90일 이내의 요청 목록을 조회할 수 있습니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/sms/v2/services/{serviceId}/messages

요청 헤더

Simple & Easy Notification Service API에서 공통으로 사용하는 헤더에 대한 정보는 Simple & Easy Notification Service 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`serviceId`	String	Required	SMS 서비스 아이디 프로젝트 목록 조회 참조

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`requestId`	String	Conditional	요청 아이디 메시지 발송 시 응답받은 요청 아이디 입력 `requestId`, `requestStartTime`+`requestEndTime`, `completeStartTime`+`completeEndTime` 중 하나는 필수 입력
`requestStartTime`	String	Conditional	발송 요청 기준 조회 시작 일시 YYYY-MM-DD HH:mm:ss 형식(URL 인코딩 필요) `requestId`, `requestStartTime`+`requestEndTime`, `completeStartTime`+`completeEndTime` 중 하나는 필수 입력
`requestEndTime`	String	Conditional	발송 요청 기준 조회 종료 일시 YYYY-MM-DD HH:mm:ss 형식(URL 인코딩 필요) `requestStartTime`과의 기간이 30일 이내여야 함
`completeStartTime`	String	Conditional	발송 완료 기준 조회 시작 일시 YYYY-MM-DD HH:mm:ss 형식(URL 인코딩 필요) `requestId`, `requestStartTime`+`requestEndTime`, `completeStartTime`+`completeEndTime` 중 하나는 필수 입력
`completeEndTime`	String	Conditional	발송 완료 기준 조회 종료 일시 YYYY-MM-DD HH:mm:ss 형식(URL 인코딩 필요) `completeStartTime`과의 기간이 24시간 이내여야 함
`messageId`	String	Optional	메시지 아이디
`type`	String	Optional	메시지 타입 `SMS` \| `LMS` \| `MMS` `SMS`: SMS 메시지 `LMS`: LMS 메시지 `MMS`: MMS 메시지
`contentType`	String	Optional	메시지 콘텐츠 타입 `COMM` \| `AD` `COMM`: 일반용 `AD`: 광고용
`countryCode`	String	Optional	국가 코드
`status`	String	Optional	요청 상태 `READY` \| `PROCESSING` \| `COMPLETED` `READY`: 대기중 `PROCESSING`: 처리중 `COMPLETED`: 완료
`from`	String	Optional	발신 번호 숫자만 입력 가능
`to`	String	Optional	수신 번호 숫자만 입력 가능
`statusName`	String	Optional	수신 상태 `success` \| `fail` `success`: 성공 `fail`: 실패
`nextToken`	String	Optional	페이지 위치 토큰 다음 목록 조회 시 사용하며, 이전 호출에서 응답받은 토큰값 입력
`pageSize`	Integer	Optional	페이지당 항목 수 1~100 (기본값: 20) `requestId` 입력 시 기본으로 1000 적용

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://sens.apigw.gov-ntruss.com/sms/v2/services/ncp:sms:kr:50*********1:sens/messages?requestStartTime=2025-11-25%2009%3A10%3A00&requestEndTime=2025-11-25%2010%3A30%3A00&pageSize=1' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`statusCode`	String	-	상태 코드 HTTP 상태 코드 규칙을 따름 `202`: 성공 그 외: 실패
`statusName`	String	-	상태 `success` \| `reserved` \| `fail` `success`: 성공 `reserved`: 예약 `fail`: 실패
`messages`	Array	-	메시지 발송 요청 목록: messages
`pageSize`	Integer	-	페이지당 항목 수
`pageIndex`	Integer	-	페이지 인덱스
`itemCount`	Integer	-	응답 결과 수
`hasMore`	Boolean	-	다음 페이지 존재 여부 `true`: 존재 `false`: 존재 안 함
`nextToken`	String	-	페이지 위치 토큰 다음 페이지가 없을 경우, 표시되지 않음

`messages`

messages에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`requestId`	String	-	요청 아이디
`messageId`	String	-	메시지 아이디
`requestTime`	String	-	요청 일시 YYYY-MM-DD HH:mm:ss 형식
`contentType`	String	-	메시지 콘텐츠 타입 `COMM` \| `AD` `COMM`: 일반용 `AD`: 광고용
`type`	String	-	메시지 타입 `SMS` \| `LMS` \| `MMS` `SMS`: SMS 메시지 `LMS`: LMS 메시지 `MMS`: MMS 메시지
`countryCode`	String	-	국가 코드
`from`	String	-	발신 번호
`to`	String	-	수신 번호
`completeTime`	String	-	완료 일시 YYYY-MM-DD HH:mm:ss 형식
`telcoCode`	String	-	통신사 코드
`status`	String	-	요청 상태 `READY` \| `PROCESSING` \| `COMPLETED` `READY`: 대기중 `PROCESSING`: 처리중 `COMPLETED`: 완료
`statusCode`	String	-	수신 결과 코드 참조
`statusName`	String	-	수신 상태 `success` \| `fail` `success`: 성공 `fail`: 실패
`statusMessage`	String	-	수신 상태 메시지

응답 상태 코드

Simple & Easy Notification Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Simple & Easy Notification Service 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "statusCode": "202",
    "statusName": "success",
    "messages": [
        {
            "requestId": "RSMA-*************-****-********-ijYyjJqS",
            "messageId": "f574d3f0-****-****-****-daa31f50eaf5",
            "requestTime": "2025-11-25 10:17:00",
            "contentType": "COMM",
            "type": "MMS",
            "countryCode": "82",
            "from": "010********",
            "to": "010********",
            "completeTime": "2025-11-25 10:17:00",
            "telcoCode": "ETC",
            "status": "COMPLETED",
            "statusCode": "3018",
            "statusName": "fail",
            "statusMessage": "휴대폰 가입 이동통신사를 통해 발신번호 변작 방지 부가 서비스에 가입된 번호를 발신번호로 사용하는 경우"
        }
    ],
    "pageSize": 1,
    "pageIndex": 0,
    "itemCount": 1,
    "hasMore": true,
    "nextToken": "eyJwYXJhbWV0ZXJI...MxZjUwZWFmNSJ9"
}