v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0172165343.2 KB
Msgs

Queue Receive

Receives messages from a topic as competing consumers.

Messages are individually leased for the specified duration. Multiple consumers can receive different messages from the same topic concurrently. Leased messages are skipped until they are acked or their lease expires.

post/api/v1.msgs.queue.receive

Request body

namespacestring nullable
topicstring required
consumer_groupstring required
batch_sizeinteger
lease_duration_msinteger
batch_wait_msinteger nullable

Maximum time (in milliseconds) to wait for messages before returning.

Example request

{
  "namespace": "some_namespace",
  "topic": "some_topic_name",
  "consumer_group": "some_consumer_group"
}

Response