Classic/VPC 환경에서 이용 가능합니다.
브랜드 메시지의 메시지에 대한 발송 요청 목록을 조회합니다. 최근 30일 이내의 요청 목록을 조회할 수 있습니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /brandmessage/v2/services/{serviceId}/messages |
요청 헤더
Simple & Easy Notification Service API에서 공통으로 사용하는 헤더에 대한 정보는 Simple & Easy Notification Service 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
serviceId |
String | Required | Biz Message 서비스 아이디
|
요청 쿼리 파라미터
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
requestId |
String | Conditional | 요청 아이디
|
requestStartTime |
String | Conditional | 발송 요청 기준 조회 시작 일시
|
requestEndTime |
String | Conditional | 발송 요청 기준 조회 종료 일시
|
completeStartTime |
String | Conditional | 발송 완료 기준 조회 시작 일시
|
completeEndTime |
String | Conditional | 발송 완료 기준 조회 종료 일시
|
plusFriendId |
String | Conditional | 채널 아이디
|
messageId |
String | Optional | 메시지 아이디 |
requestStatusName |
String | Optional | 요청 상태
|
messageStatusName |
String | Optional | 수신 상태
|
templateCode |
String | Optional | 템플릿 코드
|
to |
String | Optional | 수신 번호
|
nextToken |
String | Optional | 페이지 위치 토큰
|
pageSize |
Integer | Optional | 페이지당 항목 수
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://sens.apigw.ntruss.com/brandmessage/v2/services/ncp:kkobizmsg:kr:27*********6:sens/messages?requestStartTime=2025-11-25T09%3A10%3A00&requestEndTime=2025-11-25T23%3A30%3A00&pageSize=3' \
--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 | Required | 상태 코드
|
statusName |
String | Required | 상태
|
messages |
Array | Required | 메시지 발송 요청 목록 |
pageSize |
Integer | Required | 페이지당 항목 수 |
pageIndex |
Integer | Required | 페이지 인덱스 |
nextToken |
String | Optional | 페이지 위치 토큰
|
itemCount |
Integer | Required | 응답 결과 수 |
hasMore |
Boolean | Required | 다음 페이지 존재 여부
|
messages
messages에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
requestTime |
String | Required | 요청 일시
|
requestId |
String | Required | 요청 아이디 |
messageId |
String | Required | 메시지 아이디 |
countryCode |
String | Optional | 국가 코드 |
to |
String | Required | 수신 번호 |
content |
String | Optional | 메시지 내용 |
plusFriendId |
String | Required | 채널 아이디 |
messageType |
String | Required | 메시지 타입
|
isAdult |
Boolean | Required | 대상 연령
|
targeting |
String | Required | 타겟팅 코드
|
completeTime |
String | Optional | 완료 일시
|
requestStatusCode |
String | Required | 요청 상태 코드
|
requestStatusName |
String | Required | 요청 상태
|
requestStatusDesc |
String | Required | 요청 상태 설명 |
messageStatusCode |
String | Optional | 수신 상태 코드
|
messageStatusName |
String | Optional | 수신 상태
|
messageStatusDesc |
String | Optional | 수신 상태 설명 |
useSmsFailover |
Boolean | Required | SMS 대체 발송 사용 여부
|
failover |
Object | Optional | SMS 대체 발송 정보
|
failover.smsServiceId |
String | Required | 대체 발송에 사용된 SMS 서비스 아이디 |
failover.requestId |
String | Required | 대체 발송 요청 아이디 |
failover.messageId |
String | Required | 대체 발송 메시지 아이디 |
failover.requestStatusCode |
String | Required | SMS 대체 발송 요청 상태 코드 |
failover.requestStatusName |
String | Required | 대체 발송 요청 상태
|
failover.requestStatusDesc |
String | Optional | 대체 발송 요청 상태 설명 |
failover.messageStatus |
String | Optional | 대체 발송 메시지 상태
|
failover.messageStatusCode |
String | Optional | 대체 발송 메시지 수신 상태 코드
|
failover.messageStatusName |
String | Optional | 대체 발송 메시지 수신 상태 |
failover.messageStatusDesc |
String | Optional | 대체 발송 메시지 수신 상태 설명 |
응답 상태 코드
Simple & Easy Notification Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Simple & Easy Notification Service 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"statusCode": "202",
"statusName": "success",
"messages": [
{
"requestTime": "2025-11-28T11:21:06.317",
"requestId": "RBBA-*************-****-********-QlvjXtBr",
"messageId": "bc87c708-****-****-****-57b56c506309",
"countryCode": "82",
"to": "010********",
"plusFriendId": "@******",
"messageType": "TEXT",
"targeting": "I",
"isAdult": false,
"completeTime": "2025-11-28T11:21:06",
"requestStatusCode": "A000",
"requestStatusName": "success",
"requestStatusDesc": "성공",
"messageStatusCode": "0000",
"messageStatusName": "success",
"messageStatusDesc": "정상 발송",
"useSmsFailover": false
},
{
"requestTime": "2025-11-28T10:46:55.663",
"requestId": "RBBA-*************-****-********-kgepsygn",
"messageId": "3d68485a-****-****-****-730c20492b51",
"countryCode": "82",
"to": "010********",
"plusFriendId": "@******",
"messageType": "TEXT",
"targeting": "I",
"isAdult": false,
"completeTime": "2025-11-28T10:46:56",
"requestStatusCode": "A000",
"requestStatusName": "success",
"requestStatusDesc": "성공",
"messageStatusCode": "0000",
"messageStatusName": "success",
"messageStatusDesc": "정상 발송",
"useSmsFailover": true,
"failover": {
"smsServiceId": "ncp:sms:kr:27*********6:sens",
"requestId": "RSLA-*************-****-********-ZzdhBYsk",
"messageId": "6cc7eab4-****-****-****-c523f8a0e8ce",
"requestStatusCode": "0",
"requestStatusName": "success",
"requestStatusDesc": "성공",
"messageStatus": "COMPLETED",
"messageStatusCode": "0",
"messageStatusName": "success",
"messageStatusDesc": "성공"
}
}
],
"pageSize": 2,
"pageIndex": 0,
"nextToken": "**********V0ZXJIYXNoIjoiNTBkOTg5NTdkYmM2MjIwZWJjMzAyMzNiNmQwZWRlN**********jZGJlMmI5MTcyOTQ3ZDNiZjU0YzRjNjU3NiIsInRva2VuSGFzaCI6ImVmM2NlNGUyMjc1MTE1ZDNiMDZiNjhmNzJiOWM0MDcxOTQ1MjA2MGRiN2M4MmRiYTQ1MGMxNzIwOTBiNmMy**********NoZWRFcG9jaE1pbGxpcyI6MTc2NDI5NjU4MDIwMywicmVxdWVzdFRpbWVFcG9jaE1pbGxpcyI6MTc2NDI5NDQxNTY2MywiY29tcGxldGVUaW1lRXBvY2hNaWxsaXMiOm51bGwsIm1lc3NhZ2VJZCI6IjNkNjg0ODVhLWU3NmQtNGE3Ny05Y2Q0LTczMGMyMD**********",
"itemCount": 2,
"hasMore": true
}