From 317d6d2384ee4b6a9579ced43789910a39c8df18 Mon Sep 17 00:00:00 2001 From: wanghuijuan738 Date: Fri, 2 May 2025 12:33:36 +0000 Subject: [PATCH] SMN API 250307 version. Adding API Parameters MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Reviewed-by: Daniel Kováč Co-authored-by: wanghuijuan738 Co-committed-by: wanghuijuan738 --- docs/smn/api-ref/smn_api_52003.html | 118 ++++++++++++++++++++++++++-- docs/smn/api-ref/smn_api_b0000.html | 8 +- 2 files changed, 119 insertions(+), 7 deletions(-) diff --git a/docs/smn/api-ref/smn_api_52003.html b/docs/smn/api-ref/smn_api_52003.html index d9e9d4eac..a24a0c2d4 100644 --- a/docs/smn/api-ref/smn_api_52003.html +++ b/docs/smn/api-ref/smn_api_52003.html @@ -46,13 +46,13 @@

Request

  • Parameter description -

    Parameter

    +
    - - @@ -91,6 +91,112 @@

    The remarks must be UTF-8-coded and can contain up to 128 bytes.

    + + + + + + + + + + + +

    Parameter

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    extension

    +

    No

    +

    SubscriptionExtension object

    +

    Extended information

    +

    subscriptions

    +

    No

    +

    Array of BatchAddSubscriptionsRequestBody objects

    +

    This parameter is mandatory when subscriptions need to be created in batches. SMN allows you to create a maximum of 50 subscriptions at a time.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 1 BatchAddSubscriptionsRequestBody

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    endpoint

    +

    Yes

    +

    String

    +

    Message endpoint

    +
    NOTE:

    For an HTTP subscription, the endpoint starts with http://.

    +

    For an HTTPS subscription, the endpoint starts with https://.

    +

    For an email subscription, the endpoint is an email address.

    +

    For an SMS subscription, the endpoint is a phone number.

    +
    +

    protocol

    +

    Yes

    +

    String

    +

    Subscription protocol (Different protocols indicate different types of endpoints to receive messages.)

    +

    The following protocols are supported:

    +
    • email: The endpoints are email address.
    • sms: The endpoints are phone numbers.
    • http and https: The endpoints are URLs.
    +

    remark

    +

    No

    +

    String

    +

    Description of the subscription. The remarks must be UTF-8-coded and can contain up to 128 bytes.

    +

    extension

    +

    No

    +

    SubscriptionExtension object

    +

    Extended subscription information

    +
    +
    + +
    + + + + + + + + + +
    Table 2 SubscriptionExtension

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    header

    +

    No

    +

    Map<String,String>

    +

    This is an HTTP header field, which can be customized within the field range. The field content exists in the form of key/value pairs. When a topic is used to send messages, confirmed subscription messages carry the user-defined HTTP header.

    +

    Header for subscriptions over HTTP or HTTPS. The header must meet the following requirements:

    +

    key can contain letters, digits, and hyphens (-). key cannot end with a hyphen (-) nor contain consecutive hyphens (-).

    +

    You can specify up to 10 key/value pairs.

    +

    key must start with x- but not x-smn. Examples: x-abc-cba or x-abc.

    +

    The total length of all key/value pairs cannot exceed 1,024 characters.

    +

    The value is case insensitive.

    +

    The key value must be unique.

    +

    value must be an ASCII code. Unicode characters are not supported. Spaces are allowed.

    +
    @@ -104,11 +210,11 @@

    Response

    • Parameter description -

      Parameter

      +
      - - diff --git a/docs/smn/api-ref/smn_api_b0000.html b/docs/smn/api-ref/smn_api_b0000.html index 4d43981d3..f314b787a 100644 --- a/docs/smn/api-ref/smn_api_b0000.html +++ b/docs/smn/api-ref/smn_api_b0000.html @@ -8,7 +8,13 @@ - + + +

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      2023-03-31

      +

      2025-03-06

      +

      This issue incorporates the following change:

      + +

      2023-03-31

      This issue incorporates the following change: