建立簽名設定
建立新的簽名設定(Sender ID),用於在簡訊中顯示發送者標識。建立後簽名狀態為「待審核」,需通過審核後方可使用。
呼叫位址
POST https://smsapi.engagelab.com/v1/sign-configs
呼叫驗證
請參考 呼叫驗證 了解如何進行 API 鑑權。
請求範例
請求頭
POST /v1/sign-configs HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
POST /v1/sign-configs HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
此代碼塊在浮窗中顯示
請求體
{
"sign_name": "公司名稱"
}
{
"sign_name": "公司名稱"
}
此代碼塊在浮窗中顯示
請求參數
| 參數 | 類型 | 選項 | 說明 |
|---|---|---|---|
| sign_name | String | 必填 | 簽名名稱,長度 2-60 個字元,不能包含:【、】、[、] |
返回參數
成功返回
http 狀態碼為 200,響應體包含欄位如下:
| 欄位 | 類型 | 描述 |
|---|---|---|
| sign_id | String | 建立的簽名 ID |
成功範例
{
"sign_id": "987654321"
}
{
"sign_id": "987654321"
}
此代碼塊在浮窗中顯示
失敗返回
http 狀態碼為 4xx/5xx,響應體包含欄位如下:
| 欄位 | 類型 | 描述 |
|---|---|---|
| code | Integer | 錯誤碼 |
| message | String | 錯誤詳情 |
異常範例
{
"code": 400,
"message": "sign_name already exist"
}
{
"code": 400,
"message": "sign_name already exist"
}
此代碼塊在浮窗中顯示
錯誤碼
| 錯誤碼 | http code | 說明 |
|---|---|---|
| 400 | 400 | 參數錯誤或業務邏輯錯誤 |
| 500 | 500 | 伺服器內部錯誤 |
常見錯誤資訊:
sign_name already exist:簽名名稱已存在
注意事項
- 簽名建立後狀態為「待審核」(status=1),需通過審核後方可使用
- 同一業務下簽名名稱不能重複
- 簽名名稱不能包含禁用字元:
【、】、[、] - 簽名的 ID 是字串類型的數字
附錄
簽名設定狀態 (status)
| 值 | 說明 |
|---|---|
| 1 | 待審核 |
| 2 | 審核通過 |
| 3 | 審核拒絕 |










