Messages

Push Message

queues.messages.push(, ) -> MessagePushResponse

POST/accounts/{account_id}/queues/{queue_id}/messages

Acknowledge + Retry Queue Messages

queues.messages.ack(, ) -> MessageAckResponse

POST/accounts/{account_id}/queues/{queue_id}/messages/ack

Pull Queue Messages

queues.messages.pull(, ) -> MessagePullResponse

POST/accounts/{account_id}/queues/{queue_id}/messages/pull

Push Message Batch

queues.messages.bulk_push(, ) -> MessageBulkPushResponse

POST/accounts/{account_id}/queues/{queue_id}/messages/batch

ModelsExpand Collapse

class MessagePushResponse: …

errors: Optional[List[ResponseInfo]]

minLength1

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[Source]

pointer: Optional[str]

messages: Optional[List[str]]

success: Optional[Literal[true]]

Indicates if the API call was successful or not.

class MessageAckResponse: …

ack_count: Optional[float]

The number of messages that were succesfully acknowledged.

retry_count: Optional[float]

The number of messages that were succesfully retried.

warnings: Optional[List[str]]

class MessagePullResponse: …

message_backlog_count: Optional[float]

The number of unacknowledged messages in the queue

messages: Optional[List[Message]]

id: Optional[str]

attempts: Optional[float]

body: Optional[str]

lease_id: Optional[str]

An ID that represents an "in-flight" message that has been pulled from a Queue. You must hold on to this ID and use it to acknowledge this message.

metadata: Optional[object]

timestamp_ms: Optional[float]

class MessageBulkPushResponse: …