消息发布

功能介绍

• 接口名称

  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	是	String	发送的消息。 消息体必须是UTF-8编码的字符串，大小至多256KB。 如果订阅者是手机号码，短信内容过长，系统自动拆分，并且只发前两条，建议控制短信长度。 短信内容字符是ASCII字符时，单条短信支持459字符。 如果短信内容字符存在非ASCII字符，单条短信支持201字符。
  time_to_live	否	String	指消息在SMN系统内部的最长存留时间。 超过该存留时间，系统将不再发送该消息。单位是s，变量默认值是3600，即一小时。 值为正整数且小于等于3600*24*7。

• 请求样例

  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"
  }

响应消息

• 要素说明

  名称	参数类型	说明
  request_id	String	请求的唯一标识ID。
  message_id	String	唯一的消息ID。

• 响应样例

  {
      "message_id": "bf94b63a5dfb475994d3ac34664e24f2",
      "request_id": "9974c07f6d554a6d827956acbeb4be5f"
  }

返回值

请参考返回值。

错误码

请参考错误码。