Apache RocketMQ · Schema

MessageRequest

Request to send a message to RocketMQ

Cloud-NativeMessagingMessage QueuePub-SubStreamingApacheOpen-Source

Properties

Name Type Description
topic string Target topic name
body string Message body content
tag string Message tag for filtering
keys array Message keys for lookup
properties object User-defined message properties
delayLevel integer Delay level for scheduled messages (0=no delay)
View JSON Schema on GitHub

JSON Schema

apache-rocketmq-message-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-rocketmq/refs/heads/main/json-schema/apache-rocketmq-message-request-schema.json",
  "title": "MessageRequest",
  "description": "Request to send a message to RocketMQ",
  "type": "object",
  "properties": {
    "topic": {
      "type": "string",
      "description": "Target topic name"
    },
    "body": {
      "type": "string",
      "description": "Message body content"
    },
    "tag": {
      "type": "string",
      "description": "Message tag for filtering"
    },
    "keys": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Message keys for lookup"
    },
    "properties": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "User-defined message properties"
    },
    "delayLevel": {
      "type": "integer",
      "description": "Delay level for scheduled messages (0=no delay)"
    }
  },
  "required": [
    "topic",
    "body"
  ]
}