# 创建消息模板 - CreateMessageTemplate #### 功能介绍 创建一个模板，用户可以按照模板去发送消息，这样可以减少请求的数据量。 单用户默认可创建100个消息模板，高并发场景下，可能会出现消息模板数量超过100仍创建成功的情况，此为正常现象。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-smn/smn_api_30000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-smn/smn_api_80000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | smn:template:create | Write | template \* | - | - | - | #### URI POST /v2/{project_id}/notifications/message_template 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。获取项目ID请参考 [获取项目ID](https://support.huaweicloud.com/api-smn/smn_api_66000.html)。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | message_template_name | 是 | String | 创建模板的名称。只能包含大写字母、小写字母、数字、-和_，且必须由大写字母、小写字母或数字开头，长度在1到64个字符之间。 | | protocol | 否 | String | 模板支持的协议类型。 目前支持的协议包括： "default"：默认协议。 "email"：邮件传输协议。 "sms"：短信传输协议。 "functionstage"：FunctionGraph（函数）传输协议。 "http"、"https"：HTTP/HTTPS传输协议。 | | content | 是 | String | 模板内容，模板目前仅支持纯文本模式。模板内容不能空，最大支持256KB。 | #### 响应参数 **状态码：201** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求的唯一标识ID。 | | message_template_id | String | 模板唯一的资源标识。 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求的唯一标识ID。 | | code | String | 服务异常错误信息编码。 | | message | String | 服务异常错误信息描述。 | **状态码：403** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求的唯一标识ID。 | | code | String | 服务异常错误信息编码。 | | message | String | 服务异常错误信息描述。 | **状态码：404** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求的唯一标识ID。 | | code | String | 服务异常错误信息编码。 | | message | String | 服务异常错误信息描述。 | **状态码：500** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求的唯一标识ID。 | | code | String | 服务异常错误信息编码。 | | message | String | 服务异常错误信息描述。 | #### 请求示例 创建模板名称为confirm_message，且模板支持的协议类型为https的消息模板 ``` POST https://{SMN_Endpoint}/v2/{project_id}/notifications/message_template { "message_template_name" : "confirm_message", "protocol" : "https", "content" : "(1/2)You are invited to subscribe to topic({topic_id}). Click the following URL to confirm subscription:(If you do not want to subscribe to this topic, ignore this message.)" } ``` #### 响应示例 **状态码：201** ``` { "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085", "message_template_id" : "57ba8dcecda844878c5dd5815b65d10f" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 创建模板名称为confirm_message，且模板支持的协议类型为https的消息模板 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.smn.v2.region.SmnRegion; import com.huaweicloud.sdk.smn.v2.*; import com.huaweicloud.sdk.smn.v2.model.*; public class CreateMessageTemplateSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); SmnClient client = SmnClient.newBuilder() .withCredential(auth) .withRegion(SmnRegion.valueOf("")) .build(); CreateMessageTemplateRequest request = new CreateMessageTemplateRequest(); CreateMessageTemplateRequestBody body = new CreateMessageTemplateRequestBody(); body.withContent("(1/2)You are invited to subscribe to topic({topic_id}). Click the following URL to confirm subscription:(If you do not want to subscribe to this topic, ignore this message.)"); body.withProtocol("https"); body.withMessageTemplateName("confirm_message"); request.withBody(body); try { CreateMessageTemplateResponse response = client.createMessageTemplate(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 创建模板名称为confirm_message，且模板支持的协议类型为https的消息模板 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksmn.v2.region.smn_region import SmnRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksmn.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = SmnClient.new_builder() \ .with_credentials(credentials) \ .with_region(SmnRegion.value_of("")) \ .build() try: request = CreateMessageTemplateRequest() request.body = CreateMessageTemplateRequestBody( content="(1/2)You are invited to subscribe to topic({topic_id}). Click the following URL to confirm subscription:(If you do not want to subscribe to this topic, ignore this message.)", protocol="https", message_template_name="confirm_message" ) response = client.create_message_template(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 创建模板名称为confirm_message，且模板支持的协议类型为https的消息模板 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" smn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := smn.SmnClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := smn.NewSmnClient(hcClient) request := &model.CreateMessageTemplateRequest{} protocolCreateMessageTemplateRequestBody:= "https" request.Body = &model.CreateMessageTemplateRequestBody{ Content: "(1/2)You are invited to subscribe to topic({topic_id}). Click the following URL to confirm subscription:(If you do not want to subscribe to this topic, ignore this message.)", Protocol: &protocolCreateMessageTemplateRequestBody, MessageTemplateName: "confirm_message", } response, err := client.CreateMessageTemplate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SMN/sdk?api=CreateMessageTemplate&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 201 | OK | | 400 | Bad Request | | 403 | Unauthorized | | 404 | Not Found | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-smn/ErrorCode.html)。