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

# Retrieve detailed information about a specific phone number configuration

> Retrieve detailed information about a specific phone number configuration. The response includes:

- Phone number details and type (Import Phone Number or PIA-managed)
- Associated AI agent information if the number is linked
- SIP trunk configuration for Import Phone Numbers
- Routing rules and dispatch configurations



## OpenAPI

````yaml /api-reference/openapi.json get /v1/phone-numbers/{phone_number_id}
openapi: 3.1.0
info:
  title: Verbex Platform API
  description: API for managing AI agents, calls, phone numbers, and more.
  version: 1.0.0
servers: []
security: []
tags:
  - name: Knowledge Bases
    description: >-
      Create and manage knowledge bases, ingest documents into them, and search
      them semantically.


      **Authentication.** Every request carries a bearer token: `Authorization:
      Bearer <API_TOKEN>`. That is the only credential a client sends. The
      gateway resolves your identity from it and injects the tenant headers the
      service reads internally, so clients never send `x-user-org-id` or
      `x-verbex-id` themselves.


      **Tenancy is enforced on every route.** A knowledge base belongs to one
      organization and one user. Requesting one your token does not own returns
      `404 Knowledge base not found`, never `403`. This is deliberate: a
      nonexistent ID, a malformed ID and someone else's ID are indistinguishable
      in the response, so the API cannot be used to probe for other tenants'
      data. If you get a `404` on an ID you are certain exists, suspect the
      token before you suspect the ID.


      **Ingestion is asynchronous.** File upload and website crawl both answer
      `202` as soon as the material is stored and the job is queued. Parsing,
      chunking, embedding and indexing happen afterwards in a worker. Poll the
      document status endpoint until it reports `completed` before expecting
      search to see the content. That gap is the most common source of "why
      isn't my data showing up".


      **There is no document update endpoint.** Every submission mints a new
      `document_id`, so re-uploading a file or re-crawling the same URLs creates
      a second document while the first remains. To refresh material, delete
      then resubmit — and note that the sequence is not atomic.
paths:
  /v1/phone-numbers/{phone_number_id}:
    get:
      tags:
        - Phone Numbers
      summary: >-
        Retrieve detailed information about a specific phone number
        configuration
      description: >-
        Retrieve detailed information about a specific phone number
        configuration. The response includes:


        - Phone number details and type (Import Phone Number or PIA-managed)

        - Associated AI agent information if the number is linked

        - SIP trunk configuration for Import Phone Numbers

        - Routing rules and dispatch configurations
      operationId: get_phone_number_v1_phone_numbers__phone_number_id__get
      parameters:
        - name: phone_number_id
          in: path
          required: true
          schema:
            type: string
            title: Phone Number Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/GetSIPPhoneNumberResponse'
                  - $ref: '#/components/schemas/GetPiaPhoneNumberResponse'
                  - $ref: '#/components/schemas/GetTwilioPhoneNumberResponse'
                title: >-
                  Response Get Phone Number V1 Phone Numbers  Phone Number Id 
                  Get
        '404':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/app__phone_numbers__schemas__ErrorResponse
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/app__phone_numbers__schemas__ErrorResponse
          description: Internal Server Error
components:
  schemas:
    GetSIPPhoneNumberResponse:
      properties:
        _id:
          type: string
          title: Id
          description: Unique identifier for this phone number record
        provider:
          type: string
          const: sip
          title: Provider
          description: Indicates this is an Import Phone Number (SIP provider)
          default: sip
        phone_number:
          type: string
          title: Phone Number
          description: >-
            The phone number in E.164 format, including country code (e.g.,
            +14155552671)
        friendly_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Friendly Name
          description: A human-readable label for this phone number
        sip_termination_uri:
          anyOf:
            - type: string
            - type: 'null'
          title: Sip Termination Uri
          description: The SIP URI where calls are terminated
        sip_trunk_username:
          anyOf:
            - type: string
            - type: 'null'
          title: Sip Trunk Username
          description: Username for SIP trunk authentication
        sip_trunk_password:
          anyOf:
            - type: string
            - type: 'null'
          title: Sip Trunk Password
          description: Password for SIP trunk authentication
        inbound_agent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Inbound Agent Id
          description: ID of the AI agent handling incoming calls
        outbound_agent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Outbound Agent Id
          description: ID of the AI agent used for outbound calls
        sip_infra_region:
          type: string
          enum:
            - global
            - bd
            - bd_link3
          title: Sip Infra Region
          description: >-
            The infrastructure region for SIP routing: 'global' or 'bd'
            (Bangladesh)
          default: global
      type: object
      required:
        - phone_number
      title: GetSIPPhoneNumberResponse
    GetPiaPhoneNumberResponse:
      properties:
        _id:
          type: string
          title: Id
          description: Unique identifier for this phone number record
        provider:
          type: string
          const: pia
          title: Provider
          description: Indicates this is a Pia Platform managed phone number
          default: pia
        phone_number:
          type: string
          title: Phone Number
          description: The phone number in E.164 format (e.g., +14155552671)
        friendly_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Friendly Name
          description: A human-readable label for this phone number
        inbound_agent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Inbound Agent Id
          description: ID of the AI agent handling incoming calls
        outbound_agent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Outbound Agent Id
          description: ID of the AI agent used for outbound calls
      type: object
      required:
        - phone_number
      title: GetPiaPhoneNumberResponse
    GetTwilioPhoneNumberResponse:
      properties:
        _id:
          type: string
          title: Id
          description: Unique identifier for this phone number record
        provider:
          type: string
          const: twilio
          title: Provider
          description: Indicates this is a direct Twilio integration phone number
          default: twilio
        phone_number:
          type: string
          title: Phone Number
          description: >-
            The phone number in E.164 format, including country code (e.g.,
            +14155552671)
        friendly_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Friendly Name
          description: A human-readable label for this phone number
        twilio_account_sid:
          anyOf:
            - type: string
            - type: 'null'
          title: Twilio Account Sid
          description: The Twilio Account SID used for API authentication
        twilio_auth_token:
          anyOf:
            - type: string
            - type: 'null'
          title: Twilio Auth Token
          description: The Twilio Auth Token used for API authentication
        inbound_agent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Inbound Agent Id
          description: ID of the AI agent handling incoming calls
        outbound_agent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Outbound Agent Id
          description: ID of the AI agent used for outbound calls
      type: object
      required:
        - phone_number
      title: GetTwilioPhoneNumberResponse
    app__phone_numbers__schemas__ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A short error code identifying the type of error that occurred
        message:
          type: string
          title: Message
          description: >-
            A detailed human-readable message explaining the error and possible
            solutions
      type: object
      required:
        - error
        - message
      title: ErrorResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````