批量删除短信模板 - DeleteTemplates

功能介绍

该接口用于用户批量删除模板。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/msgsms/templates/batch-delete

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参见获取帐号、用户、项目的名称和ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）最小长度：1 最大长度：32768
Content-Type	是	String	请求体参数类型，该字段必须设置为：application/json;charset=utf8 缺省值：application/json;charset=utf8 最小长度：1 最大长度：255

表3 请求Body参数
参数	是否必选	参数类型	描述
ids	否	Array of strings	模板主键ID集合最小长度：1 最大长度：64 数组长度：1 - 50

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
success_count	Integer	成功删除的数量最小值：0 最大值：50
success_ids	Array of strings	成功删除的模板主键ID集合最小长度：1 最大长度：64 数组长度：0 - 50
failed_count	Integer	失败删除的数量最小值：0 最大值：50
failed_template_list	Array of SmsTemplateDeleteErrorInfo objects	模板删除失败信息列表数组长度：0 - 50

表5 SmsTemplateDeleteErrorInfo
参数	参数类型	描述
id	String	模板主键ID 最小长度：1 最大长度：64
error_msg	String	模板删除失败信息最小长度：1 最大长度：512

状态码： 400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码最小长度：8 最大长度：36
error_msg	String	错误信息最小长度：1 最大长度：512
error_detail	String	描述最小长度：1 最大长度：512

请求示例

批量删除主键ID为“******27-37eb-4229-bee9-0eba4d8a897f”和“******fe-8c9d-4cd2-9402-cd2fef488782”的模板。

POST https://{Endpoint}/v2/{project_id}/msgsms/templates/batch-delete

{
  "ids" : [ "******27-37eb-4229-bee9-0eba4d8a897f", "******fe-8c9d-4cd2-9402-cd2fef488782" ]
}

响应示例

状态码： 200

{
  "success_count" : 1,
  "success_ids" : [ "******27-37eb-4229-bee9-0eba4d8a897f" ],
  "failed_count" : 1,
  "failed_template_list" : [ {
    "id" : "******fe-8c9d-4cd2-9402-cd2fef488782",
    "error_msg" : "Message Template Info does not EXIST"
  } ]
}