文档首页/ 消息通知服务 SMN/ API参考/ API/ 发布消息操作/ 消息发布
更新时间：2025-02-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

消息发布

功能介绍

将消息发送给Topic的所有订阅端点。当返回消息ID时，该消息已被保存并开始尝试将其推送给Topic的订阅者。为确保您的消息能够成功推送到各个订阅者，请确保您的消息内容符合当地法律法规要求。

三种消息发送方式

message

message_structure

message_template_name

只需要设置其中一个，如果同时设置，生效的优先级为

message_structure > message_template_name > message。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/notifications/topics/{topic_urn}/publish

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取项目ID请参考 获取项目ID。

topic_urn

是

String

Topic的唯一的资源标识，可通过查询主题列表获取该标识。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

subject

否

String

消息标题，给邮箱订阅者发送邮件时作为邮件主题，长度不能超过512个字节。

message

否

String

发送的消息。消息体必须是UTF-8编码的字符串，大小至多256KB。如果订阅者是手机号码，短信长度限制为490字，超出则可能被运营商拦截。短信内容不能包含“[]”或者“【】”符号。说明：三种消息发送方式：message、message_structure、message_template_name至少设置其中一个，如果同时设置，生效的优先级为message_structure > message_template_name > message。

message_structure

否

String

Json格式的字符串。支持“email”、“sms”、“http”、“https”、“functiongraph”、“functionstage”、“dingding”、“wechat”、“feishu”、“welink”。必须设置默认的消息“default”，当匹配不到消息协议时，按“default”中的内容发送。其中，钉钉、微信、飞书、welink协议类型的消息需指定msgType字段；钉钉，微信和飞书机器人协议支持msgType为text（纯文本）和markdown（MD）格式消息，welink和红版welink机器人类型暂仅支持msgType为text的纯文本消息。 钉钉机器人协议支持通过at字段实现@群组成员。当您需要@群成员时，可以在isAtAll字段中传入布尔值，表示是否需要@群组内所有人。您可以在atMobiles字段中传入需要@的人的手机号列表，或在atUserIds字段中传入需要@的钉钉userID列表。当您使用atMobiles字段或atUserIds字段时，需要在消息内容中同时传入@对应手机号或userID的信息。展示效果请参考钉钉官方文档。说明：三种消息发送方式：message、message_structure、message_template_name至少设置其中一个，如果同时设置，生效的优先级为message_structure > message_template_name > message。

message_template_name

否

String

消息模板名称，可通过查询消息模板列表获取名称。说明：三种消息发送方式：message、message_structure、message_template_name至少设置其中一个，如果同时设置，生效的优先级为message_structure > message_template_name > message。

tags

否

Map<String,String>

tag以及替换tag的参数组成的字典。消息模板中的标签对应的值。使用消息模板方式的消息发布必须携带该参数。字典中的key为消息模板中的参数名称，不超过21个字符。字典中的value为消息模板中的参数被替换后的值，不超过1KB。

time_to_live

否

String

指消息在SMN系统内部的最长存留时间。超过该存留时间，系统将不再发送该消息。单位是s，变量默认值是3600s，即一小时。值为正整数且小于等于3600*24。

message_attributes

否

Array of MessageAttribute objects

消息属性列表

locale

否

String

语言，发送出去的消息中SMN附加系统内容的语言，若没传入，使用账号的语言。取值范围是该局点支持的语言，比如：zh-cn,en-us等
表4 MessageAttribute

参数

是否必选

参数类型

描述

name

是

String

属性名称。属性名称只能包含小写英文字母([a-z])、数字([0-9])、下划线(_)，下划线不能出现在开始或结尾，下划线不能连续出现，长度为1到32个字符

type

是

String

属性类型

STRING：字符串（String）类型

STRING_ARRAY：字符串数组（String.Array）类型

PROTOCOL：协议类型

value

是

Object

属性值。

当属性类型为“STRING”时，属性值只能包含中英文、数字、下划线，长度为1到32个字符。

当属性类型为“STRING_ARRAY”时，属性值为字符串数组，数组长度为1到10，数组中的元素内容不能重复，数组中的每个字符串都只能包含中英文、数字、下划线，且长度为1到32个字符。

当属性类型为“PROTOCOL”时，属性值为支持协议类型的字符串数组。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

message_id

String

唯一的消息ID。

状态码：400

表6 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码：403

表7 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码：404

表8 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码：429

表9 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码：500

表10 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

请求示例

  • 消息发布

    POST https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_create_topic_v2/publish

{
  "subject" : "test message v2",
  "message" : "Message test message v2",
  "time_to_live" : "3600",
  "message_attributes" : [ {
    "name" : "smn_protocol",
    "type" : "PROTOCOL",
    "value" : [ "email", "sms" ]
  } ]
}

  • 使用消息结构体方式的消息发布

    POST https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_create_topic_v2/publish

{
  "subject" : "test message v2",
  "message_structure" : "{   \"default\": \"Message structure test message v2\",   \"sms\": \"Message structure test message v2\",   \"email\": \"Message structure test message v2\",   \"wechat\": \"{\\\"msgtype\\\":\\\"text\\\",\\\"text\\\":{\\\"content\\\":\\\"Message structure test message v2\\\"}}\",   \"dingding\": \"{\\\"msgtype\\\":\\\"markdown\\\",\\\"at\\\":{\\\"atMobiles\\\": [\\\"15XXXXXX\\\"],\\\"atUserIds\\\": [\\\"1234567XXX\\\"],\\\"isAtAll\\\": true},\\\"markdown\\\":{\\\"content\\\":\\\"Message structure test message v2 @15XXXXXX @1234567XXX\\\",\\\"title\\\":\\\"Message structure title\\\"}}\",   \"feishu\": \"{\\\"msgtype\\\":\\\"text\\\",\\\"text\\\":{\\\"content\\\":\\\"Message structure test message v2\\\"}}\",   \"welinkRed\": \"{\\\"msgtype\\\":\\\"text\\\",\\\"text\\\":{\\\"content\\\":\\\"Message structure test message v2\\\"}}\",   \"http\": \"Message structure test message v2\",   \"https\": \"Message structure test message v2\",   \"dingTalkBot\": \"{\\\"msgtype\\\":\\\"markdown\\\",\\\"markdown\\\":{\\\"content\\\":\\\"Message structure test message v2 dingTalkBot markdown\\\",\\\"title\\\":\\\"Message structure title\\\"}}\",   \"functionstage\": \"Message structure test message v2\" }",
  "time_to_live" : "3600",
  "message_attributes" : [ {
    "name" : "smn_protocol",
    "type" : "PROTOCOL",
    "value" : [ "email", "sms" ]
  } ]
}

  • 使用消息模板方式的消息发布

    POST https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_create_topic_v2/publish

{
  "subject" : "test message template v2",
  "message_template_name" : "confirm_message",
  "time_to_live" : "3600",
  "tags" : {
    "topic_urn" : "topic_urn3331",
    "topic_id" : "topic_id3332"
  },
  "message_attributes" : [ {
    "name" : "smn_protocol",
    "type" : "PROTOCOL",
    "value" : [ "email", "sms" ]
  } ]
}

响应示例

状态码：200

OK

{
  "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085",
  "message_id" : "bf94b63a5dfb475994d3ac34664e24f2"
}

SDK代码示例

SDK代码示例如下。

  • 消息发布

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
    		 
    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.*;

import java.util.List;
import java.util.ArrayList;

public class PublishMessageSolution {

    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("<YOUR REGION>"))
                .build();
        PublishMessageRequest request = new PublishMessageRequest();
        request.withTopicUrn("{topic_urn}");
        PublishMessageRequestBody body = new PublishMessageRequestBody();
        List<MessageAttribute> listbodyMessageAttributes = new ArrayList<>();
        listbodyMessageAttributes.add(
            new MessageAttribute()
                .withName("smn_protocol")
                .withType(MessageAttribute.TypeEnum.fromValue("PROTOCOL"))
                .withValue("[email, sms]")
        );
        body.withMessageAttributes(listbodyMessageAttributes);
        body.withTimeToLive("3600");
        body.withMessage("Message test message v2");
        body.withSubject("test message v2");
        request.withBody(body);
        try {
            PublishMessageResponse response = client.publishMessage(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());
        }
    }
}

  • 使用消息结构体方式的消息发布

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
    		 
    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.*;

import java.util.List;
import java.util.ArrayList;

public class PublishMessageSolution {

    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("<YOUR REGION>"))
                .build();
        PublishMessageRequest request = new PublishMessageRequest();
        request.withTopicUrn("{topic_urn}");
        PublishMessageRequestBody body = new PublishMessageRequestBody();
        List<MessageAttribute> listbodyMessageAttributes = new ArrayList<>();
        listbodyMessageAttributes.add(
            new MessageAttribute()
                .withName("smn_protocol")
                .withType(MessageAttribute.TypeEnum.fromValue("PROTOCOL"))
                .withValue("[email, sms]")
        );
        body.withMessageAttributes(listbodyMessageAttributes);
        body.withTimeToLive("3600");
        body.withMessageStructure("{   "default": "Message structure test message v2",   "sms": "Message structure test message v2",   "email": "Message structure test message v2",   "wechat": "{\"msgtype\":\"text\",\"text\":{\"content\":\"Message structure test message v2\"}}",   "dingding": "{\"msgtype\":\"markdown\",\"at\":{\"atMobiles\": [\"15XXXXXX\"],\"atUserIds\": [\"1234567XXX\"],\"isAtAll\": true},\"markdown\":{\"content\":\"Message structure test message v2 @15XXXXXX @1234567XXX\",\"title\":\"Message structure title\"}}",   "feishu": "{\"msgtype\":\"text\",\"text\":{\"content\":\"Message structure test message v2\"}}",   "welinkRed": "{\"msgtype\":\"text\",\"text\":{\"content\":\"Message structure test message v2\"}}",   "http": "Message structure test message v2",   "https": "Message structure test message v2",   "dingTalkBot": "{\"msgtype\":\"markdown\",\"markdown\":{\"content\":\"Message structure test message v2 dingTalkBot markdown\",\"title\":\"Message structure title\"}}",   "functionstage": "Message structure test message v2" }");
        body.withSubject("test message v2");
        request.withBody(body);
        try {
            PublishMessageResponse response = client.publishMessage(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());
        }
    }
}

  • 使用消息模板方式的消息发布

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
    		 
    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.*;

import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.util.HashMap;

public class PublishMessageSolution {

    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("<YOUR REGION>"))
                .build();
        PublishMessageRequest request = new PublishMessageRequest();
        request.withTopicUrn("{topic_urn}");
        PublishMessageRequestBody body = new PublishMessageRequestBody();
        List<MessageAttribute> listbodyMessageAttributes = new ArrayList<>();
        listbodyMessageAttributes.add(
            new MessageAttribute()
                .withName("smn_protocol")
                .withType(MessageAttribute.TypeEnum.fromValue("PROTOCOL"))
                .withValue("[email, sms]")
        );
        Map<String, String> listbodyTags = new HashMap<>();
        listbodyTags.put("topic_urn", "topic_urn3331");
        listbodyTags.put("topic_id", "topic_id3332");
        body.withMessageAttributes(listbodyMessageAttributes);
        body.withTimeToLive("3600");
        body.withTags(listbodyTags);
        body.withMessageTemplateName("confirm_message");
        body.withSubject("test message template v2");
        request.withBody(body);
        try {
            PublishMessageResponse response = client.publishMessage(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());
        }
    }
}

  • 消息发布

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
    		 
    # 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("<YOUR REGION>")) \
        .build()

    try:
        request = PublishMessageRequest()
        request.topic_urn = "{topic_urn}"
        listMessageAttributesbody = [
            MessageAttribute(
                name="smn_protocol",
                type="PROTOCOL",
                value="[email, sms]"
            )
        ]
        request.body = PublishMessageRequestBody(
            message_attributes=listMessageAttributesbody,
            time_to_live="3600",
            message="Message test message v2",
            subject="test message v2"
        )
        response = client.publish_message(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • 使用消息结构体方式的消息发布

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
    		 
    # 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("<YOUR REGION>")) \
        .build()

    try:
        request = PublishMessageRequest()
        request.topic_urn = "{topic_urn}"
        listMessageAttributesbody = [
            MessageAttribute(
                name="smn_protocol",
                type="PROTOCOL",
                value="[email, sms]"
            )
        ]
        request.body = PublishMessageRequestBody(
            message_attributes=listMessageAttributesbody,
            time_to_live="3600",
            message_structure="{   "default": "Message structure test message v2",   "sms": "Message structure test message v2",   "email": "Message structure test message v2",   "wechat": "{\"msgtype\":\"text\",\"text\":{\"content\":\"Message structure test message v2\"}}",   "dingding": "{\"msgtype\":\"markdown\",\"at\":{\"atMobiles\": [\"15XXXXXX\"],\"atUserIds\": [\"1234567XXX\"],\"isAtAll\": true},\"markdown\":{\"content\":\"Message structure test message v2 @15XXXXXX @1234567XXX\",\"title\":\"Message structure title\"}}",   "feishu": "{\"msgtype\":\"text\",\"text\":{\"content\":\"Message structure test message v2\"}}",   "welinkRed": "{\"msgtype\":\"text\",\"text\":{\"content\":\"Message structure test message v2\"}}",   "http": "Message structure test message v2",   "https": "Message structure test message v2",   "dingTalkBot": "{\"msgtype\":\"markdown\",\"markdown\":{\"content\":\"Message structure test message v2 dingTalkBot markdown\",\"title\":\"Message structure title\"}}",   "functionstage": "Message structure test message v2" }",
            subject="test message v2"
        )
        response = client.publish_message(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • 使用消息模板方式的消息发布

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
    		 
    # 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("<YOUR REGION>")) \
        .build()

    try:
        request = PublishMessageRequest()
        request.topic_urn = "{topic_urn}"
        listMessageAttributesbody = [
            MessageAttribute(
                name="smn_protocol",
                type="PROTOCOL",
                value="[email, sms]"
            )
        ]
        listTagsbody = {
            "topic_urn": "topic_urn3331",
            "topic_id": "topic_id3332"
        }
        request.body = PublishMessageRequestBody(
            message_attributes=listMessageAttributesbody,
            time_to_live="3600",
            tags=listTagsbody,
            message_template_name="confirm_message",
            subject="test message template v2"
        )
        response = client.publish_message(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • 消息发布

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
    		 
    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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := smn.NewSmnClient(
        smn.SmnClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.PublishMessageRequest{}
	request.TopicUrn = "{topic_urn}"
	valueMessageAttributes:= "[email, sms]"
	var valueMessageAttributesInterface interface{} = valueMessageAttributes
	var listMessageAttributesbody = []model.MessageAttribute{
        {
            Name: "smn_protocol",
            Type: model.GetMessageAttributeTypeEnum().PROTOCOL,
            Value: &valueMessageAttributesInterface,
        },
    }
	timeToLivePublishMessageRequestBody:= "3600"
	messagePublishMessageRequestBody:= "Message test message v2"
	subjectPublishMessageRequestBody:= "test message v2"
	request.Body = &model.PublishMessageRequestBody{
		MessageAttributes: &listMessageAttributesbody,
		TimeToLive: &timeToLivePublishMessageRequestBody,
		Message: &messagePublishMessageRequestBody,
		Subject: &subjectPublishMessageRequestBody,
	}
	response, err := client.PublishMessage(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • 使用消息结构体方式的消息发布

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
    		 
    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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := smn.NewSmnClient(
        smn.SmnClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.PublishMessageRequest{}
	request.TopicUrn = "{topic_urn}"
	valueMessageAttributes:= "[email, sms]"
	var valueMessageAttributesInterface interface{} = valueMessageAttributes
	var listMessageAttributesbody = []model.MessageAttribute{
        {
            Name: "smn_protocol",
            Type: model.GetMessageAttributeTypeEnum().PROTOCOL,
            Value: &valueMessageAttributesInterface,
        },
    }
	timeToLivePublishMessageRequestBody:= "3600"
	messageStructurePublishMessageRequestBody:= "{   "default": "Message structure test message v2",   "sms": "Message structure test message v2",   "email": "Message structure test message v2",   "wechat": "{\"msgtype\":\"text\",\"text\":{\"content\":\"Message structure test message v2\"}}",   "dingding": "{\"msgtype\":\"markdown\",\"at\":{\"atMobiles\": [\"15XXXXXX\"],\"atUserIds\": [\"1234567XXX\"],\"isAtAll\": true},\"markdown\":{\"content\":\"Message structure test message v2 @15XXXXXX @1234567XXX\",\"title\":\"Message structure title\"}}",   "feishu": "{\"msgtype\":\"text\",\"text\":{\"content\":\"Message structure test message v2\"}}",   "welinkRed": "{\"msgtype\":\"text\",\"text\":{\"content\":\"Message structure test message v2\"}}",   "http": "Message structure test message v2",   "https": "Message structure test message v2",   "dingTalkBot": "{\"msgtype\":\"markdown\",\"markdown\":{\"content\":\"Message structure test message v2 dingTalkBot markdown\",\"title\":\"Message structure title\"}}",   "functionstage": "Message structure test message v2" }"
	subjectPublishMessageRequestBody:= "test message v2"
	request.Body = &model.PublishMessageRequestBody{
		MessageAttributes: &listMessageAttributesbody,
		TimeToLive: &timeToLivePublishMessageRequestBody,
		MessageStructure: &messageStructurePublishMessageRequestBody,
		Subject: &subjectPublishMessageRequestBody,
	}
	response, err := client.PublishMessage(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • 使用消息模板方式的消息发布

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
    		 
    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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := smn.NewSmnClient(
        smn.SmnClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.PublishMessageRequest{}
	request.TopicUrn = "{topic_urn}"
	valueMessageAttributes:= "[email, sms]"
	var valueMessageAttributesInterface interface{} = valueMessageAttributes
	var listMessageAttributesbody = []model.MessageAttribute{
        {
            Name: "smn_protocol",
            Type: model.GetMessageAttributeTypeEnum().PROTOCOL,
            Value: &valueMessageAttributesInterface,
        },
    }
	var listTagsbody = map[string]string{
        "topic_urn": "topic_urn3331",
        "topic_id": "topic_id3332",
    }
	timeToLivePublishMessageRequestBody:= "3600"
	messageTemplateNamePublishMessageRequestBody:= "confirm_message"
	subjectPublishMessageRequestBody:= "test message template v2"
	request.Body = &model.PublishMessageRequestBody{
		MessageAttributes: &listMessageAttributesbody,
		TimeToLive: &timeToLivePublishMessageRequestBody,
		Tags: listTagsbody,
		MessageTemplateName: &messageTemplateNamePublishMessageRequestBody,
		Subject: &subjectPublishMessageRequestBody,
	}
	response, err := client.PublishMessage(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

429

Too Many Requests

500

Internal Server Error

错误码

请参见错误码。

父主题： 发布消息操作

相关文档