> ## 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.

# List imported phone numbers

> Lists the partner's imported DIDs. Use `provider` or `connection_id` to filter the response. The returned phone number `id` is used by `PUT /phone-numbers/{id}` for agent assignment.



## OpenAPI

````yaml /openapi.json get /phone-numbers
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:
  /phone-numbers:
    get:
      tags:
        - Phone Numbers
      summary: List imported phone numbers
      description: >-
        Lists the partner's imported DIDs. Use `provider` or `connection_id` to
        filter the response. The returned phone number `id` is used by `PUT
        /phone-numbers/{id}` for agent assignment.
      operationId: listPhoneNumbers
      parameters:
        - name: provider
          in: query
          required: false
          schema:
            type: string
            enum:
              - TWILIO
              - EXOTEL
              - PLIVO
              - VOBIZ
              - TATA_SMARTFLO
              - SIP
              - VOICELINK
              - MCUBE
          description: Optional provider filter.
        - name: connection_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: Optional connection filter.
      responses:
        '200':
          description: Imported phone numbers.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    properties:
                      phone_numbers:
                        type: array
                        items:
                          $ref: '#/components/schemas/PhoneNumber'
              example:
                success: true
                data:
                  phone_numbers:
                    - id: f1a2c3d4-1111-2222-3333-444455556666
                      connection_id: 9b7f1c44-c87f-4f0c-9124-3c802a9c1a20
                      connection_name: Vobiz Mumbai
                      phone_number: '+918065480085'
                      provider: VOBIZ
                      friendly_name: null
                      status: ACTIVE
                      is_default: false
                      inbound_enabled: false
                      agent: null
                      created_at: '2026-05-20T08:00:00.000Z'
                      updated_at: '2026-05-20T08:00:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    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
    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.

````