Skip to main content

Arguments

str
required
The key of the stream.
str
required
The consumer group name.
str
required
The consumer name that will claim the messages.
int
required
The minimum idle time in milliseconds for messages to be claimed.
str
required
The ID(s) of the message(s) to claim. Can be multiple IDs as separate arguments.
bool
Return only the message IDs instead of the full message data.

Response

Returns a list of claimed messages. If justid option is used, returns only message IDs.