配信予約キャンセル

配信予約キャンセル

配信予約をキャンセルします。 配信予約キャンセルをすると、ステータスは「削除(deleted)」になります。

注意事項

  • キャンセルは配信予定時刻の2分前まで可能です。それ以降のキャンセル要求については、動作は保証されません。
  • 配信ステータスが配信処理中(sending)となったら、キャンセルできません。

メソッドとURL

メソッド URL
DELETE https://{HOST名}/send/{delivery_id}

リクエスト

URLパラメーター

URLに指定します。

項目 説明
delivery_id 配信予約をおこなった際に発行されるID。

 

レスポンス

ステータスコード

コード メッセージ 説明
200 OK 処理成功
400 Bad Request 構文不正。フォーマットやパラメーターの不正
409 Conflict 指定した配信が既にキャンセル不可の状態
500 Internal Server Error 想定外のエラー。 しばらく経ってから再度実施し、状況が改善しなければ、弊社までお問い合わせください。

上記以外のステータスコードが返却される場合もあります。 その場合は、RFC2616規定のHTTPレスポンスステータスコード一覧をご確認ください。

ボディパラメーター

JSON形式で取得されます。

項目 型 説明
items Object Array レスポンス情報が設定されます。
delivery_id String 削除した配信IDが設定されます。
message String 取得エラー時に補足メッセージが指定されます。

サンプル

レスポンス

正常時

{
  "items": [
    {
      "delivery_id": "xxxxxxxxxxxxxxx"
    }
  ]
}

処理を実施した配信IDが返却されます。

エラー時

{
  "message": "Something happens."
}

補足メッセージが出力されます。