## Pull Queue Messages

`client.queues.messages.pull(stringqueueId, MessagePullParamsparams, RequestOptionsoptions?): MessagePullResponse`

**post** `/accounts/{account_id}/queues/{queue_id}/messages/pull`

Pull a batch of messages from a Queue

### Parameters

- `queueId: string`

  A Resource identifier.

- `params: MessagePullParams`

  - `account_id: string`

    Path param: A Resource identifier.

  - `batch_size?: number`

    Body param: The maximum number of messages to include in a batch.

  - `visibility_timeout_ms?: number`

    Body param: The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.

### Returns

- `MessagePullResponse`

  - `message_backlog_count?: number`

    The number of unacknowledged messages in the queue

  - `messages?: Array<Message>`

    - `id?: string`

    - `attempts?: number`

    - `body?: string`

    - `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.

    - `metadata?: unknown`

    - `timestamp_ms?: number`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.queues.messages.pull('023e105f4ecef8ad9ca31a8372d0c353', {
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(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
      }
    ]
  },
  "success": true
}
```