> ## Documentation Index
> Fetch the complete documentation index at: https://docs.phone.wixzel.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List delivery attempts

> One record per POST we made, newest first — so an event delivered on its third try is three records and a flapping receiver is visible as such. `response_status` is null when nothing answered at all, which is what separates "never arrived" from "arrived and your handler threw". Cursor-paginated. Requires `webhooks:read`.



## OpenAPI

````yaml /openapi.json get /v1/webhook/deliveries
openapi: 3.1.0
info:
  title: Wixzel Phone API
  version: '2026-09-01'
  description: >-
    APIs for AI voice agents. One key, one balance, every voice engine.


    ## Authentication

    Send your key as `Authorization: Bearer wv_live_...`. Keys are scoped —
    grant only what an integration needs. There is no admin scope.


    ## Versioning

    The `/v1` prefix covers additive changes. Behavioural changes ship behind a
    dated `Wixzel-Version` header, and existing keys keep the behaviour they
    were created with.


    ## Money

    Amounts are integer **micro-USD** (1,000,000 = $1.00). Voice usage is billed
    per second, per token and per character, so a float dollar figure cannot
    represent it without disagreeing with the ledger.


    ## Errors

    Every error carries a stable `code` and a `request_id`. Match on `code`; the
    `message` is for humans and may change.
  contact:
    name: Wixzel Phone
    url: https://phone.wixzel.com
servers:
  - url: https://api.phone.wixzel.com
    description: Production
security: []
tags:
  - name: Calls
    description: Place calls and read what happened on them.
  - name: Agents
    description: The prompt, voice and behaviour of a caller.
  - name: Leads
    description: People to call, and data to merge into prompts.
  - name: Campaigns
    description: Call a list of leads with one agent.
  - name: Knowledge bases
    description: Facts an agent can draw on mid-call.
  - name: Phone numbers
    description: Numbers on your SIP trunks.
  - name: SIP trunks
    description: Your carrier connections.
  - name: Appointments
    description: Bookings, including ones agents make on calls.
  - name: Usage
    description: Itemised billing lines.
  - name: Billing
    description: Balance, ledger and top-ups.
  - name: API keys
    description: Create, scope and rotate keys.
  - name: Engines
    description: What the platform can serve, and what it costs.
  - name: Webhooks
    description: Where events are sent, and what happened when they got there.
paths:
  /v1/webhook/deliveries:
    get:
      tags:
        - Webhooks
      summary: List delivery attempts
      description: >-
        One record per POST we made, newest first — so an event delivered on its
        third try is three records and a flapping receiver is visible as such.
        `response_status` is null when nothing answered at all, which is what
        separates "never arrived" from "arrived and your handler threw".
        Cursor-paginated. Requires `webhooks:read`.
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
            description: How many records to return.
          required: false
          name: limit
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 512
            description: Return records after this cursor.
          required: false
          name: starting_after
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 512
            description: Return records before this cursor.
          required: false
          name: ending_before
          in: query
        - schema:
            allOf:
              - $ref: '#/components/schemas/WebhookEvent'
              - description: Only attempts for this event.
          required: false
          name: event
          in: query
        - schema:
            type: string
            enum:
              - delivered
              - failed
            description: >-
              Only attempts with this outcome. `failed` is the one worth
              watching.
          required: false
          name: status
          in: query
        - schema:
            type: string
            format: date-time
            description: Only attempts at or after this time.
            example: '2026-09-01T12:00:00.000Z'
          required: false
          name: start
          in: query
        - schema:
            type: string
            format: date-time
            description: Only attempts at or before this time.
            example: '2026-09-01T12:00:00.000Z'
          required: false
          name: end
          in: query
      responses:
        '200':
          description: A page of delivery attempts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookDeliveryList'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Key lacks the required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. Retry after the interval in `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    WebhookEvent:
      type: string
      enum:
        - inboundCall
        - outboundCall
        - callCompleted
        - leadCreated
        - leadQualified
        - campaignCompleted
        - appointmentBooked
        - appointmentCanceled
        - callTransferred
        - transferFailed
      description: The value of the `event` field in the delivered payload.
      example: callCompleted
    WebhookDeliveryList:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/WebhookDelivery'
        has_more:
          type: boolean
          description: True when more records exist after this page.
        next_cursor:
          type:
            - string
            - 'null'
          description: Pass as starting_after to fetch the next page.
      required:
        - object
        - data
        - has_more
        - next_cursor
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - insufficient_credits
                - not_found_error
                - conflict_error
                - api_error
            code:
              type: string
              description: Stable machine-readable code.
              example: agent_not_found
            message:
              type: string
              description: >-
                Human-readable explanation. Do not match on this — match on
                code.
            param:
              type: string
              description: Which field caused the failure, when applicable.
            doc_url:
              type: string
            request_id:
              type: string
              description: Quote this when asking for help.
              example: req_01HXYZ...
          required:
            - type
            - code
            - message
            - request_id
      required:
        - error
    WebhookDelivery:
      type: object
      properties:
        object:
          type: string
          enum:
            - webhook_delivery
        event:
          $ref: '#/components/schemas/WebhookEvent'
        url:
          type: string
          description: >-
            Where this attempt was sent — the URL configured at the time, not
            the current one.
        attempt:
          type: integer
          description: 1 for the first POST of an event. Each attempt is its own record.
        status:
          type: string
          enum:
            - delivered
            - failed
          description: '`delivered` means a 2xx. Nothing else counts, including a 3xx.'
        response_status:
          type:
            - integer
            - 'null'
          description: >-
            Your endpoint's HTTP status, or null when nothing answered — DNS
            failure, refused connection, or timeout.
        error:
          type:
            - string
            - 'null'
          description: >-
            Why it failed, at the transport level. Never your response body: a
            receiver that echoes the payload back would otherwise store it here.
        duration_ms:
          type: integer
        will_retry:
          type: boolean
          description: >-
            True when another attempt was scheduled. Retries run in-process, so
            a deploy between attempts drops the pending one.
        occurred_at:
          type: string
          format: date-time
          description: ISO 8601, always UTC.
          example: '2026-09-01T12:00:00.000Z'
      required:
        - object
        - event
        - url
        - attempt
        - status
        - response_status
        - error
        - duration_ms
        - will_retry
        - occurred_at
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your Wixzel Phone API key: `Authorization: Bearer wv_live_...`. Keys are
        scoped; grant only what the integration needs.

````