Telnyx Mobile Voice Connections API

openapi: 3.1.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 Access Tokens Mobile Voice Connections 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: Mobile voice connection operations
  name: Mobile Voice Connections
paths:
  /v2/mobile_voice_connections:
    get:
      operationId: listMobileVoiceConnections
      parameters:
      - description: The page number to load
        in: query
        name: page[number]
        schema:
          type: integer
      - description: The size of the page
        in: query
        name: page[size]
        schema:
          type: integer
      - description: Filter by connection name containing the given string
        in: query
        name: filter[connection_name][contains]
        schema:
          type: string
      - description: Sort by field (e.g., created_at, connection_name, active). Prefix with - for descending order.
        in: query
        name: sort
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/MobileVoiceConnection'
                    type: array
                  meta:
                    $ref: '#/components/schemas/mobile_voice_connections_PaginationMeta'
                type: object
          description: Successful response
        '401':
          description: Unauthorized
      summary: List Mobile Voice Connections
      tags:
      - Mobile Voice Connections
      x-latency-category: responsive
    post:
      operationId: createMobileVoiceConnection
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MobileVoiceConnectionCreate'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/MobileVoiceConnection'
                type: object
          description: Successful response
        '403':
          description: Unauthorized or Limit Reached
        '422':
          description: Unprocessable Entity
      summary: Create a Mobile Voice Connection
      tags:
      - Mobile Voice Connections
      x-latency-category: responsive
  /v2/mobile_voice_connections/{id}:
    delete:
      operationId: deleteMobileVoiceConnection
      parameters:
      - description: The ID of the mobile voice connection
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/MobileVoiceConnection'
                type: object
          description: Successful response
        '404':
          description: Resource not found
      summary: Delete a Mobile Voice Connection
      tags:
      - Mobile Voice Connections
      x-latency-category: responsive
    get:
      operationId: retrieveMobileVoiceConnection
      parameters:
      - description: The ID of the mobile voice connection
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/MobileVoiceConnection'
                type: object
          description: Successful response
        '404':
          description: Resource not found
      summary: Retrieve a Mobile Voice Connection
      tags:
      - Mobile Voice Connections
      x-latency-category: responsive
    patch:
      operationId: updateMobileVoiceConnection
      parameters:
      - description: The ID of the mobile voice connection
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MobileVoiceConnectionUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/MobileVoiceConnection'
                type: object
          description: Successful response
        '404':
          description: Resource not found
        '422':
          description: Unprocessable Entity
      summary: Update a Mobile Voice Connection
      tags:
      - Mobile Voice Connections
      x-latency-category: responsive
components:
  schemas:
    MobileVoiceConnectionCreate:
      properties:
        active:
          default: true
          type: boolean
        connection_name:
          default: Telnyx Mobile Voice IMS
          type: string
        inbound:
          properties:
            channel_limit:
              type: integer
          type: object
        outbound:
          properties:
            channel_limit:
              type: integer
            outbound_voice_profile_id:
              type: string
          type: object
        tags:
          items:
            type: string
          type: array
        webhook_api_version:
          default: '2'
          enum:
          - '1'
          - '2'
          type: string
        webhook_event_failover_url:
          type:
          - string
          - 'null'
        webhook_event_url:
          type:
          - string
          - 'null'
        webhook_timeout_secs:
          type:
          - integer
          - 'null'
      required: []
      type: object
    mobile_voice_connections_PaginationMeta:
      properties:
        page_number:
          type: integer
        page_size:
          type: integer
        total_pages:
          type: integer
        total_results:
          type: integer
      type: object
    MobileVoiceConnectionUpdate:
      properties:
        active:
          type: boolean
        connection_name:
          type: string
        inbound:
          properties:
            channel_limit:
              type: integer
          type: object
        outbound:
          properties:
            channel_limit:
              type: integer
            outbound_voice_profile_id:
              type: string
          type: object
        tags:
          items:
            type: string
          type: array
        webhook_api_version:
          enum:
          - '1'
          - '2'
          type: string
        webhook_event_failover_url:
          type:
          - string
          - 'null'
        webhook_event_url:
          type:
          - string
          - 'null'
        webhook_timeout_secs:
          type: integer
      required: []
      type: object
    MobileVoiceConnection:
      properties:
        active:
          description: Indicates if the connection is active.
          type: boolean
        connection_name:
          description: The name of the connection.
          type: string
        created_at:
          format: date-time
          readOnly: true
          type: string
        id:
          description: Identifies the resource.
          readOnly: true
          type: string
        inbound:
          properties:
            channel_limit:
              type:
              - integer
              - 'null'
          type: object
        outbound:
          properties:
            channel_limit:
              type:
              - integer
              - 'null'
            outbound_voice_profile_id:
              type:
              - string
              - 'null'
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
          - mobile_voice_connection
          example: mobile_voice_connection
          readOnly: true
          type: string
        tags:
          description: A list of tags associated with the connection.
          items:
            type: string
          type: array
        updated_at:
          format: date-time
          readOnly: true
          type: string
        webhook_api_version:
          description: The API version for webhooks.
          enum:
          - '1'
          - '2'
          type:
          - string
          - 'null'
        webhook_event_failover_url:
          description: The failover URL where webhooks are sent.
          type:
          - string
          - 'null'
        webhook_event_url:
          description: The URL where webhooks are sent.
          type:
          - string
          - 'null'
        webhook_timeout_secs:
          description: The timeout for webhooks in seconds.
          type:
          - integer
          - 'null'
      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