> ## Documentation Index
> Fetch the complete documentation index at: https://developers.vfbulk.ie/llms.txt
> Use this file to discover all available pages before exploring further.

# Postman collection

> Placeholder structure for the Vodafone Bulk Text Postman collection.

<Warning>
  The Postman collection is not available yet. This page documents the intended collection structure.
</Warning>

## Download OpenAPI specs

Use these specs to generate a local Postman collection or import the APIs into another tool.

<CardGroup cols={3}>
  <Card title="OAuth and campaign API" icon="file-code" href="/openapi/oauth.yaml">
    Download `oauth.yaml`.
  </Card>

  <Card title="Legacy URL-encoded API" icon="file-code" href="/openapi/url-legacy.yaml">
    Download `url-legacy.yaml`.
  </Card>

  <Card title="Delivery and inbound webhooks" icon="file-code" href="/openapi/webhooks.yaml">
    Download `webhooks.yaml`.
  </Card>
</CardGroup>

## Planned environment variables

| Variable           | Example                                   | Purpose                                 |
| ------------------ | ----------------------------------------- | --------------------------------------- |
| `auth_base_url`    | `https://auth.vodafone.com`               | Token endpoint host.                    |
| `api_base_url`     | `https://api.vodafone.com`                | OAuth v2 API host.                      |
| `legacy_base_url`  | `http://bulktext.vodafone.ie/HTTP_API/V1` | Legacy URL-encoded API host.            |
| `username`         | `YOUR_USERNAME`                           | Vodafone Bulk Text username.            |
| `password`         | `YOUR_PASSWORD`                           | Vodafone Bulk Text password.            |
| `access_token`     | `eyJ...`                                  | JWT token returned by the auth request. |
| `sender_id`        | `Vodafone`                                | Approved Sender ID on your account.     |
| `recipient_msisdn` | `353861234567`                            | Test recipient number.                  |

## Planned requests

The collection should include these requests:

* `POST /token` - request an access token.
* `POST /api/v2/Campaign` - send an SMS campaign.
* `GET /api/v2/senderlist` - list approved Sender IDs.
* `GET /health` - check service health.
* `POST /sendmessage.aspx` - send through the legacy URL-encoded API.

## Planned examples

Each request should include:

* A successful request example.
* A successful response example.
* At least one validation or authentication failure example.
* Required headers and content type.
* Example payloads that match the OpenAPI specs.

## Use the docs today

Until the collection is published, use the code examples in [Quickstart](/quickstart), [Authentication](/guides/authentication), and [Sending SMS](/guides/sending-sms).