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

# Obtain Access Token

> Get a JWT access token for secure Vodafone Bulk Text API requests.

**Token Endpoint**: `https://auth.vodafone.com/token`  
**Grant Type**: `password`  
**Content-Type**: `application/x-www-form-urlencoded`

**Request Body**:
```
grant_type=password
username=your_username
password=your_strong_password
client_id=ismstoken
```

A successful response includes:
- `access_token` - Pass this as `Authorization: Bearer {token}`.
- `expires_in` - Token lifetime in seconds.
- `refresh_token` - Use this to request a new access token.
- `scope`, `session_state`, and related token details.

Keep credentials and tokens secure. Do not expose them in browser code,
logs, analytics tools, or customer-facing content.




## OpenAPI

````yaml POST /token
openapi: 3.1.0
info:
  title: Vodafone Bulk Text OAuth API
  description: >
    Use the Vodafone Bulk Text OAuth API to authenticate securely, send SMS

    campaigns, and check the Sender IDs available on your account.


    This API suite supports practical business communication from your CRM,

    application, or customer database:


    1. **Authentication**: Get a JWT access token from
    `https://auth.vodafone.com`

    and use it to protect API requests.


    2. **Campaign messaging**: Send customer alerts, appointment reminders,

    staff updates, promotions, and other time-sensitive SMS messages through

    `https://api.vodafone.com`.
  version: 2.0.0
  contact:
    name: Vodafone Bulk Text Support
    email: bulktext.ie@vodafone.com
  x-brand:
    name: Vodafone Ireland
    voice: Confident, direct, practical, and business-focused.
    tone:
      - Clear and action-oriented.
      - Security-aware without sounding alarmist.
      - Commercially focused, with emphasis on reliable customer communication.
      - Short, scannable wording that helps customers complete the task.
    colors:
      primary: '#E60000'
      secondary: '#121212'
      surface: '#F2F2F2'
      text: '#0D0D0D'
      error: '#D93025'
    typography:
      primaryFamily: Vodafone, Open Sans, sans-serif
      style: Compact, legible, and conversion-focused.
servers:
  - url: https://api.vodafone.com
    description: Vodafone Bulk Text API server
security: []
tags:
  - name: Authentication
    description: Get access tokens for secure Vodafone Bulk Text API requests.
  - name: Bulk Text
    description: Send reliable SMS campaigns and check your approved Sender IDs.
paths:
  /token:
    post:
      tags:
        - Authentication
      summary: Get an access token
      description: |
        Get a JWT access token for secure Vodafone Bulk Text API requests.

        **Token Endpoint**: `https://auth.vodafone.com/token`  
        **Grant Type**: `password`  
        **Content-Type**: `application/x-www-form-urlencoded`

        **Request Body**:
        ```
        grant_type=password
        username=your_username
        password=your_strong_password
        client_id=ismstoken
        ```

        A successful response includes:
        - `access_token` - Pass this as `Authorization: Bearer {token}`.
        - `expires_in` - Token lifetime in seconds.
        - `refresh_token` - Use this to request a new access token.
        - `scope`, `session_state`, and related token details.

        Keep credentials and tokens secure. Do not expose them in browser code,
        logs, analytics tools, or customer-facing content.
      operationId: getAccessToken
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - client_id
                - username
                - password
                - grant_type
              properties:
                username:
                  type: string
                password:
                  type: string
                client_id:
                  type: string
                  enum:
                    - ismstoken
                grant_type:
                  type: string
                  enum:
                    - password
            examples:
              passwordGrant:
                summary: Request an access token
                value:
                  username: your_username
                  password: your_strong_password
                  client_id: ismstoken
                  grant_type: password
      responses:
        '200':
          description: Access token issued successfully.
          content:
            application/json:
              examples:
                tokenResponse:
                  summary: Access token response
                  value:
                    access_token: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJE...
                    expires_in: 120
                    refresh_expires_in: 1200
                    refresh_token: eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJh...
                    token_type: Bearer
                    scope: email profile client_id
        '401':
          description: The username or password could not be authenticated.
          content:
            application/json:
              examples:
                invalidCredentials:
                  summary: Check your credentials
                  value:
                    error: invalid_grant
                    error_description: Invalid user credentials
      security: []
      servers:
        - url: https://auth.vodafone.com
          description: Vodafone Bulk Text authentication server

````