テンプレート設定の削除

指定したテンプレート設定を削除します。テンプレートがメッセージプラン(審査待ちまたは実行中のステータス)で現在使用されている場合は、削除できません。

リクエストURL

DELETE https://smsapi.engagelab.com/v1/template-configs/:templateId

呼び出し認証

APIリクエストの認証方法については、呼び出し認証を参照してください。

リクエスト例

リクエストヘッダー

DELETE /v1/template-configs/123456789 HTTP/1.1 Content-Type: application/json Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
              
              DELETE /v1/template-configs/123456789  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            
このコードブロックはフローティングウィンドウ内に表示されます

リクエストボディ

なし

リクエストパラメータ

パスパラメータ

パラメータ 区分 説明
templateId String 必須 テンプレートID

レスポンスパラメータ

成功レスポンス

HTTPステータスコードは200で、レスポンスボディには次のフィールドが含まれます。

フィールド 説明
code Integer ステータスコード。0は成功を示す
message String ステータスの説明

成功例

{ "code": 0, "message": "success" }
              
              {
  "code": 0,
  "message": "success"
}

            
このコードブロックはフローティングウィンドウ内に表示されます

エラーレスポンス

HTTPステータスコードは4xx/5xxで、レスポンスボディには次のフィールドが含まれます。

フィールド 説明
code Integer エラーコード
message String エラーの詳細

エラー例

{ "code": 400, "message": "there are pending or running plans using current template, can not update" }
              
              {
  "code": 400,
  "message": "there are pending or running plans using current template, can not update"
}

            
このコードブロックはフローティングウィンドウ内に表示されます

エラーコード

エラーコード HTTPコード 説明
400 400 パラメータエラーまたは業務ロジックエラー
500 500 サーバー内部エラー

よくあるエラーメッセージ:

  • invalid templateId:テンプレートIDの形式エラー
  • template config not exist:テンプレート設定が存在しません
  • there are pending or running plans using current template, can not update:このテンプレートを使用している審査待ちまたは実行中のプランがあるため、削除できません

注意事項

  1. このテンプレートを使用している審査待ちまたは実行中のメッセージプランがある場合は、削除できません。
  2. テンプレートIDと署名IDはいずれも文字列型の数値です。
Icon Solid Transparent White Qiyu
お問い合わせ