Consume
Get next messages
Get the next messages for an HTTP stream consumer
POST
/
v1
/
http-consumers
/
{id}
/
next
You can use either
POST
or GET
to retrieve messages for an HTTP stream consumer.Request parameters
id
string
requiredID of the consumer.
batch_size
integer
Number of messages to try to fetch from the consumer. Defaults to 1
.
The count of returned messages may be less than the requested batch size if there are fewer messages available for the consumer.
wait_for
integer
Amount of time to wait for messages to become available in the consumer, in milliseconds. Defaults to 0
.
When wait_for
is greater than 0
, the request will block until either batch_size
messages are available or wait_for
milliseconds have passed.
Therefore, you can use wait_for
to implement long polling.
Response fields
The response is an object with a data
property that contains a list of messages.
data
list
info
object
Was this page helpful?