--- title: Messages --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Queues](https://developers.cloudflare.com/api/typescript/resources/queues) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Messages ##### [Push Message](https://developers.cloudflare.com/api/typescript/resources/queues/subresources/messages/methods/push) client.queues.messages.push(stringqueueID, MessagePushParamsparams, RequestOptionsoptions?): [MessagePushResponse]() {metadata } POST/accounts/{account\_id}/queues/{queue\_id}/messages ##### [Acknowledge + Retry Queue Messages](https://developers.cloudflare.com/api/typescript/resources/queues/subresources/messages/methods/ack) client.queues.messages.ack(stringqueueID, MessageAckParams {account\_id, acks, retries } params, RequestOptionsoptions?): [MessageAckResponse]() {ackCount, retryCount, warnings } POST/accounts/{account\_id}/queues/{queue\_id}/messages/ack ##### [Pull Queue Messages](https://developers.cloudflare.com/api/typescript/resources/queues/subresources/messages/methods/pull) client.queues.messages.pull(stringqueueID, MessagePullParams {account\_id, batch\_size, visibility\_timeout\_ms } params, RequestOptionsoptions?): [MessagePullResponse]() {message\_backlog\_count, messages, metadata } POST/accounts/{account\_id}/queues/{queue\_id}/messages/pull ##### [Push Message Batch](https://developers.cloudflare.com/api/typescript/resources/queues/subresources/messages/methods/bulk_push) client.queues.messages.bulkPush(stringqueueID, MessageBulkPushParams {account\_id, delay\_seconds, messages } params, RequestOptionsoptions?): [MessageBulkPushResponse]() {metadata } POST/accounts/{account\_id}/queues/{queue\_id}/messages/batch ##### [Peek Queue Messages](https://developers.cloudflare.com/api/typescript/resources/queues/subresources/messages/methods/peek) client.queues.messages.peek(stringqueueID, MessagePeekParams {account\_id, batch\_size } params, RequestOptionsoptions?): [MessagePeekResponse]() {messages } POST/accounts/{account\_id}/queues/{queue\_id}/messages/peek ##### [Purge Peeked Queue Messages](https://developers.cloudflare.com/api/typescript/resources/queues/subresources/messages/methods/purge) client.queues.messages.purge(stringqueueID, MessagePurgeParams {account\_id, refs } params, RequestOptionsoptions?): [MessagePurgeResponse]() {errors, warnings } POST/accounts/{account\_id}/queues/{queue\_id}/messages/purge ##### ModelsExpand Collapse

MessagePushResponse {metadata }

metadata?: Metadata {metrics }

metrics?: Metrics {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. Link to this property backlog\_count: number The number of unacknowledged messages in the queue. Link to this property oldest\_message\_timestamp\_ms: number Unix timestamp in milliseconds of the oldest unacknowledged message in the queue. Returns 0 if unknown. Link to this property

Link to this property

[Link to this property](<#(resource)%20queues.messages%20%3E%20(model)%20message_push_response%20%3E%20(schema)>)

MessageAckResponse {ackCount, retryCount, warnings }

ackCount?: number The number of messages that were succesfully acknowledged. Link to this property retryCount?: number The number of messages that were succesfully retried. Link to this property warnings?: Record<string, string> Map of lease IDs to warning messages encountered during acknowledgement. Link to this property

[Link to this property](<#(resource)%20queues.messages%20%3E%20(model)%20message_ack_response%20%3E%20(schema)>)

MessagePullResponse {message\_backlog\_count, messages, metadata }

message\_backlog\_count?: number The number of unacknowledged messages in the queue. Link to this property

messages?: Array<Message>

id?: string Link to this property attempts?: number Link to this property body?: string Link to this property lease\_id?: 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. Link to this property metadata?: unknown Link to this property timestamp\_ms?: number Link to this property

Link to this property

metadata?: Metadata {metrics }

metrics?: Metrics {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.

Link to this property

[Link to this property](<#(resource)%20queues.messages%20%3E%20(model)%20message_pull_response%20%3E%20(schema)>)

MessageBulkPushResponse {metadata }

metadata?: Metadata {metrics }

metrics?: Metrics {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.

Link to this property

[Link to this property](<#(resource)%20queues.messages%20%3E%20(model)%20message_bulk_push_response%20%3E%20(schema)>)

MessagePeekResponse {messages }

messages?: Array<Message>

id?: string Link to this property attempts?: number Link to this property body?: string Link to this property metadata?: unknown Link to this property ref?: string An opaque reference to a peeked message. You must hold on to this value and use it to purge the message. Link to this property timestamp\_ms?: number Link to this property

Link to this property

[Link to this property](<#(resource)%20queues.messages%20%3E%20(model)%20message_peek_response%20%3E%20(schema)>)

MessagePurgeResponse {errors, warnings }

errors?: Array<Error> Errors encountered while purging messages.

message?: string Link to this property

Link to this property warnings?: Record<string, string> Map of refs to warning messages encountered during purge. Link to this property

[Link to this property](<#(resource)%20queues.messages%20%3E%20(model)%20message_purge_response%20%3E%20(schema)>)