## Pull Queue Messages `queues.messages.pull(strqueue_id, MessagePullParams**kwargs) -> MessagePullResponse` **post** `/accounts/{account_id}/queues/{queue_id}/messages/pull` Pull a batch of messages from a Queue ### Parameters - `account_id: str` A Resource identifier. - `queue_id: str` A Resource identifier. - `batch_size: Optional[float]` The maximum number of messages to include in a batch. - `visibility_timeout_ms: Optional[float]` The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt. ### Returns - `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]` - `metadata: Optional[Metadata]` - `metrics: Optional[MetadataMetrics]` Best-effort metrics for the queue. Values may be approximate due to the distributed nature of queues. - `backlog_bytes: float` The size in bytes of unacknowledged messages in the queue. - `backlog_count: float` The number of unacknowledged messages in the queue. - `oldest_message_timestamp_ms: float` Unix timestamp in milliseconds of the oldest unacknowledged message in the queue. Returns 0 if unknown. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) response = client.queues.messages.pull( queue_id="023e105f4ecef8ad9ca31a8372d0c353", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(response.message_backlog_count) ``` #### Response ```json { "errors": [ { "code": 7003, "message": "No route for the URI", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ "string" ], "result": { "message_backlog_count": 5, "messages": [ { "id": "b01b5594f784d0165c2985833f5660dd", "attempts": 1, "body": "hello world", "lease_id": "eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0", "metadata": { "CF-Content-Type": "text", "CF-sourceMessageSource": "dash" }, "timestamp_ms": 1710950954154 } ], "metadata": { "metrics": { "backlog_bytes": 1024, "backlog_count": 5, "oldest_message_timestamp_ms": 1710950954154 } } }, "success": true } ```