取得簽名設定詳情

根據簽名 ID 取得簽名設定的詳細資訊，包含簽名名稱、審核狀態、關聯範本數量等。

呼叫位址

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

呼叫驗證

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

請求範例

請求頭

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

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

此代碼塊在浮窗中顯示

請求體

無

請求參數

路徑參數

參數	類型	選項	說明
signId	String	必填	簽名 ID

返回參數

成功返回

http 狀態碼為 200，響應體為簽名設定物件：

欄位	類型	描述
sign_id	String	簽名 ID
sign_name	String	簽名名稱
status	Integer	狀態：1-待審核，2-審核通過，3-審核拒絕
related_template_count	Integer	關聯的範本數量
audit_remark	String	審核備註
created_time	Integer	建立時間（Unix 時間戳）
updated_time	Integer	更新時間（Unix 時間戳）

成功範例

{ "sign_id": "987654321", "sign_name": "公司名稱", "status": 2, "related_template_count": 5, "audit_remark": "", "created_time": 1699000000, "updated_time": 1699000000 }

              
              {
  "sign_id": "987654321",
  "sign_name": "公司名稱",
  "status": 2,
  "related_template_count": 5,
  "audit_remark": "",
  "created_time": 1699000000,
  "updated_time": 1699000000
}

此代碼塊在浮窗中顯示

失敗返回

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

欄位	類型	描述
code	Integer	錯誤碼
message	String	錯誤詳情

異常範例

{ "code": 400, "message": "invalid signId" }

              
              {
  "code": 400,
  "message": "invalid signId"
}

此代碼塊在浮窗中顯示

錯誤碼

錯誤碼	http code	說明
400	400	參數錯誤或業務邏輯錯誤
500	500	伺服器內部錯誤

常見錯誤資訊：

invalid signId：簽名 ID 格式錯誤
sign config not exist：簽名設定不存在

附錄

簽名設定狀態 (status)

值	說明
1	待審核
2	審核通過
3	審核拒絕