メッセージ予約状態の照会

Prev Next

Classic/VPC環境で利用できます。

メッセージの予約送信状態を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /alimtalk/v2/services/{serviceId}/reservations/{reserveId}/reserve-status

リクエストヘッダ

Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
serviceId String Required Biz Messageサービス ID
reserveId String Required 予約リクエスト ID
  • メッセージ送信時、レスポンスで受け取ったリクエスト ID(requestId)を入力

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://sens.apigw.ntruss.com/alimtalk/v2/services/ncp:kkobizmsg:kr:27*********6:sens/reservations/RBAA-*************-****-********-ERsezZLD/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 予約日時
  • YYYY-MM-DDTHH:mm:ss±hh:mm形式
reserveStatus String Required 予約の状態
  • READY | PROCESSING | CANCELED | FAIL | DONE | STALE| SKIP
    • READY: 待機中
    • PROCESSING: 処理中
    • CANCELED: キャンセル
    • FAIL: 失敗
    • DONE: 完了
    • STALE: 失敗(タイムオーバー)
    • SKIP: 失敗(サービスなし)

レスポンスステータスコード

Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "reserveId": "RBAA-*************-****-********-ERsezZLD",
    "reserveTimeZone": "Asia/Seoul",
    "reserveTime": "2025-11-25T17:37:00+09:00",
    "reserveStatus": "READY"
}