Get message reservation status

Prev Next

Available in Classic and VPC

Get the reservation status of message delivery.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /sms/v2/services/{serviceId}/reservations/{reserveId}/reserve-status

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
reserveId String Required Reservation request ID
  • Enter the request ID (requestId) returned upon sending message.

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/reservations/RSSA-*************-****-********-ZzdhBYsk/reserve-status' \
--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
reserveId String Required Reservation request ID
reserveTimeZone String Required Reserved time zone
reserveTime String Required Reservation date and time
  • YYYY-MM-DDTHH:mm:ss±hh:mm format
reserveStatus String Required Reservation status
  • READY | PROCESSING | CANCELED | FAIL | DONE | STALE| SKIP
    • READY: Standby
    • PROCESSING: Processing
    • CANCELED: Canceled
    • FAIL: Failure
    • DONE: Completed
    • STALE: Failure (timeout)
    • SKIP: Failure (no service)

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:

{
    "reserveId": "RSSA-*************-****-********-ZzdhBYsk",
    "reserveTimeZone": "Asia/Seoul",
    "reserveTime": "2025-11-25T13:19:00+09:00",
    "reserveStatus": "READY"
}