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

# Delivery Receipt

> Vodafone sends this delivery receipt payload to your configured callback
URL when a message is delivered or fails at network level.

In the API playground, replace `callbackUrl` with the URL for your test
endpoint. The example default is `https://callback.yourcompany.com`.

Your endpoint must accept `application/x-www-form-urlencoded` POST
requests and return `200 OK` after accepting the payload.




## OpenAPI

````yaml openapi/delivery-receipt-callback.yaml POST /
openapi: 3.1.0
info:
  title: Vodafone Bulk Text Delivery Receipt Callback
  version: 1.0.0
  description: |
    Use this operation to test the Delivery Receipt payload against your own
    callback URL. Vodafone sends this payload to the exact callback endpoint
    configured on your account.
  contact:
    name: Vodafone Bulk Text Support
    email: bulktext.ie@vodafone.com
servers:
  - url: '{callbackUrl}'
    description: Your Delivery Receipt callback URL
    variables:
      callbackUrl:
        default: https://callback.yourcompany.com
        description: >
          Enter the full callback URL Vodafone should post Delivery Receipts to,
          for example `https://callback.yourcompany.com`.
security: []
tags:
  - name: Delivery Receipts
    description: Network delivery status sent by Vodafone to your callback URL.
paths:
  /:
    post:
      tags:
        - Delivery Receipts
      summary: Receive delivery receipts
      description: |
        Vodafone sends this delivery receipt payload to your configured callback
        URL when a message is delivered or fails at network level.

        In the API playground, replace `callbackUrl` with the URL for your test
        endpoint. The example default is `https://callback.yourcompany.com`.

        Your endpoint must accept `application/x-www-form-urlencoded` POST
        requests and return `200 OK` after accepting the payload.
      operationId: testDeliveryReceiptCallback
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DeliveryReceiptWebhook'
            examples:
              delivered:
                summary: Message delivered
                value:
                  SMS-Type: Notification
                  SMS-NotifyId: '321354'
                  SMS-Success: 'True'
                  SMS-To: '353896073106'
                  SMS-From: '353870934726'
                  SMS-Verify: 5fb4926bd7e461eddc6dc629f472bab4
                  SMS-TotalToSend: 1
                  SMS-TotalSent: 1
                  SMS-TotalFailed: 0
                  SMS-TimeStamp: '2026-04-09 16:03:16'
              failed:
                summary: Message not delivered
                value:
                  SMS-Type: Notification
                  SMS-NotifyId: '321354'
                  SMS-Success: 'False'
                  SMS-To: '353896073106'
                  SMS-From: '353870934726'
                  SMS-Verify: 9db038748b3088971d913616c13e769b
                  SMS-TotalToSend: 1
                  SMS-TotalSent: 0
                  SMS-TotalFailed: 1
                  SMS-TimeStamp: '2026-04-09 16:03:16'
      responses:
        '200':
          description: Your callback endpoint accepted the delivery receipt.
      security: []
components:
  schemas:
    DeliveryReceiptWebhook:
      type: object
      description: >
        Delivery receipt payload sent by Vodafone to a customer callback URL
        when network delivery status is available.
      required:
        - SMS-Type
        - SMS-NotifyId
        - SMS-Success
        - SMS-To
        - SMS-From
        - SMS-Verify
        - SMS-TotalToSend
        - SMS-TotalSent
        - SMS-TotalFailed
        - SMS-TimeStamp
      properties:
        SMS-Type:
          type: string
          const: Notification
          description: Always `Notification` for delivery receipts.
        SMS-NotifyId:
          type: string
          description: Recipient-level `notifyId` supplied when sending the message.
          examples:
            - '321354'
        SMS-Success:
          type: string
          enum:
            - 'True'
            - 'False'
          description: >
            `True` only when `SMS-TotalSent` equals `SMS-TotalToSend` and
            `SMS-TotalFailed` is `0`; otherwise `False`.
        SMS-To:
          type: string
          description: Destination mobile number in GSM format.
          examples:
            - '353896073106'
        SMS-From:
          type: string
          description: Sender ID as it appeared on the recipient handset.
          examples:
            - '353870934726'
        SMS-Verify:
          type: string
          description: >
            MD5 verification hash built from `SMS-NotifyId + SMS-Success + your
            verification key`.
          examples:
            - 5fb4926bd7e461eddc6dc629f472bab4
        SMS-TotalToSend:
          type: integer
          description: Total number of messages in the send.
          examples:
            - 1
        SMS-TotalSent:
          type: integer
          description: Number of messages successfully delivered.
          examples:
            - 1
        SMS-TotalFailed:
          type: integer
          description: Number of messages that failed.
          examples:
            - 0
        SMS-TimeStamp:
          type: string
          pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$
          description: Delivery receipt time in UTC, formatted as `yyyy-MM-dd HH:mm:ss`.
          examples:
            - '2026-04-09 16:03:16'

````