刪除簽名設定
刪除指定的簽名設定。若簽名正在被訊息計畫使用（待發送或運行中狀態），則不能刪除。
呼叫位址
DELETE https://smsapi.engagelab.com/v1/sign-configs/:signId
呼叫驗證
請參考 呼叫驗證 了解如何進行 API 鑑權。
請求範例
請求頭
DELETE /v1/sign-configs/987654321 HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
DELETE /v1/sign-configs/987654321 HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
此代碼塊在浮窗中顯示
請求體
無
請求參數
路徑參數
| 參數 | 類型 | 選項 | 說明 |
|---|---|---|---|
| signId | 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 sign, can not update"
}
{
"code": 400,
"message": "there are pending or running plans using current sign, can not update"
}
此代碼塊在浮窗中顯示
錯誤碼
| 錯誤碼 | http code | 說明 |
|---|---|---|
| 400 | 400 | 參數錯誤或業務邏輯錯誤 |
| 500 | 500 | 伺服器內部錯誤 |
常見錯誤資訊：
invalid signId：簽名 ID 格式錯誤sign config not exist：簽名設定不存在there are pending or running plans using current sign, can not update：存在使用該簽名的待發送或運行中的計畫，不能刪除
注意事項
- 如果存在待發送或運行中的訊息計畫使用該簽名，則不能刪除
- 簽名的 ID 是字串類型的數字
