云服务器内容精选
-
请求示例 POST /v2/845ada5bc7444f1295cd517af0123da1/msgsms/templates Host: 100.85.***.***:30300Content-Type: application/jsonX-Auth-Token: ****Content-Length: 308 { "app_id": "******9c-1a6b-4ee5-9651-5bca450694b3", "brackets": "GB", "region": "cn", "sign_id": "******10-c3fb-427e-965c-a98ae844c5bd", "template_content": "测试", "template_name": "auto_test789", "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: 英文类型 region 是 String 地域 cn：国内 intl：国际 send_country 否 Array of integers 发送国家id列表，可以通过表4获取。只有地域为国际时，该字段有效 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 模板参数 表4 SmsTemplateVariableAttrReq 参数 是否必选 参数类型 描述 variable_desc 否 String 变量说明，当变量类型为TEXT时，必填 variable_index 是 Integer 变量索引，对应模板内容变量索引 variable_type 是 String 变量类型，目前支持：PHONE|CHARDIGIT|DATETIME|MONEY|TEXT
-
响应示例 { "create_time": "2022-08-12 07:40:36", "customer_id": "******c55c3c4526b2ed7a0213bc9871", "tenant": { "customer_id": "******c55c3c4526b2ed7a0213bc9871", "customer_name": "****05", "enterprise_name": "华为技术有限公司" }, "id": "******27-37eb-4229-bee9-0eba4d8a897f", "template_type": "NOTIFY_TYPE", "template_name": "auto_test789", "app_name": "auto_test7890", "app_key": "******3baZf4c856O4Qrbqvui3K2", "sign_id": "******b9-4141-4e2d-9838-14889c32a4bf", "template_content": "测试", "has_variable": "No", "flow_status": "Reviewing", "status": "Normal", "universal_template": 0, "region": "cn", "brackets": "GB", "site": "cn", "urge_status": "NO", "is_support_multiomp": false}
-
响应参数 状态码： 200 表3 响应Body参数 参数 描述 id 模板主键ID template_name 模板名称 template_type 模板类型 template_content 模板内容 template_id OMP同步的模板ID app_key 应用key sign_id 签名主键id create_time 创建时间 customer_id 租户customer id has_variable 是否有变量 flow_status 流程状态 status 模板状态 universal_template 是否是通用模板 urge_status 催审状态 review_desc 审批描述 country_name 国家
-
响应示例 { "results": [ { "create_time": "2022-08-12 07:40:36", "customer_id": "******c55c3c4526b2ed7a0213bc9871", "tenant": { "customer_id": "******c55c3c4526b2ed7a0213bc9871", "customer_name": "****05", "enterprise_name": "华为技术有限公司" }, "id": "******27-37eb-4229-bee9-0eba4d8a897f", "template_type": "NOTIFY_TYPE", "template_name": "auto_test789", "app_name": "auto_test7890", "app_key": "******3baZf4c856O4Qrbqvui3K2", "sign_id": "******b9-4141-4e2d-9838-14889c32a4bf", "template_content": "测试", "has_variable": "No", "flow_status": "Reviewing", "status": "Normal", "universal_template": 0, "region": "cn", "brackets": "GB", "site": "cn", "urge_status": "NO", "is_support_multiomp": false, "country_name": "" } ], "total": 1}
-
响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 results Array of SmsTemplateResp 查询结果 total Long 总数 表5 SmsTemplateResp参数 参数 描述 id 模板主键ID，用于获取、修改、删除模板以及查询模板变量的唯一标识 template_name 模板名称 template_type 模板类型 template_content 模板内容 template_id OMP同步的模板ID app_key 应用key sign_id 签名主键id create_time 创建时间 customer_id 租户customer id has_variable 是否有变量 flow_status 流程状态 status 模板状态 universal_template 是否是通用模板 urge_status 催审状态 review_desc 审批描述 country_name 国家
-
URI GET /v2/{project_id}/msgsms/templates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，参考“获取项目ID” 表2 Query参数 参数 是否必选 参数类型 描述 app_key 否 String 应用key app_name 否 String 应用名称 end_time 否 String 结束时间 flow_status 否 String 流程状态 Adopted: 通过 Reviewing: 审核中 Reject: 拒绝 has_variable 否 String 是否存在变量 limit 否 Integer 数量 offset 否 Integer 偏移量 region 否 String 地域 sign_name 否 String 签名名称 sort_dir 否 String 排序方式 desc：降序 asc：升序 sort_key 否 String 排序字段 start_time 否 String 开始时间 template_id 否 String 模板ID template_name 否 String 模板名称 template_type 否 String 模板类型 VERIFY_CODE_TYPE: 验证码类 PROMOTION_TYPE: 推广类 NOTIFY_TYPE: 通知类
-
请求示例 PUT /v2/845ada5bc7444f1295cd517af0123da1/msgsms/templates/c3f641aa-4e87-4a70-b84d-a2d685599072 HTTP/1.1Host: 100.85.***.***:30300Content-Type: application/jsonX-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: 英文类型 region 是 String 地域 cn：国内 intl：国际 send_country 否 Array of integers 发送国家id列表，可以通过表4 响应SmsCountryResp参数获取。只有地域为国际时，该字段有效 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 模板参数 表4 SmsTemplateVariableAttrReq 参数 是否必选 参数类型 描述 variable_desc 否 String 变量说明，当变量类型为TEXT时，必填 variable_index 是 Integer 变量索引，对应模板内容变量索引 variable_type 是 String 变量类型，目前支持：PHONE|CHARDIGIT|DATETIME|MONEY|TEXT|NEWTEXT
-
响应示例 { "results": [ { "id": 15003394, "user_name": null, "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 变量id temp_name 模板名称 variable_index 变量索引 variable_type 变量类型 variable_length 变量长度 variable_desc 变量描述
共11条
