openapi: 3.2.0
info:
  contact:
    email: support@telnyx.com
  description: Telnyx provides global communications and connectivity APIs for developers — including SIP trunking, programmable voice, SMS, MMS, WhatsApp Business Messaging, Call Control, Fax, Wireless (IoT & eSIM), Phone Numbers (DID provisioning & porting), Emergency Services, and Network APIs for private interconnects and edge connectivity. Build, scale, and manage voice, messaging, and data networks with Telnyx's carrier-grade global infrastructure and API-first platform.
  title: Telnyx Callbacks API
  version: 2.0.0
  x-endpoint-cost: light
servers:
- description: Version 2.0.0 of the Telnyx API
  url: https://api.telnyx.com/v2
security:
- bearerAuth: []
tags:
- description: Callbacks
  name: Callbacks
paths: {}
webhooks:
  CallAIGatherEnded:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallAIGatherEnded
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallAIGatherEndedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call AI Gather Ended
      tags:
      - Callbacks
  CallAIGatherMessageHistoryUpdated:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallAIGatherMessageHistoryUpdated
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallAIGatherMessageHistoryUpdatedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call AI Gather Message History Updated
      tags:
      - Callbacks
  CallAIGatherPartialResults:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallAIGatherPartialResults
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallAIGatherPartialResultsEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call AI Gather Partial Results
      tags:
      - Callbacks
  callAnswered:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallAnswered
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallAnsweredEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Answered
      tags:
      - Callbacks
  callBridged:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallBridged
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallBridgedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Bridged
      tags:
      - Callbacks
  callConversationEnded:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallConversationEnded
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/callConversationEndedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Conversation Ended
      tags:
      - Callbacks
  callConversationInsightsGenerated:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallConversationInsightsGenerated
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/callConversationInsightsGeneratedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Conversation Insights Generated
      tags:
      - Callbacks
  callCost:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallCost
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallCostEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Cost
      tags:
      - Callbacks
  callDeepfakeDetectionError:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallDeepfakeDetectionError
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallDeepfakeDetectionErrorEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Deepfake Detection Error
      tags:
      - Callbacks
  callDeepfakeDetectionResult:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallDeepfakeDetectionResult
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallDeepfakeDetectionResultEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Deepfake Detection Result
      tags:
      - Callbacks
  callDtmfReceived:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallDtmfReceived
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallDtmfReceivedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Dtmf Received
      tags:
      - Callbacks
  callEnqueued:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallEnqueued
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallEnqueuedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Enqueued
      tags:
      - Callbacks
  callForkStarted:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallForkStarted
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallForkStartedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Fork Started
      tags:
      - Callbacks
  callForkStopped:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallForkStopped
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallForkStoppedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Fork Stopped
      tags:
      - Callbacks
  callGatherEnded:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallGatherEnded
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallGatherEndedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Gather Ended
      tags:
      - Callbacks
  callHangup:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallHangup
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallHangupEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Hangup
      tags:
      - Callbacks
  callHold:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallHold
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallHoldEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Hold
      tags:
      - Callbacks
  callInitiated:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallInitiated
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallInitiatedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Initiated
      tags:
      - Callbacks
  callLeftQueue:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallLeftQueue
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallLeftQueueEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Left Queue
      tags:
      - Callbacks
  callMachineDetectionEnded:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallMachineDetectionEnded
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallMachineDetectionEndedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Machine Detection Ended
      tags:
      - Callbacks
  callMachineGreetingEnded:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallMachineGreetingEnded
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallMachineGreetingEndedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Machine Greeting Ended
      tags:
      - Callbacks
  callMachinePremiumDetectionEnded:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallMachinePremiumDetectionEnded
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallMachinePremiumDetectionEndedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Machine Premium Detection Ended
      tags:
      - Callbacks
  callMachinePremiumGreetingEnded:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallMachinePremiumGreetingEnded
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallMachinePremiumGreetingEndedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Machine Premium Greeting Ended
      tags:
      - Callbacks
  callPlaybackEnded:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallPlaybackEnded
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallPlaybackEndedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Playback Ended
      tags:
      - Callbacks
  callPlaybackStarted:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallPlaybackStarted
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallPlaybackStartedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Playback Started
      tags:
      - Callbacks
  callRecordingError:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallRecordingError
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/callRecordingErrorEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Recording Error
      tags:
      - Callbacks
  callRecordingSaved:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallRecordingSaved
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallRecordingSavedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Recording Saved
      tags:
      - Callbacks
  callRecordingTranscriptionSaved:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallRecordingTranscriptionSaved
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/callRecordingTranscriptionSavedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Recording Transcription Saved
      tags:
      - Callbacks
  callReferCompleted:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallReferCompleted
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallReferCompletedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Refer Completed
      tags:
      - Callbacks
  callReferFailed:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallReferFailed
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallReferFailedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Refer Failed
      tags:
      - Callbacks
  callReferStarted:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallReferStarted
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallReferStartedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Refer Started
      tags:
      - Callbacks
  callSiprecFailed:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallSiprecFailed
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallSiprecFailedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Siprec Failed
      tags:
      - Callbacks
  callSiprecStarted:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallSiprecStarted
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallSiprecStartedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Siprec Started
      tags:
      - Callbacks
  callSiprecStopped:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallSiprecStopped
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallSiprecStoppedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Siprec Stopped
      tags:
      - Callbacks
  callSpeakEnded:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallSpeakEnded
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallSpeakEndedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Speak Ended
      tags:
      - Callbacks
  callSpeakStarted:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallSpeakStarted
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallSpeakStartedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Speak Started
      tags:
      - Callbacks
  callStreamingFailed:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallStreamingFailed
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallStreamingFailedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Streaming Failed
      tags:
      - Callbacks
  callStreamingStarted:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallStreamingStarted
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallStreamingStartedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Streaming Started
      tags:
      - Callbacks
  callStreamingStopped:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallStreamingStopped
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallStreamingStoppedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Streaming Stopped
      tags:
      - Callbacks
  callUnhold:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CallUnhold
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallUnholdEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Call Unhold
      tags:
      - Callbacks
  campaignStatusUpdate:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: CampaignStatusUpdate
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CampaignStatusUpdateEvent'
        required: true
      responses:
        '200':
          description: The server must return a HTTP 200, otherwise we will reattempt to deliver the webhook to the failover URL.
      summary: Campaign Status Update
      tags:
      - Callbacks
  conferenceCreated:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: ConferenceCreated
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceCreatedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Conference Created
      tags:
      - Callbacks
  conferenceEnded:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: ConferenceEnded
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceEndedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Conference Ended
      tags:
      - Callbacks
  conferenceFloorChanged:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: ConferenceFloorChanged
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceFloorChangedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Conference Floor Changed
      tags:
      - Callbacks
  conferenceParticipantJoined:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: ConferenceParticipantJoined
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceParticipantJoinedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Conference Participant Joined
      tags:
      - Callbacks
  conferenceParticipantLeft:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: ConferenceParticipantLeft
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceParticipantLeftEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Conference Participant Left
      tags:
      - Callbacks
  conferenceParticipantPlaybackEnded:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: ConferenceParticipantPlaybackEnded
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceParticipantPlaybackEndedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Conference Participant Playback Ended
      tags:
      - Callbacks
  conferenceParticipantPlaybackStarted:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: ConferenceParticipantPlaybackStarted
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceParticipantPlaybackStartedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Conference Participant Playback Started
      tags:
      - Callbacks
  conferenceParticipantSpeakEnded:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: ConferenceParticipantSpeakEnded
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceParticipantSpeakEndedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Conference Participant Speak Ended
      tags:
      - Callbacks
  conferenceParticipantSpeakStarted:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: ConferenceParticipantSpeakStarted
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceParticipantSpeakStartedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Conference Participant Speak Started
      tags:
      - Callbacks
  conferencePlaybackEnded:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: ConferencePlaybackEnded
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferencePlaybackEndedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Conference Playback Ended
      tags:
      - Callbacks
  conferencePlaybackStarted:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: ConferencePlaybackStarted
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferencePlaybackStartedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Conference Playback Started
      tags:
      - Callbacks
  conferenceRecordingSaved:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: ConferenceRecordingSaved
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceRecordingSavedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Conference Recording Saved
      tags:
      - Callbacks
  conferenceSpeakEnded:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: ConferenceSpeakEnded
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceSpeakEndedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Conference Speak Ended
      tags:
      - Callbacks
  conferenceSpeakStarted:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: ConferenceSpeakStarted
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceSpeakStartedEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Conference Speak Started
      tags:
      - Callbacks
  deliveryUpdate:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: DeliveryUpdate
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OutboundMessageEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Delivery Update
      tags:
      - Callbacks
  fax.delivered:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: FaxDelivered
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FaxDelivered'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Fax Delivered
      tags:
      - Callbacks
  fax.failed:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: FaxFailed
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FaxFailed'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Fax Failed
      tags:
      - Callbacks
  fax.media.processed:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: FaxMediaProcessed
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FaxMediaProcessed'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Fax Media Processed
      tags:
      - Callbacks
  fax.queued:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: FaxQueued
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FaxQueued'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Fax Queued
      tags:
      - Callbacks
  fax.sending.started:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: FaxSendingStarted
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FaxSendingStarted'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Fax Sending Started
      tags:
      - Callbacks
  hostedNumberOrderEvent:
    post:
      description: 'Webhook fired when a messaging hosted number order is created, updated, deleted, or progresses through the internal-transfer lifecycle (detected, approval requested, approved, rejected, auto-approved). Inspect `event_type` to distinguish events.


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: HostedNumberOrderEvent
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HostedNumberOrderEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Hosted Number Order Event
      tags:
      - Callbacks
  inboundMessage:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: InboundMessage
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundMessageEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Inbound Message
      tags:
      - Callbacks
  numberOrderStatusUpdate:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: NumberOrderStatusUpdate
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NumberOrderWebhookEvent'
        required: true
      responses:
        '200':
          description: The server must return a HTTP 200, otherwise we will reattempt to deliver the webhook to the failover URL.
      summary: Number Order Status Update
      tags:
      - Callbacks
  replacedLinkClick:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: ReplacedLinkClick
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplacedLinkClickEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Replaced Link Click
      tags:
      - Callbacks
  transcription:
    post:
      description: '


        This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.'
      operationId: Transcription
      parameters:
      - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp
        in: header
        name: telnyx-timestamp
        required: true
        schema:
          description: Unix timestamp for replay attack prevention
          format: int64
          type: integer
        x-webhook-equivalent: webhook-timestamp
      - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature
        in: header
        name: telnyx-signature-ed25519
        required: true
        schema:
          description: Ed25519 signature of timestamp|payload for verification
          type: string
        x-webhook-equivalent: webhook-signature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TranscriptionEvent'
        required: true
      responses:
        '200':
          description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      summary: Transcription
      tags:
      - Callbacks
components:
  schemas:
    programmable-fax_RecordType:
      description: Identifies the type of the resource.
      enum:
      - event
      example: event
      type: string
    CallForkStopped:
      example:
        event_type: call.fork.stopped
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          stream_type: decrypted
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.fork.stopped
          example: call.fork.stopped
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Unique ID for controlling the call.
              example: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            stream_type:
              description: Type of media streamed. It can be either 'raw' or 'decrypted'.
              enum:
              - decrypted
              example: decrypted
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Fork Stopped
      type: object
    ConferenceEnded:
      example:
        event_type: conference.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          occurred_at: '2018-02-02T22:25:27.521Z'
          reason: host_left
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - conference.ended
          example: conference.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: Conference ID that the participant joined.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2018-02-02T22:25:27.521Z'
              format: date-time
              type: string
            reason:
              description: Reason the conference ended.
              enum:
              - all_left
              - host_left
              - time_exceeded
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Conference Ended
      type: object
    CallDeepfakeDetectionErrorEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallDeepfakeDetectionError'
      title: Call Deepfake Detection Error Event
      type: object
    CallUnholdEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallUnhold'
      title: Call Unhold Event
      type: object
    TranscriptionEvent:
      properties:
        data:
          $ref: '#/components/schemas/Transcription'
      title: Transcription Event
      type: object
    CallInitiated:
      example:
        event_type: call.initiated
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          direction: incoming
          from: '+35319605860'
          state: parked
          to: '+35319605860'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.initiated
          example: call.initiated
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_screening_result:
              description: Call screening result.
              example: spam_likely
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            caller_id_name:
              description: Caller id.
              example: '+35319605860'
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_codecs:
              description: The list of comma-separated codecs enabled for the connection.
              example: G722,PCMU,PCMA
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            custom_headers:
              description: Custom headers from sip invite
              example:
              - name: head_1
                value: val_1
              - name: head_2
                value: val_2
              items:
                $ref: '#/components/schemas/CustomSipHeader'
              type: array
            direction:
              description: Whether the call is `incoming` or `outgoing`.
              enum:
              - incoming
              - outgoing
              example: incoming
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            offered_codecs:
              description: The list of comma-separated codecs offered by caller.
              example: G722,PCMU,PCMA
              type: string
            shaken_stir_attestation:
              description: SHAKEN/STIR attestation level.
              example: A
              type: string
            shaken_stir_validated:
              description: Whether attestation was successfully validated or not.
              example: true
              type: boolean
            sip_headers:
              description: User-to-User and Diversion headers from sip invite.
              example:
              - name: User-to-User
                value: '1234'
              - name: User-to-User
                value: <sip:111@192.168.1.1>
              items:
                $ref: '#/components/schemas/SipHeader'
              type: array
            start_time:
              description: ISO 8601 datetime of when the call started.
              example: '2018-02-02T22:25:27.521992Z'
              format: date-time
              type: string
            state:
              description: State received from a command.
              enum:
              - parked
              - bridging
              example: parked
              type: string
            tags:
              description: Array of tags associated to number.
              example:
              - tag-01
              - tag-02
              items:
                type: string
              type: array
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Initiated
      type: object
    HostedNumberOrderEventPayload:
      description: Payload delivered with every messaging_hosted_numbers_orders.* event. `approval_deadline` and `decision` are meaningful only for `internal_transfer_*` events.
      properties:
        approval_deadline:
          description: Unix timestamp (seconds) by which the losing organization must respond before auto-approval. Populated on internal-transfer events once an approval window has been issued.
          format: int64
          type:
          - integer
          - 'null'
        decision:
          description: Approval decision for the internal transfer. Defaults to `pending` for non-internal-transfer events.
          enum:
          - pending
          - approved
          - rejected
          type: string
        numbers:
          items:
            properties:
              status:
                description: Current status of this phone number within the order.
                enum:
                - deleted
                - failed
                - failed_activation
                - failed_carrier_rejected
                - failed_ineligible_carrier
                - failed_number_already_hosted
                - failed_number_not_found
                - failed_ownership_verification
                - failed_timeout
                - ownership_successful
                - pending
                - provisioning
                - successful
                type: string
              value:
                description: Phone number in +E.164 format.
                type: string
                x-format: +E.164
            type: object
          type: array
        order_id:
          description: The ID of the hosted number order.
          format: uuid
          type: string
        order_status:
          description: Current status of the order.
          enum:
          - pending
          - provisioning
          - successful
          - failed
          - deleted
          - carrier_rejected
          - compliance_review_failed
          - incomplete_documentation
          - incorrect_billing_information
          - ineligible_carrier
          - loa_file_invalid
          - loa_file_successful
          type: string
        profile_id:
          description: The messaging profile associated with the order.
          format: uuid
          type: string
        user_id:
          description: The organization that owns the order.
          type: string
      type: object
    CallStreamingStartedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallStreamingStarted'
      title: Streaming Started Event
      type: object
    CallBridged:
      example:
        event_type: call.bridged
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: '+35319605860'
          to: '+35319605860'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.bridged
          example: call.bridged
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Bridged
      type: object
    FaxMediaProcessed:
      example:
        data:
          event_type: fax.media.processed
          id: 95479a2e-b947-470a-a88f-2da6dd07ae0f
          occurred_at: '2020-05-05T13:08:22.039204Z'
          payload:
            client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
            connection_id: '234423'
            direction: outbound
            fax_id: f8338808-3dc6-4f2b-942a-5d1f39255784
            from: '+17733372107'
            original_media_url: http://www.example.com/fax.pdf
            status: media.processed
            to: '+15107882622'
            user_id: 19a75cea-02c6-4b9a-84fa-c9bc8341feb8
          record_type: event
        meta:
          attempt: 1
          delivered_to: https://www.example.com/webhooks
      properties:
        data:
          properties:
            event_type:
              description: The type of event being delivered.
              enum:
              - fax.media.processed
              example: fax.media.processed
              type: string
            id:
              $ref: '#/components/schemas/Id'
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2020-05-05T13:08:22.039204Z'
              format: date-time
              type: string
            payload:
              properties:
                client_state:
                  description: State received from a command.
                  example: aGF2ZSBhIG5pY2UgZGF5ID1d
                  type: string
                connection_id:
                  $ref: '#/components/schemas/ConnectionId'
                direction:
                  $ref: '#/components/schemas/Direction'
                fax_id:
                  $ref: '#/components/schemas/FaxId'
                from:
                  $ref: '#/components/schemas/From'
                media_name:
                  $ref: '#/components/schemas/MediaName'
                original_media_url:
                  $ref: '#/components/schemas/OriginalMediaUrl'
                status:
                  description: The status of the fax.
                  enum:
                  - media.processed
                  example: media.processed
                  type: string
                to:
                  $ref: '#/components/schemas/To'
                user_id:
                  $ref: '#/components/schemas/UserId'
              type: object
            record_type:
              $ref: '#/components/schemas/programmable-fax_RecordType'
          type: object
        meta:
          description: Metadata about the webhook delivery.
          properties:
            attempt:
              description: The delivery attempt number.
              example: 1
              type: integer
            delivered_to:
              description: The URL the webhook was delivered to.
              example: https://www.example.com/webhooks
              format: uri
              type: string
          type: object
      type: object
    CallEnqueuedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallEnqueued'
      title: Call Enqueued Event
      type: object
    CallSiprecFailedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallSiprecFailed'
      title: Siprec Failed Event
      type: object
    CallAIGatherMessageHistoryUpdatedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallAIGatherMessageHistoryUpdated'
      title: Call AI Gather Message History Updated Event
      type: object
    ConferenceSpeakEnded:
      example:
        event_type: conference.speak.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        payload:
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          occurred_at: '2018-02-02T22:25:27.521Z'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - conference.speak.ended
          example: conference.speak.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2018-02-02T22:25:27.521Z'
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Conference Speak Ended
      type: object
    ConferenceParticipantPlaybackEnded:
      example:
        event_type: conference.participant.playback.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          media_url: https://www.example.com/audio.mp3
          occurred_at: '2018-02-02T22:25:27.521Z'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - conference.participant.playback.ended
          example: conference.participant.playback.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Participant's call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            media_name:
              description: The name of the audio media file being played back, if media_name has been used to start.
              example: my_media_uploaded_to_media_storage_api
              type: string
            media_url:
              description: The audio URL being played back, if audio_url has been used to start.
              example: http://example.com/audio.wav
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2018-02-02T22:25:27.521Z'
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Conference Participant Playback Ended
      type: object
    Transcription:
      example:
        event_type: call.transcription
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v2:7subYr8fLrXmaAXm8egeAMpoSJ72J3SGPUuome81-hQuaKRf9b7hKA
          call_leg_id: 5ca81340-5beb-11eb-ae45-02420a0f8b69
          call_session_id: 5ca81eee-5beb-11eb-ba6c-02420a0f8b69
          connection_id: '1240401930086254526'
          transcription_data:
            confidence: 0.977219
            is_final: true
            transcript: hello this is a test speech
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.transcription
          example: call.transcription
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Unique identifier and token for controlling the call.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            transcription_data:
              properties:
                confidence:
                  description: Speech recognition confidence level.
                  example: 0.977219
                  format: float
                  type: number
                is_final:
                  description: When false, it means that this is an interim result.
                  example: true
                  type: boolean
                transcript:
                  description: Recognized text.
                  example: hello this is a test speech
                  type: string
                transcription_track:
                  description: Indicates which leg of the call has been transcribed. This is only available when `transcription_engine` is set to `B`.
                  enum:
                  - inbound
                  - outbound
                  example: inbound
                  type: string
              type: object
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Transcription
      type: object
    SubNumberOrderRegulatoryRequirementWithValue:
      properties:
        field_type:
          enum:
          - textual
          - datetime
          - address
          - document
          example: address
          readOnly: true
          type: string
        field_value:
          description: The value of the requirement, this could be an id to a resource or a string value.
          example: 45f45a04-b4be-4592-95b1-9306b9db2b21
          type: string
        record_type:
          example: phone_number_regulatory_requirement
          readOnly: true
          type: string
        requirement_id:
          description: Unique id for a requirement.
          example: 8ffb3622-7c6b-4ccc-b65f-7a3dc0099576
          format: uuid
          type: string
      type: object
    ConferenceParticipantSpeakStarted:
      example:
        event_type: conference.participant.speak.started
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          occurred_at: '2018-02-02T22:25:27.521Z'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - conference.participant.speak.started
          example: conference.participant.speak.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Participant's call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2018-02-02T22:25:27.521Z'
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Conference Participant Speak Started
      type: object
    ConferenceParticipantSpeakEnded:
      example:
        event_type: conference.participant.speak.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          occurred_at: '2018-02-02T22:25:27.521Z'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - conference.participant.speak.ended
          example: conference.participant.speak.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Participant's call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2018-02-02T22:25:27.521Z'
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Conference Participant Speak Ended
      type: object
    HostedNumberOrder:
      example:
        event_type: messaging_hosted_numbers_orders.internal_transfer_approval_requested
        id: bf6307bd-884d-4c1f-b6ea-c62b8c495d3c
        occurred_at: '2026-04-20T18:10:02.574Z'
        payload:
          approval_deadline: 1714521600
          decision: pending
          numbers:
          - status: pending
            value: '+13125550001'
          order_id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          order_status: pending
          profile_id: d0b1dabe-efdb-4bc8-9dd3-11f0d8b5f5b3
          user_id: b448f9cc-a842-4784-98e9-03c1a5872950
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered. Internal transfer events are only emitted for orders where the numbers are already active on another Telnyx account.
          enum:
          - messaging_hosted_numbers_orders.created
          - messaging_hosted_numbers_orders.updated
          - messaging_hosted_numbers_orders.deleted
          - messaging_hosted_numbers_orders.internal_transfer_detected
          - messaging_hosted_numbers_orders.internal_transfer_approval_requested
          - messaging_hosted_numbers_orders.internal_transfer_approved
          - messaging_hosted_numbers_orders.internal_transfer_rejected
          - messaging_hosted_numbers_orders.internal_transfer_auto_approved
          example: messaging_hosted_numbers_orders.created
          type: string
        id:
          description: Unique identifier for the event.
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 formatted date indicating when the event was generated.
          format: date-time
          type: string
        payload:
          $ref: '#/components/schemas/HostedNumberOrderEventPayload'
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      type: object
    CallMachinePremiumDetectionEndedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallMachinePremiumDetectionEnded'
      title: Call Machine Premium Detection Ended Event
      type: object
    CallForkStartedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallForkStarted'
      title: Call Fork Started Event
      type: object
    ConferenceParticipantSpeakStartedEvent:
      properties:
        data:
          $ref: '#/components/schemas/ConferenceParticipantSpeakStarted'
      title: Conference Participant Speak Started Event
      type: object
    CallHoldEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallHold'
      title: Call Hold Event
      type: object
    callRecordingError:
      example:
        event_type: call.recording.error
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          reason: Internal server error
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.recording.error
          example: call.recording.error
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            reason:
              description: Indication that there was a problem recording the call.
              enum:
              - Failed to authorize with storage using custom credentials
              - Invalid credentials json
              - Unsupported backend
              - Internal server error
              example: Internal server error
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Recording Error
      type: object
    ConferenceRecordingSaved:
      example:
        event_type: conference.recording.saved
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          channels: single
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          format: mp3
          public_recording_urls:
            mp3: http://example.com/recording.mp3
            wav: http://example.com/recording.wav
          recording_ended_at: '2018-02-02T22:20:27.521992Z'
          recording_id: 4577f9a2-cf0e-44f3-ac57-9f95fb03fa47
          recording_started_at: '2021-05-11T10:17:03.692107Z'
          recording_urls:
            mp3: http://example.com/recording.mp3
            wav: http://example.com/recording.wav
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - conference.recording.saved
          example: conference.recording.saved
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Participant's call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            channels:
              description: Whether recording was recorded in `single` or `dual` channel.
              enum:
              - single
              - dual
              example: single
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: ID of the conference that is being recorded.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              format: uuid
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            format:
              description: The audio file format used when storing the call recording. Can be either `mp3` or `wav`.
              enum:
              - wav
              - mp3
              example: mp3
              type: string
            public_recording_urls:
              description: Recording URLs in requested format. The URL is valid for as long as the file exists. For security purposes, this feature is activated on a per request basis.  Please contact customer support with your Account ID to request activation.
              properties:
                mp3:
                  description: Recording URL in requested `mp3` format.
                  example: http://example.com/recording.mp3
                  type:
                  - string
                  - 'null'
                wav:
                  description: Recording URL in requested `wav` format.
                  example: http://example.com/recording.wav
                  type:
                  - string
                  - 'null'
              type: object
            recording_ended_at:
              description: ISO 8601 datetime of when recording ended.
              example: '2018-02-02T22:25:27.521992Z'
              format: date-time
              type: string
            recording_id:
              description: ID of the conference recording.
              example: 4577f9a2-cf0e-44f3-ac57-9f95fb03fa47
              format: uuid
              type: string
            recording_started_at:
              description: ISO 8601 datetime of when recording started.
              example: '2018-02-02T22:20:27.521992Z'
              format: date-time
              type: string
            recording_urls:
              description: Recording URLs in requested format. These URLs are valid for 10 minutes. After 10 minutes, you may retrieve recordings via API using Reports -> Call Recordings documentation, or via Mission Control under Reporting -> Recordings.
              properties:
                mp3:
                  description: Recording URL in requested `mp3` format.
                  example: http://example.com/recording.mp3
                  type:
                  - string
                  - 'null'
                wav:
                  description: Recording URL in requested `wav` format.
                  example: http://example.com/recording.wav
                  type:
                  - string
                  - 'null'
              type: object
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Conference Recording Saved
      type: object
    ConferenceParticipantPlaybackStartedEvent:
      properties:
        data:
          $ref: '#/components/schemas/ConferenceParticipantPlaybackStarted'
      title: Conference Participant Playback Started Event
      type: object
    CallAIGatherPartialResultsEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallAIGatherPartialResults'
      title: Call AI Gather Partial Results Event
      type: object
    ConnectionId:
      description: The ID of the connection used to send the fax.
      example: '234423'
      type: string
    CallStreamingFailedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallStreamingFailed'
      title: Streaming Failed Event
      type: object
    CallPlaybackStartedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallPlaybackStarted'
      title: Call Playback Started Event
      type: object
    CallAnsweredEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallAnswered'
      title: Call Answered Event
      type: object
    CallStreamingStoppedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallStreamingStopped'
      title: Streaming Stopped Event
      type: object
    CallSpeakStarted:
      example:
        event_type: call.speak.started
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.speak.started
          example: call.speak.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Speak Started
      type: object
    CallMachinePremiumGreetingEndedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallMachinePremiumGreetingEnded'
      title: Call Machine Premium Greeting Ended Event
      type: object
    ReplacedLinkClick:
      example:
        message_id: 7ee4241c-f127-47e5-9c34-3aac291f8058
        record_type: link_clicked
        time_clicked: '2019-04-01T14:45:45.450Z'
        to: '18445550001'
        url: https://telnyx.com
      properties:
        message_id:
          description: The message ID associated with the clicked link.
          format: uuid
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: link_clicked
          type: string
        time_clicked:
          description: ISO 8601 formatted date indicating when the message request was received.
          format: date-time
          type: string
        to:
          description: Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).
          type: string
          x-format: address
        url:
          description: The original link that was sent in the message.
          example: link_clicked
          type: string
      type: object
    ReplacedLinkClickEvent:
      properties:
        data:
          $ref: '#/components/schemas/ReplacedLinkClick'
      type: object
    messaging_Error:
      properties:
        code:
          type: string
          x-format: integer
        detail:
          type: string
        meta:
          type: object
        source:
          properties:
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              format: json-pointer
              type: string
          type: object
        title:
          type: string
      required:
      - code
      - title
    CallDeepfakeDetectionError:
      example:
        event_type: call.deepfake_detection.error
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          error_message: detection_timeout
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.deepfake_detection.error
          example: call.deepfake_detection.error
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              format: uuid
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              format: uuid
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type:
              - string
              - 'null'
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            error_message:
              description: The error that occurred. 'detection_timeout' = no DFD response received, 'rtp_timeout' = no RTP audio received, 'dfd_connection_error'/'dfd_stream_error' = service connectivity issues.
              enum:
              - detection_timeout
              - rtp_timeout
              - dfd_connection_error
              - dfd_stream_error
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Deepfake Detection Error
      type: object
    CallCostPart:
      properties:
        billed_duration_secs:
          description: The billed duration in seconds for this part of the call.
          example: 180
          type: integer
        call_part:
          description: The product component this cost applies to. Values are determined by the billing system (e.g. sip-trunking, call-control, call-recording). Not a fixed set — new values may appear as products evolve.
          example: call-control
          type: string
        cost:
          description: The cost for this part of the call.
          example: '0.0018'
          type: string
        currency:
          description: The currency of the cost.
          example: USD
          type: string
        rate:
          description: The per-minute rate applied.
          example: '0.00180'
          type: string
      title: Call Cost Part
      type: object
    PhoneNumber:
      example:
        bundle_id: bc8e4d67-33a0-4cbb-af74-7b58f05bd474
        id: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
        phone_number: '+19705555098'
        record_type: number_order_phone_number
        regulatory_requirements:
        - field_type: address
          field_value: 45f45a04-b4be-4592-95b1-9306b9db2b21
          record_type: phone_number_regulatory_requirement
          requirement_id: 8ffb3622-7c6b-4ccc-b65f-7a3dc0099576
        requirements_met: true
        status: success
      properties:
        bundle_id:
          example: bc8e4d67-33a0-4cbb-af74-7b58f05bd494
          format: uuid
          readOnly: true
          type: string
        country_code:
          description: Country code of the phone number
          example: US
          readOnly: true
          type: string
        country_iso_alpha2:
          description: The ISO 3166-1 alpha-2 country code of the phone number.
          example: US
          readOnly: true
          type: string
        id:
          example: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
          format: uuid
          readOnly: true
          type: string
        phone_number:
          example: '+19705555098'
          type: string
        phone_number_type:
          description: Phone number type
          enum:
          - local
          - mobile
          - national
          - shared_cost
          - toll_free
          readOnly: true
          type: string
        record_type:
          example: number_order_phone_number
          readOnly: true
          type: string
        regulatory_requirements:
          items:
            $ref: '#/components/schemas/SubNumberOrderRegulatoryRequirementWithValue'
          type: array
        requirements_met:
          description: True if all requirements are met for a phone number, false otherwise.
          example: true
          readOnly: true
          type: boolean
        requirements_status:
          description: Status of document requirements (if applicable)
          enum:
          - pending
          - approved
          - cancelled
          - deleted
          - requirement-info-exception
          - requirement-info-pending
          - requirement-info-under-review
          readOnly: true
          type: string
        status:
          description: The status of the phone number in the order.
          enum:
          - pending
          - success
          - failure
          readOnly: true
          type: string
      type: object
    FaxId:
      description: Identifies the fax.
      example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
      format: uuid
      type: string
    CallHold:
      example:
        event_type: call.hold
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: '+35319605860'
          to: '+35319605860'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.hold
          example: call.hold
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Hold
      type: object
    ConferencePlaybackEnded:
      example:
        event_type: conference.playback.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        payload:
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          media_url: https://www.example.com/audio.mp3
          occurred_at: '2018-02-02T22:25:27.521Z'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - conference.playback.ended
          example: conference.playback.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            media_name:
              description: The name of the audio media file being played back, if media_name has been used to start.
              example: my_media_uploaded_to_media_storage_api
              type: string
            media_url:
              description: The audio URL being played back, if audio_url has been used to start.
              example: http://example.com/audio.wav
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2018-02-02T22:25:27.521Z'
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Conference Playback Ended
      type: object
    callRecordingTranscriptionSavedEvent:
      properties:
        data:
          $ref: '#/components/schemas/callRecordingTranscriptionSaved'
      title: Call Recording Transcription Saved Event
      type: object
    CallSiprecStarted:
      example:
        event_type: siprec.started
        id: 7d743d69-f7e8-4761-b7d4-8cacf9d3c031
        occurred_at: '2021-12-15T14:06:32.059436Z'
        payload:
          call_control_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          call_leg_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          call_session_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - siprec.started
          example: siprec.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2021-12-15T14:06:32.059436Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Siprec Started
      type: object
    CallUnhold:
      example:
        event_type: call.unhold
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: '+35319605860'
          to: '+35319605860'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.unhold
          example: call.unhold
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Unhold
      type: object
    UserId:
      description: Identifier of the user to whom the fax belongs
      example: a7f7c54a-4df3-4bca-a65a-3da1ecc777f0
      format: uuid
      type: string
    callRecordingErrorEvent:
      properties:
        data:
          $ref: '#/components/schemas/callRecordingError'
      title: Call Recording Error Event
      type: object
    ConferenceRecordingSavedEvent:
      properties:
        data:
          $ref: '#/components/schemas/ConferenceRecordingSaved'
      title: Conference Recording Saved Event
      type: object
    OriginalMediaUrl:
      description: The original URL to the PDF used for the fax's media. If media_name was supplied, this is omitted
      example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
      type: string
    ConferenceFloorChangedEvent:
      example:
        event_type: conference.floor.changed
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          occurred_at: '2018-02-02T22:25:27.521Z'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - conference.floor.changed
          example: conference.floor.changed
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Call Control ID of the new speaker.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: Call Leg ID of the new speaker.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: Call Session ID of the new speaker.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: Conference ID that had a speaker change event.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2018-02-02T22:25:27.521Z'
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Conference Floor Changed
      type: object
    CallReferCompletedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallReferCompleted'
      title: Call Refer Completed Event
      type: object
    ConferenceParticipantLeftEvent:
      properties:
        data:
          $ref: '#/components/schemas/ConferenceParticipantLeft'
      title: Conference Participant Left Event
      type: object
    InboundMessage:
      example:
        event_type: message.received
        id: bf6307bd-884d-4c1f-b6ea-c62b8c495d3c
        occurred_at: '2019-01-23T18:10:02.574Z'
        payload:
          cc: []
          completed_at: null
          cost:
            amount: '0.0051'
            currency: USD
          cost_breakdown:
            carrier_fee:
              amount: '0.00305'
              currency: USD
            rate:
              amount: '0.00205'
              currency: USD
          direction: inbound
          encoding: GSM-7
          errors: []
          from:
            carrier: T-MOBILE USA, INC.
            line_type: Wireless
            phone_number: '+18665550001'
          id: 7ee4241c-f127-47e5-9c34-3aac291f8058
          media: []
          messaging_profile_id: 0f512bda-ae1e-4597-8e11-e5f5686b97d3
          organization_id: b448f9cc-a842-4784-98e9-03c1a5872950
          parts: 1
          received_at: '2019-01-23T18:10:02.574Z'
          record_type: message
          sent_at: null
          subject: From Telnyx!
          tags:
          - Greetings
          tcr_campaign_billable: true
          tcr_campaign_id: TCPA3X7
          tcr_campaign_registered: REGISTERED
          text: Hello, World!
          to:
          - carrier: TELNYX LLC
            line_type: VoIP
            phone_number: '+18445550001'
            status: delivered
          type: SMS
          valid_until: null
          webhook_failover_url: https://backup.example.com/hooks
          webhook_url: https://www.example.com/hooks
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - message.received
          example: message.received
          type: string
        id:
          description: Identifies the type of resource.
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          format: date-time
          type: string
        payload:
          $ref: '#/components/schemas/InboundMessagePayload'
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      type: object
    InboundMessagePayload:
      example:
        cc: []
        completed_at: null
        cost:
          amount: '0.0051'
          currency: USD
        cost_breakdown:
          carrier_fee:
            amount: '0.00305'
            currency: USD
          rate:
            amount: '0.00205'
            currency: USD
        direction: inbound
        encoding: GSM-7
        errors: []
        from:
          carrier: T-MOBILE USA, INC.
          line_type: Wireless
          phone_number: '+18665550001'
          status: delivered
        id: 7ee4241c-f127-47e5-9c34-3aac291f8058
        media: []
        messaging_profile_id: 0f512bda-ae1e-4597-8e11-e5f5686b97d3
        organization_id: b448f9cc-a842-4784-98e9-03c1a5872950
        parts: 1
        received_at: '2019-01-23T18:10:02.574Z'
        record_type: message
        sent_at: null
        subject: From Telnyx!
        tags:
        - Greetings
        tcr_campaign_billable: true
        tcr_campaign_id: TCPA3X7
        tcr_campaign_registered: REGISTERED
        text: Hello, World!
        to:
        - carrier: TELNYX LLC
          line_type: VoIP
          phone_number: '+18445550001'
          status: delivered
        type: SMS
        valid_until: null
        webhook_failover_url: https://backup.example.com/hooks
        webhook_url: https://www.example.com/hooks
      properties:
        cc:
          items:
            properties:
              carrier:
                description: The carrier of the receiver.
                type: string
              line_type:
                description: The line-type of the receiver.
                enum:
                - Wireline
                - Wireless
                - VoWiFi
                - VoIP
                - Pre-Paid Wireless
                - ''
                type: string
              phone_number:
                description: Receiving address (+E.164 formatted phone number or short code).
                type: string
                x-format: address
              status:
                enum:
                - queued
                - sending
                - sent
                - delivered
                - sending_failed
                - delivery_failed
                - delivery_unconfirmed
                type: string
            type: object
          type: array
        completed_at:
          description: Not used for inbound messages.
          format: date-time
          type:
          - string
          - 'null'
        cost:
          properties:
            amount:
              description: The amount deducted from your account.
              type: string
              x-format: decimal
            currency:
              description: The ISO 4217 currency identifier.
              type: string
              x-format: iso4217
          type:
          - object
          - 'null'
        cost_breakdown:
          description: Detailed breakdown of the message cost components.
          properties:
            carrier_fee:
              properties:
                amount:
                  description: The carrier fee amount.
                  type: string
                  x-format: decimal
                currency:
                  description: The ISO 4217 currency identifier.
                  type: string
                  x-format: iso4217
              type: object
            rate:
              properties:
                amount:
                  description: The rate amount applied.
                  type: string
                  x-format: decimal
                currency:
                  description: The ISO 4217 currency identifier.
                  type: string
                  x-format: iso4217
              type: object
          type:
          - object
          - 'null'
        direction:
          description: The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you.
          enum:
          - inbound
          example: inbound
          type: string
        encoding:
          description: Encoding scheme used for the message body.
          type: string
        errors:
          description: These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.
          items:
            $ref: '#/components/schemas/messaging_Error'
          type: array
        from:
          properties:
            carrier:
              description: The carrier of the sender.
              type: string
            line_type:
              description: The line-type of the sender.
              enum:
              - Wireline
              - Wireless
              - VoWiFi
              - VoIP
              - Pre-Paid Wireless
              - ''
              type: string
            phone_number:
              description: Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).
              type: string
              x-format: address
            status:
              enum:
              - received
              - delivered
              type: string
          type: object
        id:
          description: Identifies the type of resource.
          format: uuid
          type: string
        media:
          items:
            properties:
              content_type:
                description: The MIME type of the requested media.
                type: string
                x-format: mime-type
              hash_sha256:
                description: The SHA256 hash of the requested media.
                maxLength: 32
                minLength: 32
                type: string
              size:
                description: The size of the requested media.
                type: integer
              url:
                description: The url of the media requested to be sent.
                format: url
                type: string
            type: object
          type: array
        messaging_profile_id:
          description: Unique identifier for a messaging profile.
          type: string
        organization_id:
          description: Unique identifier for a messaging profile.
          type: string
        parts:
          description: Number of parts into which the message's body must be split.
          maximum: 10
          minimum: 1
          type: integer
        received_at:
          description: ISO 8601 formatted date indicating when the message request was received.
          format: date-time
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
          - message
          example: message
          type: string
        sent_at:
          description: Not used for inbound messages.
          format: date-time
          type:
          - string
          - 'null'
        subject:
          description: Message subject.
          type:
          - string
          - 'null'
        tags:
          description: Tags associated with the resource.
          items:
            type: string
          type: array
        tcr_campaign_billable:
          description: Indicates whether the TCR campaign is billable.
          type: boolean
        tcr_campaign_id:
          description: The Campaign Registry (TCR) campaign ID associated with the message.
          type:
          - string
          - 'null'
        tcr_campaign_registered:
          description: The registration status of the TCR campaign.
          example: REGISTERED
          type:
          - string
          - 'null'
        text:
          description: 'Message body (i.e., content) as a non-empty string.


            **Required for SMS**'
          type: string
        to:
          items:
            properties:
              carrier:
                description: The carrier of the receiver.
                type: string
              line_type:
                description: The line-type of the receiver.
                enum:
                - Wireline
                - Wireless
                - VoWiFi
                - VoIP
                - Pre-Paid Wireless
                - ''
                type: string
              phone_number:
                description: Receiving address (+E.164 formatted phone number or short code).
                type: string
                x-format: address
              status:
                enum:
                - queued
                - sending
                - sent
                - delivered
                - sending_failed
                - delivery_failed
                - delivery_unconfirmed
                - webhook_delivered
                type: string
            type: object
          type: array
        type:
          description: The type of message. This value can be either 'sms' or 'mms'.
          enum:
          - SMS
          - MMS
          type: string
        valid_until:
          description: Not used for inbound messages.
          format: date-time
          type:
          - string
          - 'null'
        webhook_failover_url:
          description: The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.
          format: url
          type:
          - string
          - 'null'
        webhook_url:
          description: The URL where webhooks related to this message will be sent.
          format: url
          type:
          - string
          - 'null'
    CallGatherEnded:
      example:
        event_type: call.gather.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          digits: '123'
          from: '+35319605860'
          status: valid
          to: '+35319605860'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.gather.ended
          example: call.gather.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            digits:
              description: The received DTMF digit or symbol.
              example: '5503'
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            status:
              description: Reflects how command ended.
              enum:
              - valid
              - invalid
              - call_hangup
              - cancelled
              - cancelled_amd
              - timeout
              example: valid
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Gather Ended
      type: object
    ConferenceParticipantJoinedEvent:
      properties:
        data:
          $ref: '#/components/schemas/ConferenceParticipantJoined'
      title: Conference Participant Joined Event
      type: object
    MediaName:
      description: The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. media_name and media_url/contents can't be submitted together.
      example: my_media_uploaded_to_media_storage_api
      type: string
    CallSpeakEnded:
      example:
        event_type: call.speak.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          status: completed
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.speak.ended
          example: call.speak.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            status:
              description: Reflects how the command ended.
              enum:
              - completed
              - call_hangup
              - cancelled_amd
              example: completed
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Speak Ended
      type: object
    OutboundMessageEvent:
      properties:
        data:
          $ref: '#/components/schemas/OutboundMessage'
        meta:
          properties:
            attempt:
              description: Number of attempts to deliver the webhook event.
              example: 1
              type: integer
            delivered_to:
              description: The webhook URL the event was delivered to.
              example: https://www.example.com/hooks
              format: url
              type: string
          type: object
      type: object
    callConversationInsightsGeneratedEvent:
      properties:
        data:
          $ref: '#/components/schemas/callConversationInsightsGenerated'
      title: Call Conversation Insights Generated Event
      type: object
    ConferenceParticipantPlaybackEndedEvent:
      properties:
        data:
          $ref: '#/components/schemas/ConferenceParticipantPlaybackEnded'
      title: Conference Participant Playback Ended Event
      type: object
    FaxSendingStarted:
      example:
        data:
          event_type: fax.sending.started
          id: 95479a2e-b947-470a-a88f-2da6dd07ae0f
          occurred_at: '2020-05-05T13:08:22.039204Z'
          payload:
            client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
            connection_id: '234423'
            direction: outbound
            fax_id: f8338808-3dc6-4f2b-942a-5d1f39255784
            from: '+17733372107'
            original_media_url: http://www.example.com/fax.pdf
            status: sending
            to: '+15107882622'
            user_id: 19a75cea-02c6-4b9a-84fa-c9bc8341feb8
          record_type: event
        meta:
          attempt: 1
          delivered_to: https://www.example.com/webhooks
      properties:
        data:
          properties:
            event_type:
              description: The type of event being delivered.
              enum:
              - fax.sending.started
              example: fax.sending.started
              type: string
            id:
              $ref: '#/components/schemas/Id'
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2020-05-05T13:08:22.039204Z'
              format: date-time
              type: string
            payload:
              properties:
                client_state:
                  description: State received from a command.
                  example: aGF2ZSBhIG5pY2UgZGF5ID1d
                  type: string
                connection_id:
                  $ref: '#/components/schemas/ConnectionId'
                direction:
                  $ref: '#/components/schemas/Direction'
                fax_id:
                  $ref: '#/components/schemas/FaxId'
                from:
                  $ref: '#/components/schemas/From'
                media_name:
                  $ref: '#/components/schemas/MediaName'
                original_media_url:
                  $ref: '#/components/schemas/OriginalMediaUrl'
                status:
                  description: The status of the fax.
                  enum:
                  - sending
                  example: sending
                  type: string
                to:
                  $ref: '#/components/schemas/To'
                user_id:
                  $ref: '#/components/schemas/UserId'
              type: object
            record_type:
              $ref: '#/components/schemas/programmable-fax_RecordType'
          type: object
        meta:
          description: Metadata about the webhook delivery.
          properties:
            attempt:
              description: The delivery attempt number.
              example: 1
              type: integer
            delivered_to:
              description: The URL the webhook was delivered to.
              example: https://www.example.com/webhooks
              format: uri
              type: string
          type: object
      type: object
    To:
      description: The phone number, in E.164 format, the fax will be sent to or SIP URI
      example: '+13127367276'
      type: string
    CallMachineDetectionEnded:
      example:
        event_type: call.machine.detection.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: '+35319605860'
          result: human
          to: '+35319605860'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.machine.detection.ended
          example: call.machine.detection.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            result:
              description: Answering machine detection result.
              enum:
              - human
              - machine
              - not_sure
              example: machine
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Machine Detection Ended
      type: object
    CallAIGatherEndedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallAIGatherEnded'
      title: Call AI Gather Ended Event
      type: object
    CallLeftQueueEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallLeftQueue'
      title: Call Left Queue Event
      type: object
    CallHangup:
      example:
        event_type: call.hangup
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_quality_stats:
            inbound:
              jitter_max_variance: '2.74'
              jitter_packet_count: '0'
              mos: '4.50'
              packet_count: '591'
              skip_packet_count: '9'
            outbound:
              packet_count: '0'
              skip_packet_count: '0'
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: '+35319605860'
          hangup_cause: call_rejected
          hangup_source: caller
          sip_hangup_cause: '603'
          start_time: '2018-02-02T22:20:27.521992Z'
          state: hangup
          to: '+35319605860'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.hangup
          example: call.hangup
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_quality_stats:
              description: Call quality statistics aggregated from the CHANNEL_HANGUP_COMPLETE event. Only includes metrics that are available (filters out nil values). Returns nil if no metrics are available.
              example:
                inbound:
                  jitter_max_variance: '2.74'
                  jitter_packet_count: '0'
                  mos: '4.50'
                  packet_count: '591'
                  skip_packet_count: '9'
                outbound:
                  packet_count: '0'
                  skip_packet_count: '0'
              properties:
                inbound:
                  description: Inbound call quality statistics.
                  properties:
                    jitter_max_variance:
                      description: Maximum jitter variance for inbound audio.
                      example: '2.74'
                      type: string
                    jitter_packet_count:
                      description: Number of packets used for jitter calculation on inbound audio.
                      example: '0'
                      type: string
                    mos:
                      description: Mean Opinion Score (MOS) for inbound audio quality.
                      example: '4.50'
                      type: string
                    packet_count:
                      description: Total number of inbound audio packets.
                      example: '591'
                      type: string
                    skip_packet_count:
                      description: Number of skipped inbound packets (packet loss).
                      example: '9'
                      type: string
                  type: object
                outbound:
                  description: Outbound call quality statistics.
                  properties:
                    packet_count:
                      description: Total number of outbound audio packets.
                      example: '0'
                      type: string
                    skip_packet_count:
                      description: Number of skipped outbound packets (packet loss).
                      example: '0'
                      type: string
                  type: object
              type:
              - object
              - 'null'
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            custom_headers:
              description: Custom headers set on answer command
              example:
              - name: head_1
                value: val_1
              - name: head_2
                value: val_2
              items:
                $ref: '#/components/schemas/CustomSipHeader'
              type: array
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            hangup_cause:
              description: The reason the call was ended (`call_rejected`, `normal_clearing`, `originator_cancel`, `timeout`, `time_limit`, `user_busy`, `not_found`, `no_answer` or `unspecified`).
              enum:
              - call_rejected
              - normal_clearing
              - originator_cancel
              - timeout
              - time_limit
              - user_busy
              - not_found
              - no_answer
              - unspecified
              example: call_rejected
              type: string
            hangup_source:
              description: The party who ended the call (`callee`, `caller`, `unknown`).
              enum:
              - caller
              - callee
              - unknown
              example: caller
              type: string
            sip_hangup_cause:
              description: The reason the call was ended (SIP response code). If the SIP response is unavailable (in inbound calls for example) this is set to `unspecified`.
              example: '603'
              type: string
            sip_headers:
              description: User-to-User and Diversion headers from sip invite.
              example:
              - name: User-to-User
                value: '1234'
              - name: User-to-User
                value: <sip:111@192.168.1.1>
              items:
                $ref: '#/components/schemas/SipHeader'
              type: array
            start_time:
              description: ISO 8601 datetime of when the call started.
              example: '2018-02-02T22:20:27.521992Z'
              format: date-time
              type: string
            state:
              description: State received from a command.
              enum:
              - hangup
              example: hangup
              type: string
            tags:
              description: Array of tags associated to number.
              example:
              - tag-01
              - tag-02
              items:
                type: string
              type: array
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Hangup
      type: object
    CallGatherEndedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallGatherEnded'
      title: Call Gather Ended Event
      type: object
    ConferenceParticipantSpeakEndedEvent:
      properties:
        data:
          $ref: '#/components/schemas/ConferenceParticipantSpeakEnded'
      title: Conference Participant Speak Ended Event
      type: object
    ConferenceSpeakEndedEvent:
      properties:
        data:
          $ref: '#/components/schemas/ConferenceSpeakEnded'
      title: Conference Speak Ended Event
      type: object
    NumberOrderWithPhoneNumbers:
      properties:
        billing_group_id:
          description: Identifies the messaging profile associated with the phone number.
          example: abc85f64-5717-4562-b3fc-2c9600
          type: string
        connection_id:
          description: Identifies the connection associated with this phone number.
          example: '346789098765567'
          type: string
        created_at:
          description: An ISO 8901 datetime string denoting when the number order was created.
          example: '2018-01-01T00:00:00.000000Z'
          format: date-time
          readOnly: true
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        id:
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          readOnly: true
          type: string
        messaging_profile_id:
          description: Identifies the messaging profile associated with the phone number.
          example: abc85f64-5717-4562-b3fc-2c9600
          type: string
        phone_numbers:
          items:
            $ref: '#/components/schemas/PhoneNumber'
            description: The unique phone numbers given as arguments in the job creation.
          type: array
        phone_numbers_count:
          description: The count of phone numbers in the number order.
          example: 1
          readOnly: true
          type: integer
        record_type:
          example: number_order
          readOnly: true
          type: string
        requirements_met:
          description: True if all requirements are met for every phone number, false otherwise.
          example: true
          readOnly: true
          type: boolean
        status:
          description: The status of the order.
          enum:
          - pending
          - success
          - failure
          readOnly: true
          type: string
        sub_number_orders_ids:
          items:
            type: string
          type: array
        updated_at:
          description: An ISO 8901 datetime string for when the number order was updated.
          example: '2018-01-01T00:00:00.000000Z'
          format: date-time
          readOnly: true
          type: string
      title: NumberOrder
      type: object
    CallDtmfReceivedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallDtmfReceived'
      title: Call DTMF Received Event
      type: object
    ConferenceParticipantLeft:
      example:
        event_type: conference.participant.left
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - conference.participant.left
          example: conference.participant.left
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: Conference ID that the participant joined.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Conference Participant Left
      type: object
    CallReferFailedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallReferFailed'
      title: Call Refer Failed Event
      type: object
    CallSiprecFailed:
      example:
        event_type: siprec.failed
        id: 25dc3731-e51e-4927-a50d-a61cc25984b1
        occurred_at: '2021-12-15T14:11:24.613295Z'
        payload:
          call_control_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          call_leg_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          call_session_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          failure_cause: no_answer
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - siprec.failed
          example: siprec.failed
          type: string
        id:
          description: Identifies the type of resource.
          example: 25dc3731-e51e-4927-a50d-a61cc25984b1
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2021-12-15T14:11:24.613295Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            failure_cause:
              description: Q850 reason why siprec session failed.
              example: no_answer
              type: string
          type: object
        record_type:
          description: Identifies the resource.
          enum:
          - event
          example: event
          type: string
      title: Siprec Failed
      type: object
    NumberOrderWebhookEvent:
      properties:
        data:
          properties:
            event_type:
              description: The type of event being sent
              example: number_order.complete
              type: string
            id:
              description: Unique identifier for the event
              example: d578b093-a0e7-4b64-b0d3-6b689a6ff170
              format: uuid
              type: string
            occurred_at:
              description: ISO 8601 timestamp of when the event occurred
              example: '2025-08-22T16:23:54.496464Z'
              format: date-time
              type: string
            payload:
              $ref: '#/components/schemas/NumberOrderWithPhoneNumbers'
            record_type:
              description: Type of record
              example: event
              type: string
          required:
          - event_type
          - id
          - occurred_at
          - payload
          - record_type
          type: object
        meta:
          properties:
            attempt:
              description: Webhook delivery attempt number
              example: 1
              type: integer
            delivered_to:
              description: URL where the webhook was delivered
              example: https://sample-api.com/webhook
              format: uri
              type: string
          required:
          - attempt
          - delivered_to
          type: object
      required:
      - data
      - meta
      title: Number Order Event
      type: object
    CallPlaybackEndedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallPlaybackEnded'
      title: Call Playback Ended Event
      type: object
    CallMachineGreetingEndedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallMachineGreetingEnded'
      title: Call Machine Greeting Ended Event
      type: object
    CallAIGatherMessageHistoryUpdated:
      example:
        event_type: call.ai_gather.message_history_updated
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: '+35319605860'
          message_history:
          - content: Hello, can you tell me your age and where you live?
            role: assistant
          - content: Hello, I'm 29 and I live in Paris?
            role: user
          to: '+35319605860'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.ai_gather.message_history_updated
          example: call.ai_gather.message_history_updated
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Telnyx connection ID used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            message_history:
              description: The history of the messages exchanged during the AI gather
              items:
                properties:
                  content:
                    description: The content of the message
                    example: Hello, I'm 29 and I live in Paris.
                    type: string
                  role:
                    description: The role of the message sender
                    enum:
                    - assistant
                    - user
                    example: user
                    type: string
                type: object
              type: array
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call AI Gather Message History Updated
      type: object
    ConferenceSpeakStarted:
      example:
        event_type: conference.speak.started
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        payload:
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          occurred_at: '2018-02-02T22:25:27.521Z'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - conference.speak.started
          example: conference.speak.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2018-02-02T22:25:27.521Z'
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Conference Speak Started
      type: object
    CallBridgedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallBridged'
      title: Call Bridged Event
      type: object
    InboundMessageEvent:
      properties:
        data:
          $ref: '#/components/schemas/InboundMessage'
      type: object
    ConferencePlaybackStartedEvent:
      properties:
        data:
          $ref: '#/components/schemas/ConferencePlaybackStarted'
      title: Conference Playback Started Event
      type: object
    CallAIGatherPartialResults:
      example:
        event_type: call.ai_gather.partial_results
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: '+35319605860'
          message_history:
          - content: Hello, can you tell me your age and where you live?
            role: assistant
          - content: Hello, I'm 29 and I live in Paris?
            role: user
          partial_results:
            age: 29
            city: Paris
          to: '+35319605860'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.ai_gather.partial_results
          example: call.ai_gather.partial_results
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Telnyx connection ID used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            message_history:
              description: The history of the messages exchanged during the AI gather
              items:
                properties:
                  content:
                    description: The content of the message
                    example: Hello, I'm 29 and I live in Paris.
                    type: string
                  role:
                    description: The role of the message sender
                    enum:
                    - assistant
                    - user
                    example: user
                    type: string
                type: object
              type: array
            partial_results:
              description: The partial result of the AI gather, its type depends of the `parameters` provided in the command
              example:
                age: 29
                city: Paris
              type: object
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call AI Gather Partial Results
      type: object
    From:
      description: The phone number, in E.164 format, the fax will be sent from.
      example: '+13125790015'
      type: string
    CallLeftQueue:
      example:
        event_type: call.dequeued
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          queue: support
          queue_position: 3
          reason: leave
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.dequeued
          example: call.dequeued
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            queue:
              description: The name of the queue
              example: support
              type: string
            queue_position:
              description: Last position of the call in the queue.
              example: 7
              type: integer
            reason:
              description: The reason for leaving the queue
              enum:
              - bridged
              - bridging-in-process
              - hangup
              - leave
              - timeout
              example: bridged
              type: string
            wait_time_secs:
              description: Time call spent in the queue in seconds.
              example: 60
              type: integer
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Left Queue
      type: object
    OutboundMessage:
      example:
        event_type: message.sent
        id: 86f58db9-0fe3-4adc-9d1f-46e66e6e9323
        occurred_at: '2019-01-23T18:10:02.574Z'
        payload:
          cc: []
          completed_at: null
          cost:
            amount: '0.0051'
            currency: USD
          cost_breakdown:
            carrier_fee:
              amount: '0.00305'
              currency: USD
            rate:
              amount: '0.00205'
              currency: USD
          direction: outbound
          encoding: GSM-7
          errors: []
          from:
            carrier: TELNYX LLC
            line_type: VoIP
            phone_number: '+18445550001'
          id: 40385f64-5717-4562-b3fc-2c963f66afa6
          media:
          - content_type: null
            sha256: null
            size: null
            url: https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png
          messaging_profile_id: 4000eba1-a0c0-4563-9925-b25e842a7cb6
          organization_id: b448f9cc-a842-4784-98e9-03c1a5872950
          parts: 1
          received_at: '2019-01-23T18:10:02.574Z'
          record_type: message
          sent_at: null
          subject: From Telnyx!
          tags:
          - Greetings
          tcr_campaign_billable: true
          tcr_campaign_id: TCPA3X7
          tcr_campaign_registered: REGISTERED
          text: Hello, World!
          to:
          - carrier: T-MOBILE USA, INC.
            line_type: Wireless
            phone_number: '+18665550001'
            status: queued
          type: MMS
          valid_until: null
          webhook_failover_url: https://backup.example.com/hooks
          webhook_url: https://www.example.com/hooks
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - message.sent
          - message.finalized
          example: message.sent
          type: string
        id:
          description: Identifies the type of resource.
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          format: date-time
          type: string
        payload:
          $ref: '#/components/schemas/OutboundMessagePayload'
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
    CallPlaybackEnded:
      example:
        event_type: call.playback.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          media_name: my_media_uploaded_to_media_storage_api
          overlay: false
          status: completed
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.playback.ended
          example: call.playback.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            media_name:
              description: The name of the audio media file being played back, if media_name has been used to start.
              example: my_media_uploaded_to_media_storage_api
              type: string
            media_url:
              description: The audio URL being played back, if audio_url has been used to start.
              example: http://example.com/audio.wav
              type: string
            overlay:
              description: Whether the stopped audio was in overlay mode or not.
              example: false
              type: boolean
            status:
              description: Reflects how command ended.
              enum:
              - file_not_found
              - call_hangup
              - unknown
              - cancelled
              - cancelled_amd
              - completed
              - failed
              example: completed
              type: string
            status_detail:
              description: Provides details in case of failure.
              example: Received curl error 22 HTTP error code 404 trying to fetch http://mediaurl.com.
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Playback Ended
      type: object
    CustomSipHeader:
      example:
        name: head_1
        value: val_1
      properties:
        name:
          description: The name of the header to add.
          example: head_1
          type: string
        value:
          description: The value of the header.
          example: val_1
          type: string
      required:
      - name
      - value
      title: Custom SIP Header
      type: object
    callConversationEnded:
      example:
        created_at: '2025-05-29T13:35:38.927621Z'
        event_type: call.conversation.ended
        id: eb8775a6-634f-48b0-b177-d5465a8a8e9f
        occurred_at: '2025-05-29T13:35:38.817785Z'
        payload:
          assistant_id: assistant-d9082b56-ba2d-4ad1-a50c-58661eb1463d
          call_control_id: v3:HDR1vQHx697hpP9xZ0bhlbUOWPFPDtPcxw-nuSMuC6mGVpb0euoklQ
          call_leg_id: cc29cce6-3c91-11f0-a8e5-02420aef3d20
          call_session_id: cc29c8d6-3c91-11f0-aa7c-02420aef3d20
          calling_party_type: sip
          client_state: g3QAAAACbQAAAAtkYXRhX2NlbnRlcm0AAAADY2gxbQAAAApkZXBsb3ltZW50bQAAAARiYXNl
          connection_id: '2694492062593582591'
          conversation_id: 0424805b-adc1-4ff8-9f95-e1de6883ecbe
          duration_sec: 3
          from: '+13124287921'
          llm_model: openai/gpt-4o
          stt_model: distil-whisper/distil-large-v2
          to: jamesw@assistant-d9082b56-ba2d-4ad1-a50c-58661eb1463d.sip.telnyx.com
          tts_model_id: Natural
          tts_provider: telnyx
          tts_voice_id: Marissa
        record_type: event
      properties:
        created_at:
          description: Timestamp when the event was created in the system.
          example: '2025-05-29T13:35:38.927621Z'
          format: date-time
          type: string
        event_type:
          description: The type of event being delivered.
          enum:
          - call.conversation.ended
          example: call.conversation.ended
          type: string
        id:
          description: Unique identifier for the event.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            assistant_id:
              description: Unique identifier of the assistant involved in the call.
              example: assistant-d9082b56-ba2d-4ad1-a50c-58661eb1463d
              type: string
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call leg.
              example: cc29cce6-3c91-11f0-a8e5-02420aef3d20
              type: string
            call_session_id:
              description: ID that is unique to the call session (group of related call legs).
              example: cc29c8d6-3c91-11f0-aa7c-02420aef3d20
              type: string
            calling_party_type:
              description: The type of calling party connection.
              enum:
              - pstn
              - sip
              example: sip
              type: string
            client_state:
              description: Base64-encoded state received from a command.
              example: g3QAAAACbQAAAAtkYXRhX2NlbnRlcm0AAAADY2gxbQAAAApkZXBsb3ltZW50bQAAAARiYXNl
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            conversation_id:
              description: ID unique to the conversation or insight group generated for the call.
              example: 0424805b-adc1-4ff8-9f95-e1de6883ecbe
              type: string
            duration_sec:
              description: Duration of the conversation in seconds.
              example: 3
              type: integer
            from:
              description: The caller's number or identifier.
              example: '+13124287921'
              type: string
            llm_model:
              description: The large language model used during the conversation.
              example: openai/gpt-4o
              type: string
            stt_model:
              description: The speech-to-text model used in the conversation.
              example: distil-whisper/distil-large-v2
              type: string
            to:
              description: The callee's number or SIP address.
              example: jamesw@assistant-d9082b56-ba2d-4ad1-a50c-58661eb1463d.sip.telnyx.com
              type: string
            tts_model_id:
              description: The model ID used for text-to-speech synthesis.
              example: Natural
              type: string
            tts_provider:
              description: The text-to-speech provider used in the call.
              example: telnyx
              type: string
            tts_voice_id:
              description: Voice ID used for TTS.
              example: Marissa
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Conversation Ended
      type: object
    CallReferCompleted:
      example:
        event_type: call.refer.completed
        id: 4ce4366d-8d87-44be-a00b-942154e9c5f5
        occurred_at: '2020-03-30T13:29:44.650000Z'
        payload:
          call_control_id: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
          call_leg_id: 817f7de8-728a-11ea-9ce6-02420a0f8969
          call_session_id: 817f8c2a-728a-11ea-9cbe-02420a0f8969
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: '1289082222292239760'
          from: '+35319605860'
          sip_notify_response: 200
          to: '+13129457420'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.refer.completed
          example: call.refer.completed
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Unique ID for controlling the call.
              example: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            sip_notify_response:
              description: SIP NOTIFY event status for tracking the REFER attempt.
              example: 200
              type: integer
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      type: object
    ConferenceEndedEvent:
      properties:
        data:
          $ref: '#/components/schemas/ConferenceEnded'
      title: Conference Ended Event
      type: object
    CallStreamingStarted:
      example:
        event_type: streaming.started
        id: 7d743d69-f7e8-4761-b7d4-8cacf9d3c031
        occurred_at: '2021-12-15T14:06:32.059436Z'
        payload:
          call_control_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          call_leg_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          call_session_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          stream_url: wss://www.example.com/websocket
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - streaming.started
          example: streaming.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2021-12-15T14:06:32.059436Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            stream_url:
              description: Destination WebSocket address where the stream is going to be delivered.
              example: wss://www.example.com/websocket
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Streaming Started
      type: object
    ConferenceCreated:
      example:
        event_type: conference.created
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          occurred_at: '2018-02-02T22:25:27.521Z'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - conference.created
          example: conference.created
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: Conference ID that the participant joined.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2018-02-02T22:25:27.521Z'
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Conference Created
      type: object
    CallStreamingStopped:
      example:
        event_type: streaming.stopped
        id: 25dc3731-e51e-4927-a50d-a61cc25984b1
        occurred_at: '2021-12-15T14:11:24.613295Z'
        payload:
          call_control_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          call_leg_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          call_session_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          stream_url: wss://www.example.com/websocket
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - streaming.stopped
          example: streaming.stopped
          type: string
        id:
          description: Identifies the type of resource.
          example: 25dc3731-e51e-4927-a50d-a61cc25984b1
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2021-12-15T14:11:24.613295Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            stream_url:
              description: Destination WebSocket address where the stream is going to be delivered.
              example: wss://www.example.com/websocket
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Streaming Stopped
      type: object
    CallForkStoppedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallForkStopped'
      title: Call Fork Stopped Event
      type: object
    CallSiprecStopped:
      example:
        event_type: siprec.stopped
        id: 25dc3731-e51e-4927-a50d-a61cc25984b1
        occurred_at: '2021-12-15T14:11:24.613295Z'
        payload:
          call_control_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          call_leg_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          call_session_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          hangup_cause: normal_clearing
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - siprec.stopped
          example: siprec.stopped
          type: string
        id:
          description: Identifies the type of resource.
          example: 25dc3731-e51e-4927-a50d-a61cc25984b1
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2021-12-15T14:11:24.613295Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            hangup_cause:
              description: Q850 reason why the SIPREC session was stopped.
              example: normal_clearing
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Siprec Stopped
      type: object
    CallSpeakEndedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallSpeakEnded'
      title: Call Speak Ended Event
      type: object
    CallReferStartedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallReferStarted'
      title: Call Refer Started Event
      type: object
    CallReferFailed:
      example:
        event_type: call.refer.failed
        id: fbeb70e0-54eb-4e26-8d19-56b43e66f754
        occurred_at: '2020-03-30T13:29:42.130013Z'
        payload:
          call_control_id: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
          call_leg_id: 817f7de8-728a-11ea-9ce6-02420a0f8969
          call_session_id: 817f8c2a-728a-11ea-9cbe-02420a0f8969
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: '1289082222292239760'
          from: '+35319605860'
          sip_notify_response: 603
          to: '+13129457420'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.refer.failed
          example: call.refer.failed
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Unique ID for controlling the call.
              example: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            sip_notify_response:
              description: SIP NOTIFY event status for tracking the REFER attempt.
              example: 603
              type: integer
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      type: object
    CallCost:
      example:
        event_type: call.cost
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          billed_duration_secs: 120
          billing_group_id: f5586561-8ff0-4291-a0ac-84fe544797bd
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          cost_parts:
          - billed_duration_secs: 60
            call_part: sip-trunking
            cost: '0.0050'
            currency: USD
            rate: '0.0050'
          - billed_duration_secs: 120
            call_part: call-recording
            cost: '0.0038'
            currency: USD
            rate: '0.00190'
          - billed_duration_secs: 60
            call_part: call-control
            cost: '0.0018'
            currency: USD
            rate: '0.00180'
          occurred_at: '2018-02-02T22:25:27.521992Z'
          status: success
          total_cost: '0.0106'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.cost
          example: call.cost
          type: string
        id:
          description: Unique identifier of the event.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            billed_duration_secs:
              description: The longest billed duration across all cost parts, in seconds.
              example: 120
              type:
              - integer
              - 'null'
            billing_group_id:
              description: Identifies the billing group associated with the call.
              example: f5586561-8ff0-4291-a0ac-84fe544797bd
              type:
              - string
              - 'null'
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command. Base64-encoded.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            cost_parts:
              description: Breakdown of costs by call part.
              example:
              - billed_duration_secs: 60
                call_part: sip-trunking
                cost: '0.0050'
                currency: USD
                rate: '0.0050'
              - billed_duration_secs: 120
                call_part: call-recording
                cost: '0.0038'
                currency: USD
                rate: '0.00190'
              - billed_duration_secs: 60
                call_part: call-control
                cost: '0.0018'
                currency: USD
                rate: '0.00180'
              items:
                $ref: '#/components/schemas/CallCostPart'
              type: array
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2018-02-02T22:25:27.521992Z'
              format: date-time
              type: string
            status:
              description: The status of the cost calculation (`success` or `error`).
              enum:
              - success
              - error
              example: success
              type: string
            total_cost:
              description: The total cost of the call.
              example: '0.0106'
              type:
              - string
              - 'null'
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Cost
      type: object
    CallMachinePremiumGreetingEnded:
      example:
        event_type: call.machine.premium.greeting.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: '+35319605860'
          result: beep_detected
          to: '+35319605860'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.machine.premium.greeting.ended
          example: call.machine.premium.greeting.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            result:
              description: Premium Answering Machine Greeting Ended result.
              enum:
              - beep_detected
              - no_beep_detected
              example: beep_detected
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Machine Premium Greeting Ended
      type: object
    CallInitiatedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallInitiated'
      title: Call Initiated Event
      type: object
    FaxFailed:
      example:
        data:
          event_type: fax.failed
          id: 95479a2e-b947-470a-a88f-2da6dd07ae0f
          occurred_at: '2020-05-05T13:08:22.039204Z'
          payload:
            client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
            connection_id: '234423'
            direction: outbound
            failure_reason: rejected
            fax_id: f8338808-3dc6-4f2b-942a-5d1f39255784
            from: '+17733372107'
            original_media_url: http://www.example.com/fax.pdf
            status: failed
            to: '+15107882622'
            user_id: 19a75cea-02c6-4b9a-84fa-c9bc8341feb8
          record_type: event
        meta:
          attempt: 1
          delivered_to: https://www.example.com/webhooks
      properties:
        data:
          properties:
            event_type:
              description: The type of event being delivered.
              enum:
              - fax.failed
              example: fax.failed
              type: string
            id:
              $ref: '#/components/schemas/Id'
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2020-05-05T13:08:22.039204Z'
              format: date-time
              type: string
            payload:
              properties:
                client_state:
                  description: State received from a command.
                  example: aGF2ZSBhIG5pY2UgZGF5ID1d
                  type: string
                connection_id:
                  $ref: '#/components/schemas/ConnectionId'
                direction:
                  $ref: '#/components/schemas/Direction'
                failure_reason:
                  description: Cause of the sending failure
                  enum:
                  - rejected
                  type: string
                fax_id:
                  $ref: '#/components/schemas/FaxId'
                from:
                  $ref: '#/components/schemas/From'
                media_name:
                  $ref: '#/components/schemas/MediaName'
                original_media_url:
                  $ref: '#/components/schemas/OriginalMediaUrl'
                status:
                  description: The status of the fax.
                  enum:
                  - failed
                  example: failed
                  type: string
                to:
                  $ref: '#/components/schemas/To'
                user_id:
                  $ref: '#/components/schemas/UserId'
              type: object
            record_type:
              $ref: '#/components/schemas/programmable-fax_RecordType'
          type: object
        meta:
          description: Metadata about the webhook delivery.
          properties:
            attempt:
              description: The delivery attempt number.
              example: 1
              type: integer
            delivered_to:
              description: The URL the webhook was delivered to.
              example: https://www.example.com/webhooks
              format: uri
              type: string
          type: object
      type: object
    ConferenceCreatedEvent:
      properties:
        data:
          $ref: '#/components/schemas/ConferenceCreated'
      title: Conference Created Event
      type: object
    CallDtmfReceived:
      example:
        event_type: call.dtmf.received
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          digit: '#'
          from: '+35319605860'
          to: '+35319605860'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.dtmf.received
          example: call.dtmf.received
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Identifies the type of resource.
              example: 7267xxxxxxxxxxxxxx
              type: string
            digit:
              description: The received DTMF digit or symbol.
              example: '#'
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call DTMF Received
      type: object
    CallMachineGreetingEnded:
      example:
        event_type: call.machine.greeting.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: '+35319605860'
          result: ended
          to: '+35319605860'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.machine.greeting.ended
          example: call.machine.greeting.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            result:
              description: Answering machine greeting ended result.
              enum:
              - beep_detected
              - ended
              - not_sure
              example: ended
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Machine Greeting Ended
      type: object
    CallHangupEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallHangup'
      title: Call Hangup Event
      type: object
    CallEnqueued:
      example:
        event_type: call.enqueued
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          current_position: 5
          queue: support
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.enqueued
          example: call.enqueued
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            current_position:
              description: Current position of the call in the queue.
              example: 7
              type: integer
            queue:
              description: The name of the queue
              example: support
              type: string
            queue_avg_wait_time_secs:
              description: Average time call spends in the queue in seconds.
              example: 60
              type: integer
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Enqueued
      type: object
    callConversationInsightsGenerated:
      example:
        event_type: call.conversation_insights.generated
        id: 898e96ef-be63-45aa-9e7d-01332bff9a97
        occurred_at: '2025-02-19T17:02:49.371454Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          calling_party_type: pstn
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          insight_group_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          results:
          - insight_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
            result: The user inquired about the menu at Ember & Oak. The menu offers various options, including vegetarian, vegan, and gluten-free dishes, as well as a children's menu. The restaurant also has a daily happy hour from 4 PM to 6 PM and offers takeaway and delivery services. The user found the information helpful but had to leave without making any further decisions or requests. No specific preferences or goals were expressed beyond inquiring about the menu.
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.conversation_insights.generated
          example: call.conversation_insights.generated
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            calling_party_type:
              description: The type of calling party connection.
              enum:
              - pstn
              - sip
              example: pstn
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            insight_group_id:
              description: ID that is unique to the insight group being generated for the call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            results:
              description: Array of insight results being generated for the call.
              items:
                properties:
                  insight_id:
                    description: ID that is unique to the insight result being generated for the call.
                    example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
                    type: string
                  result:
                    oneOf:
                    - description: The result of the insight.
                      type: object
                    - description: The result of the insight.
                      type: string
                type: object
              type: array
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Conversation Insights Generated
      type: object
    CallDeepfakeDetectionResultEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallDeepfakeDetectionResult'
      title: Call Deepfake Detection Result Event
      type: object
    FaxQueued:
      example:
        data:
          event_type: fax.queued
          id: 95479a2e-b947-470a-a88f-2da6dd07ae0f
          occurred_at: '2020-05-05T13:08:22.039204Z'
          payload:
            client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
            connection_id: '234423'
            direction: outbound
            fax_id: f8338808-3dc6-4f2b-942a-5d1f39255784
            from: '+17733372107'
            original_media_url: http://www.example.com/fax.pdf
            status: queued
            to: '+15107882622'
            user_id: 19a75cea-02c6-4b9a-84fa-c9bc8341feb8
          record_type: event
        meta:
          attempt: 1
          delivered_to: https://www.example.com/webhooks
      properties:
        data:
          properties:
            event_type:
              description: The type of event being delivered.
              enum:
              - fax.queued
              example: fax.queued
              type: string
            id:
              $ref: '#/components/schemas/Id'
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2020-05-05T13:08:22.039204Z'
              format: date-time
              type: string
            payload:
              properties:
                client_state:
                  description: State received from a command.
                  example: aGF2ZSBhIG5pY2UgZGF5ID1d
                  type: string
                connection_id:
                  $ref: '#/components/schemas/ConnectionId'
                direction:
                  $ref: '#/components/schemas/Direction'
                fax_id:
                  $ref: '#/components/schemas/FaxId'
                from:
                  $ref: '#/components/schemas/From'
                media_name:
                  $ref: '#/components/schemas/MediaName'
                original_media_url:
                  $ref: '#/components/schemas/OriginalMediaUrl'
                status:
                  description: The status of the fax.
                  enum:
                  - queued
                  example: queued
                  type: string
                to:
                  $ref: '#/components/schemas/To'
                user_id:
                  $ref: '#/components/schemas/UserId'
              type: object
            record_type:
              $ref: '#/components/schemas/programmable-fax_RecordType'
          type: object
        meta:
          description: Metadata about the webhook delivery.
          properties:
            attempt:
              description: The delivery attempt number.
              example: 1
              type: integer
            delivered_to:
              description: The URL the webhook was delivered to.
              example: https://www.example.com/webhooks
              format: uri
              type: string
          type: object
      type: object
    Id:
      description: Identifies the type of resource.
      example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
      format: uuid
      type: string
    CallSiprecStartedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallSiprecStarted'
      title: Siprec Started Event
      type: object
    CallRecordingSavedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallRecordingSaved'
      title: Call Recording Saved Event
      type: object
    ConferencePlaybackEndedEvent:
      properties:
        data:
          $ref: '#/components/schemas/ConferencePlaybackEnded'
      title: Conference Playback Ended Event
      type: object
    CallPlaybackStarted:
      example:
        event_type: call.playback.started
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          media_url: http://example.com/audio.wav
          overlay: false
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.playback.started
          example: call.playback.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            media_name:
              description: The name of the audio media file being played back, if media_name has been used to start.
              example: my_media_uploaded_to_media_storage_api
              type: string
            media_url:
              description: The audio URL being played back, if audio_url has been used to start.
              example: http://example.com/audio.wav
              type: string
            overlay:
              description: Whether the audio is going to be played in overlay mode or not.
              example: false
              type: boolean
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Playback Started
      type: object
    CallDeepfakeDetectionResult:
      example:
        event_type: call.deepfake_detection.result
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          consistency: 94.5
          result: fake
          score: 0.87
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.deepfake_detection.result
          example: call.deepfake_detection.result
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              format: uuid
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              format: uuid
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type:
              - string
              - 'null'
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            consistency:
              description: Percentage (0-100) indicating how consistently the model classified the audio across frames. High consistency (>90%) means confident classification throughout; low consistency suggests mixed signals. Null for silence_timeout.
              format: float
              maximum: 100
              minimum: 0
              type:
              - number
              - 'null'
            result:
              description: Detection outcome. 'real' = human voice, 'fake' = AI-generated voice, 'silence_timeout' = no analyzable speech detected before timeout.
              enum:
              - real
              - fake
              - silence_timeout
              type: string
            score:
              description: Probability that the audio is AI-generated, from 0.0 (likely real) to 1.0 (likely deepfake). Based on the model's aggregated confidence across analyzed audio frames. Null for silence_timeout.
              format: float
              type:
              - number
              - 'null'
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Deepfake Detection Result
      type: object
    ConferenceSpeakStartedEvent:
      properties:
        data:
          $ref: '#/components/schemas/ConferenceSpeakStarted'
      title: Conference Speak Started Event
      type: object
    CampaignStatusUpdateEvent:
      properties:
        brandId:
          description: Brand ID associated with the campaign.
          example: d88dd2aa-1bb9-4ef0-9ec8-1752b80316a5
          title: Brandid
          type: string
        campaignId:
          description: The ID of the campaign.
          example: 4b300178-131c-d902-d54e-72d90ba1620j
          title: Campaignid
          type: string
        createDate:
          description: Unix timestamp when campaign was created.
          title: CreateDate
          type: string
        cspId:
          description: Alphanumeric identifier of the CSP associated with this campaign.
          title: Cspid
          type: string
        description:
          description: Description of the event.
          example: Campaign has been marked as dormant
          title: Description
          type: string
        isTMobileRegistered:
          description: Indicates whether the campaign is registered with T-Mobile.
          title: IsTMobileRegistered
          type: boolean
        status:
          description: The status of the campaign.
          enum:
          - ACCEPTED
          - REJECTED
          - DORMANT
          - success
          - failed
          example: DORMANT
          title: Status
          type: string
        type:
          enum:
          - TELNYX_EVENT
          - REGISTRATION
          - MNO_REVIEW
          - TELNYX_REVIEW
          - NUMBER_POOL_PROVISIONED
          - NUMBER_POOL_DEPROVISIONED
          - TCR_EVENT
          - VERIFIED
          example: TELNYX_EVENT
          title: Type
          type: string
      title: Campaign Status Update Event
      type: object
    ConferenceParticipantPlaybackStarted:
      example:
        event_type: conference.participant.playback.started
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          media_url: https://www.example.com/audio.mp3
          occurred_at: '2018-02-02T22:25:27.521Z'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - conference.participant.playback.started
          example: conference.participant.playback.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Participant's call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            media_name:
              description: The name of the audio media file being played back, if media_name has been used to start.
              example: my_media_uploaded_to_media_storage_api
              type: string
            media_url:
              description: The audio URL being played back, if audio_url has been used to start.
              example: http://example.com/audio.wav
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2018-02-02T22:25:27.521Z'
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Conference Participant Playback Started
      type: object
    CallSiprecStoppedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallSiprecStopped'
      title: Siprec Stopped Event
      type: object
    CallMachineDetectionEndedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallMachineDetectionEnded'
      title: Call Machine Detection Ended Event
      type: object
    CallAIGatherEnded:
      example:
        event_type: call.ai_gather.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: '+35319605860'
          message_history:
          - content: Hello, can you tell me your age and where you live?
            role: assistant
          - content: Hello, I'm 29 and I live in Paris?
            role: user
          result:
            age: 29
            city: Paris
          status: valid
          to: '+35319605860'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.ai_gather.ended
          example: call.ai_gather.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Telnyx connection ID used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            message_history:
              description: The history of the messages exchanged during the AI gather
              items:
                properties:
                  content:
                    description: The content of the message
                    example: Hello, I'm 29 and I live in Paris.
                    type: string
                  role:
                    description: The role of the message sender
                    enum:
                    - assistant
                    - user
                    example: user
                    type: string
                type: object
              type: array
            result:
              description: The result of the AI gather, its type depends of the `parameters` provided in the command
              example:
                age: 29
                city: Paris
              type: object
            status:
              description: Reflects how command ended.
              enum:
              - valid
              - invalid
              example: valid
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call AI Gather Ended
      type: object
    HostedNumberOrderEvent:
      properties:
        data:
          $ref: '#/components/schemas/HostedNumberOrder'
      type: object
    CallReferStarted:
      example:
        event_type: call.refer.started
        id: fbeb70e0-54eb-4e26-8d19-56b43e66f754
        occurred_at: '2020-03-30T13:29:42.130013Z'
        payload:
          call_control_id: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
          call_leg_id: 817f7de8-728a-11ea-9ce6-02420a0f8969
          call_session_id: 817f8c2a-728a-11ea-9cbe-02420a0f8969
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: '1289082222292239760'
          from: '+35319605860'
          sip_notify_response: 100
          to: '+13129457420'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.refer.started
          example: call.refer.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Unique ID for controlling the call.
              example: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            sip_notify_response:
              description: SIP NOTIFY event status for tracking the REFER attempt.
              example: 100
              type: integer
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Refer Started
      type: object
    CallForkStarted:
      example:
        event_type: call.fork.started
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          stream_type: decrypted
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.fork.started
          example: call.fork.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Unique ID for controlling the call.
              example: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            stream_type:
              description: Type of media streamed. It can be either 'raw' or 'decrypted'.
              enum:
              - decrypted
              example: decrypted
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Fork Started
      type: object
    callConversationEndedEvent:
      properties:
        data:
          $ref: '#/components/schemas/callConversationEnded'
      title: Call Conversation Ended Event
      type: object
    CallAnswered:
      example:
        event_type: call.answered
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: '+35319605860'
          start_time: '2018-02-02T22:25:27.521992Z'
          state: answered
          to: '+35319605860'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.answered
          example: call.answered
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            custom_headers:
              description: Custom headers set on answer command
              example:
              - name: head_1
                value: val_1
              - name: head_2
                value: val_2
              items:
                $ref: '#/components/schemas/CustomSipHeader'
              type: array
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            sip_headers:
              description: User-to-User and Diversion headers from sip invite.
              example:
              - name: User-to-User
                value: '1234'
              - name: User-to-User
                value: <sip:111@192.168.1.1>
              items:
                $ref: '#/components/schemas/SipHeader'
              type: array
            start_time:
              description: ISO 8601 datetime of when the call started.
              example: '2018-02-02T22:20:27.521992Z'
              format: date-time
              type: string
            state:
              description: State received from a command.
              enum:
              - answered
              example: answered
              type: string
            tags:
              description: Array of tags associated to number.
              example:
              - tag-01
              - tag-02
              items:
                type: string
              type: array
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Answered
      type: object
    OutboundMessagePayload:
      example:
        cc: []
        completed_at: null
        cost:
          amount: '0.0051'
          currency: USD
        cost_breakdown:
          carrier_fee:
            amount: '0.00305'
            currency: USD
          rate:
            amount: '0.00205'
            currency: USD
        direction: outbound
        encoding: GSM-7
        errors: []
        from:
          carrier: TELNYX LLC
          line_type: VoIP
          phone_number: '+18445550001'
        id: 40385f64-5717-4562-b3fc-2c963f66afa6
        media:
        - content_type: null
          sha256: null
          size: null
          url: https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png
        messaging_profile_id: 4000eba1-a0c0-4563-9925-b25e842a7cb6
        organization_id: b448f9cc-a842-4784-98e9-03c1a5872950
        parts: 1
        received_at: '2019-01-23T18:10:02.574Z'
        record_type: message
        sent_at: null
        subject: From Telnyx!
        tags:
        - Greetings
        tcr_campaign_billable: true
        tcr_campaign_id: TCPA3X7
        tcr_campaign_registered: REGISTERED
        text: Hello, World!
        to:
        - carrier: T-MOBILE USA, INC.
          line_type: Wireless
          phone_number: '+18665550001'
          status: queued
        type: MMS
        valid_until: null
        wait_seconds: 0.5
        webhook_failover_url: https://backup.example.com/hooks
        webhook_url: https://www.example.com/hooks
      properties:
        cc:
          items:
            properties:
              carrier:
                description: The carrier of the receiver.
                type: string
              line_type:
                description: The line-type of the receiver.
                enum:
                - Wireline
                - Wireless
                - VoWiFi
                - VoIP
                - Pre-Paid Wireless
                - ''
                type: string
              phone_number:
                description: Receiving address (+E.164 formatted phone number or short code).
                type: string
                x-format: address
              status:
                enum:
                - queued
                - sending
                - sent
                - delivered
                - sending_failed
                - delivery_failed
                - delivery_unconfirmed
                type: string
            type: object
          type: array
        completed_at:
          description: ISO 8601 formatted date indicating when the message was finalized.
          format: date-time
          type:
          - string
          - 'null'
        cost:
          properties:
            amount:
              description: The amount deducted from your account.
              type: string
              x-format: decimal
            currency:
              description: The ISO 4217 currency identifier.
              type: string
              x-format: iso4217
          type:
          - object
          - 'null'
        cost_breakdown:
          description: Detailed breakdown of the message cost components.
          properties:
            carrier_fee:
              properties:
                amount:
                  description: The carrier fee amount.
                  type: string
                  x-format: decimal
                currency:
                  description: The ISO 4217 currency identifier.
                  type: string
                  x-format: iso4217
              type: object
            rate:
              properties:
                amount:
                  description: The rate amount applied.
                  type: string
                  x-format: decimal
                currency:
                  description: The ISO 4217 currency identifier.
                  type: string
                  x-format: iso4217
              type: object
          type:
          - object
          - 'null'
        direction:
          description: The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you.
          enum:
          - outbound
          example: outbound
          type: string
        encoding:
          description: Encoding scheme used for the message body.
          type: string
        errors:
          description: These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.
          items:
            $ref: '#/components/schemas/messaging_Error'
          type: array
        from:
          properties:
            carrier:
              description: The carrier of the receiver.
              type: string
            line_type:
              description: The line-type of the receiver.
              enum:
              - Wireline
              - Wireless
              - VoWiFi
              - VoIP
              - Pre-Paid Wireless
              - ''
              type: string
            phone_number:
              description: Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).
              type: string
              x-format: address
          type: object
        id:
          description: Identifies the type of resource.
          format: uuid
          type: string
        media:
          items:
            properties:
              content_type:
                description: The MIME type of the requested media.
                type:
                - string
                - 'null'
                x-format: mime-type
              sha256:
                description: The SHA256 hash of the requested media.
                type:
                - string
                - 'null'
              size:
                description: The size of the requested media.
                type:
                - integer
                - 'null'
              url:
                description: The url of the media requested to be sent.
                format: url
                type: string
            type: object
          type: array
        messaging_profile_id:
          description: Unique identifier for a messaging profile.
          type: string
        organization_id:
          description: The id of the organization the messaging profile belongs to.
          format: uuid
          type: string
        parts:
          description: Number of parts into which the message's body must be split.
          maximum: 10
          minimum: 1
          type: integer
        received_at:
          description: ISO 8601 formatted date indicating when the message request was received.
          format: date-time
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
          - message
          example: message
          type: string
        sent_at:
          description: ISO 8601 formatted date indicating when the message was sent.
          format: date-time
          type:
          - string
          - 'null'
        smart_encoding_applied:
          description: Indicates whether smart encoding was applied to this message. When `true`, one or more Unicode characters were automatically replaced with GSM-7 equivalents to reduce segment count and cost. The original message text is preserved in webhooks.
          type: boolean
        subject:
          description: Subject of multimedia message
          type:
          - string
          - 'null'
        tags:
          description: Tags associated with the resource.
          items:
            type: string
          type: array
        tcr_campaign_billable:
          description: Indicates whether the TCR campaign is billable.
          type: boolean
        tcr_campaign_id:
          description: The Campaign Registry (TCR) campaign ID associated with the message.
          type:
          - string
          - 'null'
        tcr_campaign_registered:
          description: The registration status of the TCR campaign.
          example: REGISTERED
          type:
          - string
          - 'null'
        text:
          description: 'Message body (i.e., content) as a non-empty string.


            **Required for SMS**'
          type: string
        to:
          items:
            properties:
              carrier:
                description: The carrier of the receiver.
                type: string
              line_type:
                description: The line-type of the receiver.
                enum:
                - Wireline
                - Wireless
                - VoWiFi
                - VoIP
                - Pre-Paid Wireless
                - ''
                type: string
              phone_number:
                description: Receiving address (+E.164 formatted phone number or short code).
                type: string
                x-format: address
              status:
                description: The delivery status of the message.
                enum:
                - queued
                - sending
                - sent
                - expired
                - sending_failed
                - delivery_unconfirmed
                - delivered
                - delivery_failed
                type: string
            type: object
          type: array
        type:
          description: The type of message.
          enum:
          - SMS
          - MMS
          type: string
        valid_until:
          description: Message must be out of the queue by this time or else it will be discarded and marked as 'sending_failed'. Once the message moves out of the queue, this field will be nulled
          format: date-time
          type:
          - string
          - 'null'
        wait_seconds:
          description: Seconds the message is queued due to rate limiting before being sent to the carrier. Represents the maximum wait across all applicable rate limits (account, carrier, campaign). 0.0 = no queuing delay.
          example: 0.5
          format: float
          type:
          - number
          - 'null'
        webhook_failover_url:
          description: The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.
          format: url
          type:
          - string
          - 'null'
        webhook_url:
          description: The URL where webhooks related to this message will be sent.
          format: url
          type:
          - string
          - 'null'
      type: object
    ConferenceParticipantJoined:
      example:
        event_type: conference.participant.joined
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - conference.participant.joined
          example: conference.participant.joined
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: Conference ID that the participant joined.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Conference Participant Joined
      type: object
    CallStreamingFailed:
      example:
        event_type: streaming.failed
        id: 25dc3731-e51e-4927-a50d-a61cc25984b1
        occurred_at: '2021-12-15T14:11:24.613295Z'
        payload:
          call_control_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          call_leg_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          call_session_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          failure_reason: connection_failed
          stream_id: 1edb94f9-7ef0-4150-b502-e0ebadfd9491
          stream_params:
            stream_url: wss://www.example.com/websocket
            track: inbound_track
          stream_type: websocket
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - streaming.failed
          example: streaming.failed
          type: string
        id:
          description: Identifies the type of resource.
          example: 25dc3731-e51e-4927-a50d-a61cc25984b1
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2021-12-15T14:11:24.613295Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 31f19208-5db0-11ec-9ea7-02420a0d3a69
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            failure_reason:
              description: A short description explaning why the media streaming failed.
              example: connection_failed
              type: string
            stream_id:
              description: Identifies the streaming.
              example: 1edb94f9-7ef0-4150-b502-e0ebadfd9491
              format: uuid
              type: string
            stream_params:
              description: Streaming parameters as they were originally given to the Call Control API.
              properties:
                stream_url:
                  description: The destination WebSocket address where the stream is going to be delivered.
                  example: wss://www.example.com/websocket
                  type: string
                track:
                  default: inbound_track
                  description: Specifies which track should be streamed.
                  enum:
                  - inbound_track
                  - outbound_track
                  - both_tracks
                  example: inbound_track
                  type: string
              type: object
            stream_type:
              description: The type of stream connection the stream is performing.
              enum:
              - websocket
              - dialogflow
              example: websocket
              type: string
          type: object
        record_type:
          description: Identifies the resource.
          enum:
          - event
          example: event
          type: string
      title: Streaming Failed
      type: object
    Direction:
      description: The direction of the fax.
      enum:
      - inbound
      - outbound
      example: outbound
      type: string
    FaxDelivered:
      example:
        data:
          event_type: fax.delivered
          id: 95479a2e-b947-470a-a88f-2da6dd07ae0f
          occurred_at: '2020-05-05T13:08:22.039204Z'
          payload:
            call_duration_secs: 25
            client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
            connection_id: '234423'
            direction: outbound
            fax_id: f8338808-3dc6-4f2b-942a-5d1f39255784
            from: '+17733372107'
            original_media_url: http://www.example.com/fax.pdf
            page_count: 2
            status: delivered
            to: '+15107882622'
            user_id: 19a75cea-02c6-4b9a-84fa-c9bc8341feb8
          record_type: event
        meta:
          attempt: 1
          delivered_to: https://www.example.com/webhooks
      properties:
        data:
          properties:
            event_type:
              description: The type of event being delivered.
              enum:
              - fax.delivered
              example: fax.delivered
              type: string
            id:
              $ref: '#/components/schemas/Id'
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2020-05-05T13:08:22.039204Z'
              format: date-time
              type: string
            payload:
              properties:
                call_duration_secs:
                  description: The duration of the call in seconds.
                  example: 25
                  type: integer
                client_state:
                  description: State received from a command.
                  example: aGF2ZSBhIG5pY2UgZGF5ID1d
                  type: string
                connection_id:
                  $ref: '#/components/schemas/ConnectionId'
                direction:
                  $ref: '#/components/schemas/Direction'
                fax_id:
                  $ref: '#/components/schemas/FaxId'
                from:
                  $ref: '#/components/schemas/From'
                media_name:
                  $ref: '#/components/schemas/MediaName'
                original_media_url:
                  $ref: '#/components/schemas/OriginalMediaUrl'
                page_count:
                  description: Number of transferred pages
                  example: 2
                  type: integer
                status:
                  description: The status of the fax.
                  enum:
                  - delivered
                  example: delivered
                  type: string
                to:
                  $ref: '#/components/schemas/To'
                user_id:
                  $ref: '#/components/schemas/UserId'
              type: object
            record_type:
              $ref: '#/components/schemas/programmable-fax_RecordType'
          type: object
        meta:
          description: Metadata about the webhook delivery.
          properties:
            attempt:
              description: The delivery attempt number.
              example: 1
              type: integer
            delivered_to:
              description: The URL the webhook was delivered to.
              example: https://www.example.com/webhooks
              format: uri
              type: string
          type: object
      type: object
    CallRecordingSaved:
      example:
        event_type: call.recording.saved
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          channels: single
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          public_recording_urls:
            mp3: http://example.com/recording.mp3
            wav: http://example.com/recording.wav
          recording_ended_at: '2018-02-02T22:20:27.521992Z'
          recording_started_at: '2018-02-02T22:20:27.521992Z'
          recording_urls:
            mp3: http://example.com/recording.mp3
            wav: http://example.com/recording.wav
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.recording.saved
          example: call.recording.saved
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            channels:
              description: Whether recording was recorded in `single` or `dual` channel.
              enum:
              - single
              - dual
              example: single
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            public_recording_urls:
              description: Recording URLs in requested format. The URL is valid for as long as the file exists. For security purposes, this feature is activated on a per request basis.  Please contact customer support with your Account ID to request activation.
              properties:
                mp3:
                  description: Recording URL in requested `mp3` format.
                  example: http://example.com/recording.mp3
                  type:
                  - string
                  - 'null'
                wav:
                  description: Recording URL in requested `wav` format.
                  example: http://example.com/recording.wav
                  type:
                  - string
                  - 'null'
              type: object
            recording_ended_at:
              description: ISO 8601 datetime of when recording ended.
              example: '2018-02-02T22:25:27.521992Z'
              format: date-time
              type: string
            recording_started_at:
              description: ISO 8601 datetime of when recording started.
              example: '2018-02-02T22:20:27.521992Z'
              format: date-time
              type: string
            recording_urls:
              description: Recording URLs in requested format. These URLs are valid for 10 minutes. After 10 minutes, you may retrieve recordings via API using Reports -> Call Recordings documentation, or via Mission Control under Reporting -> Recordings.
              properties:
                mp3:
                  description: Recording URL in requested `mp3` format.
                  example: http://example.com/recording.mp3
                  type:
                  - string
                  - 'null'
                wav:
                  description: Recording URL in requested `wav` format.
                  example: http://example.com/recording.wav
                  type:
                  - string
                  - 'null'
              type: object
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Recording Saved
      type: object
    CallMachinePremiumDetectionEnded:
      example:
        event_type: call.machine.premium.detection.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: '2018-02-02T22:25:27.521992Z'
        payload:
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: '+35319605860'
          result: machine
          to: '+35319605860'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.machine.premium.detection.ended
          example: call.machine.premium.detection.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: '+35319605860'
              type: string
            result:
              description: Premium Answering Machine Detection result.
              enum:
              - human_residence
              - human_business
              - machine
              - silence
              - fax_detected
              - not_sure
              example: machine
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: '+13129457420'
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Machine Premium Detection Ended
      type: object
    SipHeader:
      example:
        name: User-to-User
        value: value
      properties:
        name:
          description: The name of the header to add.
          enum:
          - User-to-User
          example: User-to-User
          type: string
        value:
          description: The value of the header.
          example: value
          type: string
      required:
      - name
      - value
      title: SIP Header
      type: object
    CallSpeakStartedEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallSpeakStarted'
      title: Call Speak Started Event
      type: object
    CallCostEvent:
      properties:
        data:
          $ref: '#/components/schemas/CallCost'
      title: Call Cost Event
      type: object
    ConferencePlaybackStarted:
      example:
        event_type: conference.playback.started
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        payload:
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          media_url: https://www.example.com/audio.mp3
          occurred_at: '2018-02-02T22:25:27.521Z'
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - conference.playback.started
          example: conference.playback.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            media_name:
              description: The name of the audio media file being played back, if media_name has been used to start.
              example: my_media_uploaded_to_media_storage_api
              type: string
            media_url:
              description: The audio URL being played back, if audio_url has been used to start.
              example: http://example.com/audio.wav
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: '2018-02-02T22:25:27.521Z'
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Conference Playback Started
      type: object
    callRecordingTranscriptionSaved:
      example:
        event_type: call.recording.transcription.saved
        id: 898e96ef-be63-45aa-9e7d-01332bff9a97
        occurred_at: '2025-02-19T17:02:49.371454Z'
        payload:
          call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          calling_party_type: pstn
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          recording_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          recording_transcription_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          status: completed
          transcription_text: Hi!
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
          - call.recording.transcription.saved
          example: call.recording.transcription.saved
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: '2018-02-02T22:25:27.521992Z'
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            calling_party_type:
              description: The type of calling party connection.
              enum:
              - pstn
              - sip
              example: pstn
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            recording_id:
              description: ID that is unique to the recording session and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            recording_transcription_id:
              description: ID that is unique to the transcription process and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            status:
              description: The transcription status.
              enum:
              - completed
              example: completed
              type: string
            transcription_text:
              description: The transcribed text
              example: Hi!
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - event
          example: event
          type: string
      title: Call Recording Transcription Saved
      type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http
    branded-calling_bearerAuth:
      description: API key passed as a Bearer token in the Authorization header
      scheme: bearer
      type: http
    oauthClientAuth:
      description: OAuth 2.0 authentication for Telnyx API and MCP integrations
      flows:
        authorizationCode:
          authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
          refreshUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
          tokenUrl: https://api.telnyx.com/v2/oauth/token
        clientCredentials:
          scopes:
            admin: Administrative access to Telnyx resources
          tokenUrl: https://api.telnyx.com/v2/oauth/token
      type: oauth2
    outbound-voice-profiles_bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http
    pronunciation-dicts_bearerAuth:
      description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
      scheme: bearer
      type: http
    stored-payment-transactions_bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http