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

# List Sender IDs

> Get the Sender IDs available on your Vodafone Bulk Text account before
sending a campaign.

Each sender entry includes:
- `name` - Sender ID value.
- `type` - Sender ID type:
  - `0` = ComReg Sender ID
  - `1` = International non-ComReg approved Sender ID
  - `2` = Numeric Sender ID

Use one of these approved values as the `from` field when sending a
campaign.




## OpenAPI

````yaml GET /api/v2/senderlist
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:
  /api/v2/senderlist:
    get:
      tags:
        - Bulk Text
      summary: Get your approved Sender IDs
      description: |
        Get the Sender IDs available on your Vodafone Bulk Text account before
        sending a campaign.

        Each sender entry includes:
        - `name` - Sender ID value.
        - `type` - Sender ID type:
          - `0` = ComReg Sender ID
          - `1` = International non-ComReg approved Sender ID
          - `2` = Numeric Sender ID

        Use one of these approved values as the `from` field when sending a
        campaign.
      operationId: GetSenderList
      responses:
        '200':
          description: Sender IDs returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SenderListResponse'
              examples:
                senderListResponse:
                  summary: Approved Sender IDs
                  value:
                    - name: FreeText
                      type: 1
                    - name: '353851234567'
                      type: 2
                    - name: Vodafone
                      type: 0
        '401':
          description: The access token is missing, expired, or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignResponse'
              examples:
                unauthorizedResponse:
                  summary: Check the access token
                  value:
                    success: false
                    message: Unauthorized.
                    errors:
                      - 401 Unauthorized
      security:
        - BearerAuth: []
      servers:
        - url: https://api.vodafone.com
          description: Vodafone Bulk Text API server
components:
  schemas:
    SenderListResponse:
      type: array
      description: Sender IDs approved for the authenticated Vodafone Bulk Text account.
      items:
        $ref: '#/components/schemas/SenderId'
    CampaignResponse:
      type: object
      description: Standard Vodafone Bulk Text API response.
      properties:
        success:
          type: boolean
          description: Indicates whether the request was accepted.
        message:
          type:
            - string
            - 'null'
          description: Human-readable status message for the request.
        errors:
          type:
            - array
            - 'null'
          description: Validation or processing messages to review.
          items:
            type: string
    SenderId:
      type: object
      required:
        - name
        - type
      properties:
        name:
          type: string
          description: Sender ID value available on the account.
        type:
          type: integer
          description: >
            The Sender ID type:

            - 0 = ComReg Sender ID

            - 1 = International non-ComReg approved Sender ID (will not send to
            Irish numbers)

            - 2 = Numeric Sender ID
          enum:
            - 0
            - 1
            - 2
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Get a JWT access token from `https://auth.vodafone.com/token`. Pass it
        in the `Authorization` header as `Bearer {token}` when calling Vodafone
        Bulk Text API endpoints.

````