Classic/VPC環境で利用できます。
メッセージの予約送信状態を照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /sms/v2/services/{serviceId}/reservations/{reserveId}/reserve-status |
リクエストヘッダ
Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceId |
String | Required | SMSサービス ID
|
reserveId |
String | Required | 予約リクエスト ID
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
reserveId |
String | Required | 予約リクエスト ID |
reserveTimeZone |
String | Required | 予約タイムゾーン
|
reserveTime |
String | Required | 予約日時
|
reserveStatus |
String | Required | 予約の状態
|
レスポンスステータスコード
Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"reserveId": "RSSA-*************-****-********-ZzdhBYsk",
"reserveTimeZone": "Asia/Seoul",
"reserveTime": "2025-11-25T13:19:00+09:00",
"reserveStatus": "READY"
}