更新时间:2022-02-21 GMT+08:00

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

功能介绍

  • 接口名称

    Publish

  • 功能描述

    使用消息模板的方式发送消息,将消息发送给Topic的所有订阅端点。当返回消息ID时,该消息已被保存并开始尝试将其推送给Topic的订阅者。本接口支持在一次消息发布调用中,使用不同协议的同名模板,可对不同订阅类型的订阅者推送不同的消息内容。

URI

  • URI格式

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

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID

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

    topic_urn

    String

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

请求消息

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    subject

    String

    消息标题,给邮箱订阅者发送邮件时作为邮件主题。

    长度不超过512字节。

    message_template_name

    String

    消息模板名称,可通过查询消息模板列表获取名称。

    说明:

    三种消息发送方式

    • message
    • message_structure
    • message_template_name

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

    message_structure>message_template_name>message

    tags

    JSON格式的字典

    tag以及替换tag的参数组成的字典。

    消息模板中的标签对应的值。

    time_to_live

    String

    指消息在SMN系统内部的最长存留时间。

    超过该存留时间,系统将不再发送该消息。单位是s,变量默认值是3600s,即一小时。

    值为正整数且小于等于3600*24*7。

  • 请求样例
    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"
        }
    }

响应消息

  • 要素说明

    名称

    参数类型

    说明

    request_id

    String

    请求的唯一标识ID。

    message_id

    String

    唯一的消息ID。

  • 响应样例
    {
        "message_id": "bf94b63a5dfb475994d3ac34664e24f2",
        "request_id": "9974c07f6d554a6d827956acbeb4be5f"
    }

返回值

请参考返回值

错误码

请参考错误码说明