Skip to main content

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.

The Postman collection is not available yet. This page documents the intended collection structure.

Download OpenAPI specs

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

OAuth and campaign API

Download oauth.yaml.

Legacy URL-encoded API

Download url-legacy.yaml.

Delivery and inbound webhooks

Download webhooks.yaml.

Planned environment variables

VariableExamplePurpose
auth_base_urlhttps://auth.vodafone.comToken endpoint host.
api_base_urlhttps://api.vodafone.comOAuth v2 API host.
legacy_base_urlhttp://bulktext.vodafone.ie/HTTP_API/V1Legacy URL-encoded API host.
usernameYOUR_USERNAMEVodafone Bulk Text username.
passwordYOUR_PASSWORDVodafone Bulk Text password.
access_tokeneyJ...JWT token returned by the auth request.
sender_idVodafoneApproved Sender ID on your account.
recipient_msisdn353861234567Test 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, Authentication, and Sending SMS.
Last modified on May 6, 2026