Telnyx Mobile Voice Connections API

Mobile voice connection operations

GitHub OpenAPI
Business capability
Voice & Telephony AE-150.50

Operations 5

GET /v2/mobile_voice_connections List Mobile Voice Connections #
POST /v2/mobile_voice_connections Create a Mobile Voice Connection #
DELETE /v2/mobile_voice_connections/{id} Delete a Mobile Voice Connection #
GET /v2/mobile_voice_connections/{id} Retrieve a Mobile Voice Connection #
PATCH /v2/mobile_voice_connections/{id} Update a Mobile Voice Connection #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/telnyx:telnyx-mobile-voice-connections-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

telnyx-mobile-voice-connections-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Telnyx Mobile Voice Connections API
  version: 2.0.0
  contact:
    email: support@telnyx.com
  x-endpoint-cost: light
  x-refined-note:
  - x-latency-category differs across the merged source definitions and was not carried
  description: 'Operations tagged Mobile Voice Connections across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
  description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: Mobile Voice Connections
  description: Mobile voice connection operations
paths:
  /v2/mobile_voice_connections:
    get:
      summary: List Mobile Voice Connections
      operationId: listMobileVoiceConnections
      tags:
      - Mobile Voice Connections
      parameters:
      - name: page[number]
        in: query
        description: The page number to load
        schema:
          type: integer
      - name: page[size]
        in: query
        description: The size of the page
        schema:
          type: integer
      - name: filter[connection_name][contains]
        in: query
        description: Filter by connection name containing the given string
        schema:
          type: string
      - name: sort
        in: query
        description: Sort by field (e.g., created_at, connection_name, active). Prefix with - for descending order.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/MobileVoiceConnection'
                  meta:
                    $ref: '#/components/schemas/mobile_voice_connections_PaginationMeta'
        '401':
          description: Unauthorized
      description: Retrieve a paginated list of mobile voice connections on your account.
    post:
      summary: Create a Mobile Voice Connection
      operationId: createMobileVoiceConnection
      tags:
      - Mobile Voice Connections
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MobileVoiceConnectionCreate'
            example:
              active: true
              connection_name: Telnyx Mobile Voice IMS
              webhook_api_version: '2'
              tags:
              - string
              outbound:
                channel_limit: 0
                outbound_voice_profile_id: string
              inbound:
                channel_limit: 0
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MobileVoiceConnection'
        '403':
          description: Unauthorized or Limit Reached
        '422':
          description: Unprocessable Entity
      description: Creates a new mobile voice connection with the provided configuration and returns the created connection.
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
  /v2/mobile_voice_connections/{id}:
    delete:
      summary: Delete a Mobile Voice Connection
      operationId: deleteMobileVoiceConnection
      tags:
      - Mobile Voice Connections
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the mobile voice connection
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MobileVoiceConnection'
        '404':
          description: Resource not found
      description: Delete a mobile voice connection from your account.
    get:
      summary: Retrieve a Mobile Voice Connection
      operationId: retrieveMobileVoiceConnection
      tags:
      - Mobile Voice Connections
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the mobile voice connection
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MobileVoiceConnection'
        '404':
          description: Resource not found
      description: Retrieve the details of a specific mobile voice connection.
    patch:
      summary: Update a Mobile Voice Connection
      operationId: updateMobileVoiceConnection
      tags:
      - Mobile Voice Connections
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the mobile voice connection
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MobileVoiceConnectionUpdate'
            example:
              active: false
              connection_name: string
              webhook_api_version: '1'
              webhook_timeout_secs: 0
              tags:
              - string
              outbound:
                channel_limit: 0
                outbound_voice_profile_id: string
              inbound:
                channel_limit: 0
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MobileVoiceConnection'
        '404':
          description: Resource not found
        '409':
          description: Conflict. Another update to this connection is still in progress. Wait and retry the request later.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
              example:
                errors:
                - detail: A previous update to this connection is still in progress. Please try again later.
        '422':
          description: Unprocessable Entity
      description: Update the settings of a specific mobile voice connection.
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
components:
  schemas:
    MobileVoiceConnectionUpdate:
      type: object
      required: []
      properties:
        active:
          type: boolean
        connection_name:
          type: string
        webhook_event_url:
          type:
          - string
          - 'null'
        webhook_event_failover_url:
          type:
          - string
          - 'null'
        webhook_api_version:
          type: string
          enum:
          - '1'
          - '2'
        webhook_timeout_secs:
          type: integer
        tags:
          type: array
          items:
            type: string
        outbound:
          type: object
          properties:
            channel_limit:
              type: integer
            outbound_voice_profile_id:
              type: string
        inbound:
          type: object
          properties:
            channel_limit:
              type: integer
    MobileVoiceConnection:
      type: object
      properties:
        id:
          type: string
          description: Identifies the resource.
          readOnly: true
        record_type:
          type: string
          description: Identifies the type of the resource.
          example: mobile_voice_connection
          enum:
          - mobile_voice_connection
          readOnly: true
        active:
          type: boolean
          description: Indicates if the connection is active.
        connection_name:
          type: string
          description: The name of the connection.
        tags:
          type: array
          items:
            type: string
          description: A list of tags associated with the connection.
        webhook_event_url:
          type:
          - string
          - 'null'
          description: The URL where webhooks are sent.
        webhook_event_failover_url:
          type:
          - string
          - 'null'
          description: The failover URL where webhooks are sent.
        webhook_api_version:
          type:
          - string
          - 'null'
          description: The API version for webhooks.
          enum:
          - '1'
          - '2'
        webhook_timeout_secs:
          type:
          - integer
          - 'null'
          description: The timeout for webhooks in seconds.
        outbound:
          type: object
          properties:
            channel_limit:
              type:
              - integer
              - 'null'
            outbound_voice_profile_id:
              type:
              - string
              - 'null'
        inbound:
          type: object
          properties:
            channel_limit:
              type:
              - integer
              - 'null'
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    mobile_voice_connections_PaginationMeta:
      type: object
      properties:
        total_pages:
          type: integer
        total_results:
          type: integer
        page_number:
          type: integer
        page_size:
          type: integer
    MobileVoiceConnectionCreate:
      type: object
      required: []
      properties:
        active:
          type: boolean
          default: true
        connection_name:
          type: string
          default: Telnyx Mobile Voice IMS
        webhook_event_url:
          type:
          - string
          - 'null'
        webhook_event_failover_url:
          type:
          - string
          - 'null'
        webhook_api_version:
          type: string
          enum:
          - '1'
          - '2'
          default: '2'
        webhook_timeout_secs:
          type:
          - integer
          - 'null'
        tags:
          type: array
          items:
            type: string
        outbound:
          type: object
          properties:
            channel_limit:
              type: integer
            outbound_voice_profile_id:
              type: string
        inbound:
          type: object
          properties:
            channel_limit:
              type: integer
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
    Payment:
      type: apiKey
      in: header
      name: Authorization
      description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
    agent-memory_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    bearerAuth:
      type: http
      scheme: bearer
    branded-calling_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    collections_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
    number-reputation_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    oauthClientAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
        authorizationCode:
          authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          refreshUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
      description: OAuth 2.0 authentication for Telnyx API and MCP integrations
    outbound-voice-profiles_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    pronunciation-dicts_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
    rcs-registration_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
    stored-payment-transactions_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    transcriptions-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
    web-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    pay-connectors_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key, not the processor bearer token.
    telnyxApiKey:
      type: http
      scheme: bearer
      description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
  categories:
  - communication
  - developer-tools
  docs:
    apiReference: https://developers.telnyx.com
    homepage: https://telnyx.com
    llms: https://telnyx.com/llms.txt