云服务器内容精选

  • 请求示例 修改短信模板,请求方式:PUT ,请求URL:/v2/{project_id}/msgsms/templates/{id},路径参数:id,project_id,请求头参数:X-Auth-Token,Content-Type,请求体:app_id,region,template_content,template_name,template_type。 PUT /v2/845ada5bc7444f1295cd517af0123da1/msgsms/templates/c3f641aa-4e87-4a70-b84d-a2d685599072 HTTP/1.1 Host: 100.85.***.***:30300 Content-Type: application/json X-Auth-Token: *** Content-Length: 311 { "app_id": "******9c-1a6b-4ee5-9651-5bca450694b3", "brackets": "GB", "region": "cn", "sign_id": "******58-e866-4b30-9ca5-a476a00e8775", "template_content": "测试", "template_name": "auto_test000", "template_type": "NOTIFY_TYPE", "universal_template": 0 }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型,该字段必须设置为:application/json X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表3 请求Body参数 参数 是否必选 参数类型 描述 app_id 是 String 应用主键ID,参考表5 响应SmsAppQueryResp参数中的ID brackets 否 String 中括号类型。支持枚举值: CN:中文类型:【】 GB:英文类型: [] 须知: 默认值为:CN 输入值不在上述枚举值范围内的,也按CN处理。 只有地域为国内时,该字段有效。 region 是 String 地域 cn:国内 intl:国际 send_country 否 Array of Integers 发送国家ID列表,只有地域为国际时,该字段有效 sign_id 否 String 签名ID,对应表5 响应SmsSignatureResp参数中的ID。只有地域为国内时,该字段有效 template_content 是 String 模板内容 template_desc 否 String 模板描述 template_name 是 String 模板名称 template_type 是 String 模板类型。只有地域为国内时,该字段有效。支持枚举值: VERIFY_CODE_TYPE:验证码类 PROMOTION_TYPE:推广类 NOTIFY_TYPE:通知类 universal_template 否 Integer 是否为通用模板 0:非通用模板 1:通用模板 variable_attributes 否 Array of SmsTemplateVariableAttrReq objects 模板参数 flow_status 否 String 流程状态 Pending:待提交 Reviewing:待审核 表4 SmsTemplateVariableAttrReq 参数 是否必选 参数类型 描述 variable_desc 否 String 变量说明,当变量类型为TEXT时,必填 variable_index 是 Integer 变量索引,对应模板内容变量索引 variable_type 是 String 变量类型,目前支持:PHONE|CHARDIGIT|DATETIME|MONEY|TEXT|NEWTEXT
  • 响应示例 状态码: 200 查询短信模板响应体。 { "result" : [ { "status" : "Normal", "template_name" : "营销类07模板", "template_type" : "PROMOTION_TYPE", "template_content" : "华为云内部测试使用。${1} 回T取关", "template_id" : "1512***6", "signature_id" : "65ba0c56-aa84-4e68-86a7-****62c50707", "app_id" : "707b236a-b58b-41fc-b552-****eaaa19af", "app_name" : "APP1", "create_time" : "2023-08-04 07:53:40", "has_variable" : "Yes", "flow_status" : "Adopted", "universal_template" : null, "template_desc" : "", "urge_status" : "NO", "urge_time" : null, "urge_desc" : null, "review_desc" : "请审批" }, { "status" : "Normal", "template_name" : "营销类06模板", "template_type" : "PROMOTION_TYPE", "template_content" : "测试一体化营销套餐006号${1} 回T取关", "template_id" : "1512***5", "signature_id" : "af98bc62-cc8b-407e-a37a-****726c19d6", "app_id" : "707b236a-b58b-41fc-b552-****eaaa19af", "app_name" : "APP1", "create_time" : "2023-08-04 07:45:08", "has_variable" : "Yes", "flow_status" : "Adopted", "universal_template" : null, "template_desc" : "", "urge_status" : "NO", "urge_time" : null, "urge_desc" : null, "review_desc" : "请审批" } ], "page_info" : { "offset" : 1, "limit" : 2, "total" : 148 } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 result Array of SmsTemplateInfo objects 查询结果。 page_info Page object 分页信息。 表4 SmsTemplateInfo 参数 参数类型 描述 template_id String 模板ID。 最小长度:1 最大长度:50 template_name String 模板名称。 最小长度:1 最大长度:30 create_time String 创建时间。 最小长度:1 最大长度:20 template_type String 模板类型。 最小长度:1 最大长度:20 app_id String 应用ID。 最小长度:1 最大长度:50 app_name String 应用名称。 最小长度:1 最大长度:30 signature_id String 签名ID。 最小长度:1 最大长度:50 template_content String 模板内容。 最小长度:1 最大长度:500 template_desc String 申请描述。 最小长度:1 最大长度:100 has_variable String 是否有变量。 最小长度:1 最大长度:10 flow_status String 流程状态。 最小长度:1 最大长度:20 status String 模板状态。 最小长度:1 最大长度:20 universal_template Integer 是否是通用模板。 最小值:0 最大值:1 urge_status String 催审状态。 最小长度:0 最大长度:20 urge_time String 催审时间。 最小长度:1 最大长度:20 urge_desc String 催审描述。 最小长度:0 最大长度:64 review_desc String 审批描述。 最小长度:0 最大长度:500 表5 Page 参数 参数类型 描述 offset Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 limit Integer 每页显示的条目数量。 total Integer 总条数。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度:0 最大长度:32 error_msg String 结果详情。 最小长度:0 最大长度:32 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度:0 最大长度:32 error_msg String 结果详情。 最小长度:0 最大长度:32
  • URI GET /v1/sms/templates 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量。表示从偏移量开始查询,offset大于等于0。 缺省值:1 limit 否 Integer 每页显示的条目数量。 缺省值:10 app_name 否 String 应用名称。 start_time 否 String 开始时间。 end_time 否 String 结束时间。 flow_status 否 String 流程状态。 枚举值: Adopted:通过 Reviewing:审核中 Reject:拒绝 template_id 否 String 模板ID。 template_name 否 String 模板名称。 template_type 否 String 模板类型。 枚举值: PROMOTION_TYPE:营销类 NOTIFY_TYPE:通知类
  • 请求示例 批量删除主键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 OK { "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" } ] }
  • 响应参数 状态码: 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
  • 请求参数 表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
  • 请求示例 查询模板变量,请求方式:GET ,请求URL:/v2/{project_id}/msgsms/templates/{id}/varilable,路径参数:id,project_id,请求头参数:X-Auth-Token,Content-Type。 GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/templates/f063a294-06ab-420e-90bc-0c4dd9aed540/varilable Host: 100.85.***.***:30300 Content-Type: application/json X-Auth-Token:******
  • 响应示例 { "results": [ { "id": 15003394, "temp_name": "测试", "variable_index": 1, "variable_type": "URL", "variable_length": 99, "variable_desc": "" } ], "total": 1 }
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 results Array of ApiTemplateVariable 查询结果 total Long 总数 表4 ApiTemplateVariable 参数 是否必选 参数类型 描述 id 否 Integer 变量id User_name 否 String 用户名 temp_name 否 String 模板名称 variable_index 否 Integer 变量索引 variable_type 否 String 变量类型 variable_length 否 Integer 变量长度 variable_desc 否 String 变量描述