Available in Classic and VPC
Get the list of message delivery requests. You can query the list of requests within the last 90 days.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| GET | /sms/v2/services/{serviceId}/messages |
Request headers
For information about the headers common to all Simple & Easy Notification Service APIs, see Simple & Easy Notification Service request headers.
Request path parameters
You can use the following path parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
serviceId |
String | Required | SMS service ID
|
Request query parameters
You can use the following query parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
requestId |
String | Conditional | Request ID
|
requestStartTime |
String | Conditional | Query start date and time based on the delivery request
|
requestEndTime |
String | Conditional | Query end date and time based on the delivery request
|
completeStartTime |
String | Conditional | Query start date and time based on the delivery completion
|
completeEndTime |
String | Conditional | Query end date and time based on the delivery completion
|
messageId |
String | Optional | Message ID |
type |
String | Optional | Message type
|
contentType |
String | Optional | Message content type
|
countryCode |
String | Optional | Country code |
status |
String | Optional | Request status
|
from |
String | Optional | Caller ID
|
to |
String | Optional | Recipient number
|
statusName |
String | Optional | Reception status
|
nextToken |
String | Optional | Page location token
|
pageSize |
Integer | Optional | Number of items per page
|
Request example
The request example is as follows:
curl --location --request GET 'https://sens.apigw.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}'
Response
This section describes the response format.
Response body
The response body includes the following data:
| Field | Type | Required | Description |
|---|---|---|---|
statusCode |
String | Required | Status code
|
statusName |
String | Required | Status
|
messages |
Array | Required | Message delivery request list |
pageSize |
Integer | Required | Number of items per page |
pageIndex |
Integer | Required | Page index |
itemCount |
Integer | Required | Number of response results |
hasMore |
Boolean | Required | Whether next page exists
|
nextToken |
String | Optional | Page location token
|
messages
The following describes messages.
| Field | Type | Required | Description |
|---|---|---|---|
requestId |
String | Required | Request ID |
messageId |
String | Required | Message ID |
requestTime |
String | Required | Request date and time
|
contentType |
String | Required | Message content type
|
type |
String | Required | Message type
|
countryCode |
String | Required | Country code |
from |
String | Required | Caller ID |
to |
String | Required | Recipient number |
completeTime |
String | Optional | Completion date and time
|
telcoCode |
String | Optional | Network provider code |
status |
String | Required | Request status
|
statusCode |
String | Optional | Reception result code |
statusName |
String | Optional | Reception status
|
statusMessage |
String | Optional | Reception status message |
Response status codes
For information about the HTTP status codes common to all Simple & Easy Notification Service APIs, see Simple & Easy Notification Service response status codes.
Response example
The response example is as follows:
{
"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": "When using a number subscribed to a caller ID spoofing prevention add-on service through a mobile carrier as the caller ID"
}
],
"pageSize": 1,
"pageIndex": 0,
"itemCount": 1,
"hasMore": true,
"nextToken": "eyJwYXJhbWV0ZXJI...MxZjUwZWFmNSJ9"
}