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

# Retrieve a telephony connection

> Returns a single active partner-owned telephony connection by ID, including all of its active DIDs and the agent linked to each. Use this to keep an external system synced with the connection's numbers and agent assignments as shown in the Vocobase dashboard.



## OpenAPI

````yaml /openapi.json get /telephony/connections/{connection_id}
openapi: 3.1.0
info:
  title: Vocobase Partner API
  version: '2.0'
  description: >-
    API for managing voice AI agents, documents, and calls on the Vocobase
    platform.
servers:
  - url: https://api.vocobase.com/api/v2
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Config
    description: >-
      Read and update partner configuration, webhook settings, and telephony
      credentials.
  - name: Agents
    description: Create, read, update, and delete voice AI agents.
  - name: Voices
    description: >-
      List voice tiers, available voices, and stream preview audio for agent
      configuration.
  - name: Documents
    description: Upload, manage, and delete knowledge base documents.
  - name: Agent Documents
    description: Link and unlink documents to agents for knowledge base integration.
  - name: Calls
    description: Initiate outbound calls and view call history.
  - name: Phone Numbers
    description: >-
      Import DIDs, assign agents for inbound routing, and re-sync carrier
      Application bindings.
  - name: Inbound Routing Policies
    description: >-
      Define pre-answer routing decisions for inbound calls before AI sessions
      are created.
  - name: Telephony Connections
    description: Create, list, rename, and disconnect named V2 telephony connections.
  - name: VoiceLink Management
    description: Manage VoiceLink reseller clients, DID mapping, and readiness sync.
  - name: Projects
    description: Organize agents into projects. Every agent belongs to exactly one project.
  - name: Dictionaries
    description: Speech-recognition dictionary CRUD and agent attachment.
  - name: Sessions
    description: Browser-initiated WebRTC voice sessions for in-app voice agents.
paths:
  /telephony/connections/{connection_id}:
    get:
      tags:
        - Telephony Connections
      summary: Retrieve a telephony connection
      description: >-
        Returns a single active partner-owned telephony connection by ID,
        including all of its active DIDs and the agent linked to each. Use this
        to keep an external system synced with the connection's numbers and
        agent assignments as shown in the Vocobase dashboard.
      operationId: getTelephonyConnection
      parameters:
        - name: connection_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Telephony connection ID.
      responses:
        '200':
          description: >-
            Telephony connection with its active phone numbers and linked
            agents.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    properties:
                      connection:
                        $ref: '#/components/schemas/TelephonyConnection'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    TelephonyConnection:
      type: object
      description: Named V2 telephony connection. Secrets are never returned.
      properties:
        id:
          type: string
          format: uuid
        connection_id:
          type: string
          format: uuid
          description: >-
            Stable connection ID to pass to call-start and phone-number
            endpoints.
        provider:
          type: string
          enum:
            - twilio
            - exotel
            - plivo
            - vobiz
            - tata_smartflo
            - sip
            - voicelink
            - mcube
        provider_key:
          type: string
          enum:
            - TWILIO
            - EXOTEL
            - PLIVO
            - VOBIZ
            - TATA_SMARTFLO
            - SIP
            - VOICELINK
            - MCUBE
        name:
          type: string
        status:
          type: string
          enum:
            - ACTIVE
            - INVALID_CREDENTIALS
            - DISCONNECTED
        is_default:
          type: boolean
        last_verified_at:
          type:
            - string
            - 'null'
          format: date-time
        last_error_message:
          type:
            - string
            - 'null'
        phone_numbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber'
        livekit_sip_uri:
          type:
            - string
            - 'null'
          description: Returned for SIP create responses when available.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PhoneNumber:
      type: object
      description: Imported carrier DID managed through the V2 phone-numbers API.
      properties:
        id:
          type: string
          format: uuid
        connection_id:
          type: string
          format: uuid
          description: Telephony connection that owns this DID.
        connection_name:
          type:
            - string
            - 'null'
          description: Display name of the owning telephony connection.
        phone_number:
          type: string
          description: >-
            DID in E.164 format. A connection-detail response may also include
            the MCube default exeNumber in national format; manually imported
            MCube DIDs are always E.164.
          example: '+918065480085'
        provider:
          type: string
          enum:
            - TWILIO
            - EXOTEL
            - PLIVO
            - VOBIZ
            - TATA_SMARTFLO
            - SIP
            - VOICELINK
            - MCUBE
          description: Carrier connection that owns this DID.
        friendly_name:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
        is_default:
          type: boolean
          description: True when this DID is the connection's default outbound from-number.
        inbound_enabled:
          type: boolean
          description: >-
            True when this active DID is eligible to receive inbound calls for
            its assigned agent. Only one active row per DID can have this set to
            true.
        agent:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
          description: >-
            Assigned agent, or null when unassigned. The DID receives inbound
            calls only when `inbound_enabled` is true.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - success
        - error
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: UNAUTHORIZED
              message: Invalid or missing API key
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: NOT_FOUND
              message: Resource not found
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: INTERNAL_ERROR
              message: An unexpected error occurred
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key in format: `rg_live_xxxx`. Pass as a Bearer token in the
        Authorization header.

````