Updated on 2022-09-15 GMT+08:00

Processing Messages

Description

This API is used to process received notification messages within a specified time period.

URL

  • URI format

    POST /v1/{project_id}/service/messages

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

Request Message

  • Example request
    {
      "message_id": "82edfd975d5tf2ca5d920bbdf42bf2z9",
      "action": 1,
      "time": "2021-01-01T10:00:00.000Z"
    }
  • Request parameter description

    Parameter

    Mandatory

    Type

    Description

    message_id

    Yes

    String

    Message ID

    action

    Yes

    Integer

    Operation to be performed

    0: immediate operation

    1: periodic operation

    Value range: [0, 1]

    time

    No

    String

    End time, in ISO format (+0 time zone). The operation in the notification received will be performed after the expiration time. This parameter is required only for periodic execution. By default, the end time is three days after the current server time and is accurate to hour.

Response

  • Example response

    None

Status Code

Status Code

Description

204

The messages are successfully processed.

For details about status codes, see Status Codes.