• Simple Message Notification

smn
  1. Help Center
  2. Simple Message Notification
  3. API Reference
  4. APIs
  5. Message Publishing
  6. Publishing Messages in the Text Format

Publishing Messages in the Text Format

Description

  • API name

    Publish

  • Function

    Publish messages in the text format to a topic. After the message ID is returned, the message has been saved and is to be pushed to the subscribers of the topic.

URI

  • URI format

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

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID

    topic_urn

    Yes

    String

    Resource identifier of a topic, which is unique

Request

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    subject

    No

    String

    Message subject, which is presented as the email subject when SMN sends massages to email subscribers

    message

    Yes

    String

    Message content

    The message content is a UTF-8-coded character string of no more than 256 KB. For SMS subscribers, if the content exceeds 256 bytes, the system will divide it into multiple messages and send only the first two.

    time_to _live

    No

    String

    Time-to-live (TTL) of a message, specifically, the maximum time period for retaining the message in the system

    If the period expires, the system will discard the message. The time period is measured in seconds, and the default TTL is 3600s (one hour).

    The value must be a positive integer less than or equal to 604,800 (3600 x 24 x 7).

  • Request example
    POST /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"
    }

Response

  • Parameter description

    Parameter

    Type

    Description

    request_id

    String

    Request ID, which is unique

    message_id

    String

    Message ID, which is unique

  • Response example
    {
        "message_id": "bf94b63a5dfb475994d3ac34664e24f2",
        "request_id": "9974c07f6d554a6d827956acbeb4be5f"
    }

Returned Value

See section Returned Value.

Error Code

See section Error Code.