更新簽名設定

更新已存在的簽名設定，支援修改簽名名稱。更新後簽名狀態會變回"待審核"。

呼叫位址

PUT https://smsapi.engagelab.com/v1/sign-configs/:signId

呼叫驗證

請參考 呼叫驗證 了解如何進行 API 驗證。

請求範例

請求標頭

              
              PUT /v1/sign-configs/987654321  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

請求主體

              
              {
  "sign_name": "公司名稱"
}

            

請求參數

路徑參數

請求主體參數

回傳參數

成功返回

http 狀態碼為 200，回應主體包含欄位如下：

成功範例

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

            

失敗返回

http 狀態碼為 4xx/5xx，回應主體包含欄位如下：

異常範例

              
              {
  "code": 400,
  "message": "can not update pending status sign"
}

            

錯誤碼

常見錯誤資訊：

• invalid signId：簽名 ID 格式錯誤
• sign config not exist：簽名設定不存在
• sign_name already exist：簽名名稱已存在
• can not update pending status sign：待審核狀態的簽名不能更新
• there are pending or running plans using current sign, can not update：存在使用該簽名的待發送或執行中的計畫，不能更新

注意事項

1. 待審核狀態的簽名不能更新
2. 如果存在待發送或執行中的訊息計畫使用該簽名，則不能更新
3. 更新後簽名狀態會變回"待審核"（status=1）
4. 簽名名稱不能包含禁用字元：【、】、[、]
5. 簽名的 ID 是字串類型的數字

附錄

簽名設定狀態 (status)