Messages

Push Message

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

Acknowledge + Retry Queue Messages

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

Pull Queue Messages

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

Push Message Batch

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

ModelsExpand Collapse

MessagePushResponse object { metadata }

metadata: optional object { metrics }

metrics: optional object { backlog_bytes, backlog_count, oldest_message_timestamp_ms }

Best-effort metrics for the queue. Values may be approximate due to the distributed nature of queues.

backlog_bytes: number

The size in bytes of unacknowledged messages in the queue.

backlog_count: number

The number of unacknowledged messages in the queue.

oldest_message_timestamp_ms: number

Unix timestamp in milliseconds of the oldest unacknowledged message in the queue. Returns 0 if unknown.

MessageAckResponse object { ackCount, retryCount, warnings }

ackCount: optional number

The number of messages that were succesfully acknowledged.

retryCount: optional number

The number of messages that were succesfully retried.

warnings: optional map[string]

Map of lease IDs to warning messages encountered during acknowledgement.

MessagePullResponse object { message_backlog_count, messages, metadata }

message_backlog_count: optional number

The number of unacknowledged messages in the queue.

messages: optional array of object { id, attempts, body, 3 more }

id: optional string

attempts: optional number

body: optional string

lease_id: optional string

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 unknown

timestamp_ms: optional number

metadata: optional object { metrics }

metrics: optional object { backlog_bytes, backlog_count, oldest_message_timestamp_ms }

Best-effort metrics for the queue. Values may be approximate due to the distributed nature of queues.

backlog_bytes: number

The size in bytes of unacknowledged messages in the queue.

backlog_count: number

The number of unacknowledged messages in the queue.

oldest_message_timestamp_ms: number

Unix timestamp in milliseconds of the oldest unacknowledged message in the queue. Returns 0 if unknown.

MessageBulkPushResponse object { metadata }

metadata: optional object { metrics }

metrics: optional object { backlog_bytes, backlog_count, oldest_message_timestamp_ms }

Best-effort metrics for the queue. Values may be approximate due to the distributed nature of queues.

backlog_bytes: number

The size in bytes of unacknowledged messages in the queue.

backlog_count: number

The number of unacknowledged messages in the queue.

oldest_message_timestamp_ms: number

Unix timestamp in milliseconds of the oldest unacknowledged message in the queue. Returns 0 if unknown.