Apache RocketMQ · JSON Structure

Apache Rocketmq Receive Request Structure

Request to receive messages from a topic

Type: object Properties: 4 Required: 2
Cloud NativeMessagingMessage QueuePub-SubStreamingApacheOpen Source

ReceiveRequest is a JSON Structure definition published by Apache RocketMQ, describing 4 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

topic consumerGroup maxMessages invisibleDuration

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-rocketmq/refs/heads/main/json-structure/apache-rocketmq-receive-request-structure.json",
  "description": "Request to receive messages from a topic",
  "type": "object",
  "properties": {
    "topic": {
      "type": "string",
      "description": "Topic to consume from"
    },
    "consumerGroup": {
      "type": "string",
      "description": "Consumer group identifier"
    },
    "maxMessages": {
      "type": "int32",
      "description": "Maximum messages to pull"
    },
    "invisibleDuration": {
      "type": "int32",
      "description": "Invisible duration in milliseconds"
    }
  },
  "required": [
    "topic",
    "consumerGroup"
  ],
  "name": "ReceiveRequest"
}