Skip to main content

​
Arguments

​
key
str
required
The key of the stream.
​
group
str
required
The consumer group name.
​
consumer
str
required
The consumer name that will claim the messages.
​
min_idle_time
int
required
The minimum idle time in milliseconds for messages to be claimed.
​
ids
str
required
The ID(s) of the message(s) to claim. Can be multiple IDs as separate arguments.
​
justid
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.
# Claim messages that have been idle for more than 60 seconds
result = redis.xclaim(
    "mystream",
    "mygroup",
    "consumer1",
    60000,  # 60 seconds
    "1638360173533-0", "1638360173533-1"
)

[
  ["1638360173533-0", ["field1", "value1", "field2", "value2"]],
  ["1638360173533-1", ["field1", "value3", "field2", "value4"]]
]
⌘I