Receive next messages
Use the /receive
endpoint to get one or more messages from a pull consumer
POST
or GET
to receive messages for a pull consumer.Request parameters
The ID or name of the consumer.
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.
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. Within each message is an ack_token
and a data
property that contains the message data.
Was this page helpful?