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

# API Reference

> Complete reference for the Vodafone Bulk Text REST API.

## Download OpenAPI specs

Download the source OpenAPI files for local tooling, contract review, or code generation.

<CardGroup cols={3}>
  <Card title="OAuth and campaign API" icon="file-code" href="/openapi/oauth.yaml">
    Download the OAuth token, campaign, sender list, health, and processing webhook spec.
  </Card>

  <Card title="Legacy URL-encoded API" icon="file-code" href="/openapi/url-legacy.yaml">
    Download the v1 URL-encoded send message API spec.
  </Card>

  <Card title="Delivery and inbound webhooks" icon="file-code" href="/openapi/webhooks.yaml">
    Download the delivery receipt and inbound message webhook spec.
  </Card>
</CardGroup>

## Base URL

All API requests are made to:

```text title="Base URL" icon="link" wrap theme={"system"}
https://api.vodafone.com/api/v2
```

## Authentication

Authenticate by first obtaining an access token from:

```text title="Token endpoint" icon="lock" wrap theme={"system"}
https://auth.vodafone.com/token
```

Then include the access token in the `Authorization` header on every API request:

```http title="Authorization header" icon="key" highlight={1} wrap theme={"system"}
Authorization: Bearer YOUR_ACCESS_TOKEN
```

## Request format

The OAuth token endpoint uses `application/x-www-form-urlencoded`.

Campaign endpoints use JSON with `Content-Type: application/json`.

## Response codes

| Code  | Meaning                                                |
| ----- | ------------------------------------------------------ |
| `200` | OK — request succeeded                                 |
| `400` | Bad Request — invalid parameters or validation errors  |
| `401` | Unauthorized — invalid or missing access token         |
| `415` | Unsupported Media Type — use the required content type |
| `500` | Internal Server Error                                  |