Get message delivery list

Prev Next

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
  • Enter the request ID received in response when sending the message.
  • One among requestId, requestStartTime+requestEndTime, or completeStartTime+completeEndTime must be entered.
requestStartTime String Conditional Query start date and time based on the delivery request
  • YYYY-MM-DD HH:mm:ss format (URL encoding required).
  • One among requestId, requestStartTime+requestEndTime, or completeStartTime+completeEndTime must be entered.
requestEndTime String Conditional Query end date and time based on the delivery request
  • YYYY-MM-DD HH:mm:ss format (URL encoding required).
  • Must be within 30 days of requestStartTime.
completeStartTime String Conditional Query start date and time based on the delivery completion
  • YYYY-MM-DD HH:mm:ss format (URL encoding required).
  • One among requestId, requestStartTime+requestEndTime, or completeStartTime+completeEndTime must be entered.
completeEndTime String Conditional Query end date and time based on the delivery completion
  • YYYY-MM-DD HH:mm:ss format (URL encoding required).
  • Must be within 24 hours of completeStartTime.
messageId String Optional Message ID
type String Optional Message type
  • SMS | LMS | MMS
    • SMS: SMS message
    • LMS: LMS message
    • MMS: MMS message
contentType String Optional Message content type
  • COMM | AD
    • COMM: General
    • AD: Advertisement
countryCode String Optional Country code
status String Optional Request status
  • READY | PROCESSING | COMPLETED
    • READY: Standby
    • PROCESSING: Processing
    • COMPLETED: Completed
from String Optional Caller ID
  • Only numbers can be entered.
to String Optional Recipient number
  • Only numbers can be entered.
statusName String Optional Reception status
  • success | fail
    • success: Success
    • fail: Failure
nextToken String Optional Page location token
  • Use this when querying the next list, and enter the token value received in the previous call.
pageSize Integer Optional Number of items per page
  • 1-100 (default: 20)
  • 1000 is applied by default when entering requestId.

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 - Status code
  • It follows HTTP status code rules.
    • 202: Success
    • Others: Failure
statusName String - Status
  • success | reserved | fail
    • success: Success
    • reserved: Reserved
    • fail: Failure
messages Array - Message delivery request list: messages
pageSize Integer - Number of items per page
pageIndex Integer - Page index
itemCount Integer - Number of response results
hasMore Boolean - Whether next page exists
  • true: It exists.
  • false: It doesn't exist.
nextToken String - Page location token
  • It isn't displayed if there is no next page.

messages

The following describes messages.

Field Type Required Description
requestId String - Request ID
messageId String - Message ID
requestTime String - Request date and time
  • YYYY-MM-DD HH:mm:ss format
contentType String - Message content type
  • COMM | AD
    • COMM: General
    • AD: Advertisement
type String - Message type
  • SMS | LMS | MMS
    • SMS: SMS message
    • LMS: LMS message
    • MMS: MMS message
countryCode String - Country code
from String - Caller ID
to String - Recipient number
completeTime String - Completion date and time
  • YYYY-MM-DD HH:mm:ss format
telcoCode String - Network provider code
status String - Request status
  • READY | PROCESSING | COMPLETED
    • READY: Standby
    • PROCESSING: Processing
    • COMPLETED: Completed
statusCode String - See Reception result code.
statusName String - Reception status
  • success | fail
    • success: Success
    • fail: Failure
statusMessage String - 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"
}