文档中心

DeleteSmsTemplate - 删除短信模板

最近更新时间：2024.01.29 14:41:45

首次发布时间：2023.01.17 16:20:23

短信服务使用方可以调用DeleteSmsTemplate接口，删除已完成审核的短信模板或者撤销申请中的短信模板。

请求说明

请求方式：POST
接口地址：https://sms.volcengineapi.com/?Action=DeleteSmsTemplate&Version=2021-01-11

请求参数

Query

名称	类型	是否必填	示例值	描述
Action	String	是	DeleteSmsTemplate	要执行的操作，取值：DeleteSmsTemplate
Version	String	是	2021-01-11	API的版本，取值：2021-01-11

Body

名称	类型	是否必填	示例值	描述
subAccount	String	是	A123****	消息组ID
id	Integer	是	1****9	ID（获取模版列表时返回的Id, 而非模版Id）
isOrder	Boolean	是	true	删除对象是否是审核工单。true适用于模版审核状态为“审核中”

响应数据

名称	类型	示例值	描述
ResponseMetadata	ResponseMetadata		响应公共参数
Result	String		响应业务参数，没有错误时返回""

示例

成功请求示例

请求

{
    "subAccount":"A123****",
    "id":"169***",
    "isOrder":false
}

响应

{
    "ResponseMetadata":{
        "RequestId":"2022090818314901017423503804ED****",
        "Action":"DeleteSmsTemplate",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1"
    },
    "Result":""
}

失败请求示例

请求

{
    "subAccount":"A123****",
    "id":"169***",
    "isOrder":true
}

响应

{
    "ResponseMetadata": {
       "RequestId":"2022090818314901017423503804ED****",
        "Action":"DeleteSmsTemplate",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1",
        "Error": {
            "Code": "1005",
            "Message": "status is not reviewing"
        }
    }
}

错误码

下表提供了该接口业务逻辑相关的错误码。公共错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
200	1001	参数错误	参数错误
200	1999	系统错误	系统错误
200	1005	status is not reviewing	关闭申请工单时，不是未审核状态
200	1006	not existed	删除时，Id找不到

请求说明

请求参数

Query

Body

响应数据

示例

成功请求示例

失败请求示例

错误码