删除签名配置
删除指定的签名配置。若签名正在被消息计划使用（待发送或运行中状态），则不能删除。
调用地址
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 是字符串类型的数字
