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

# Import Phone Number

> Import Phone Number.

### Authorizations

<ParamField header="X-Api-Key" type="string" required>
  Your Agni API key used to authenticate the request. Pass it in the `X-Api-Key` header. Find or rotate it from your Ravan AI account settings.
</ParamField>

***

### Body

<ParamField body="phone" type="string">
  The contact phone number in E.164 format. Example: `+14157774444`.
</ParamField>

<ParamField body="type" type="string">
  The imported number type. Use the value supported by your SIP or telephony setup.
</ParamField>

<ParamField body="name" type="string">
  The internal name of the resource. Use a clear name that your team can recognize in the dashboard and API responses.
</ParamField>

<ParamField body="termination_uri" type="string">
  The SIP termination URI for routing calls to the imported number.
</ParamField>

<ParamField body="sip_username" type="string">
  The SIP username for the imported number.
</ParamField>

<ParamField body="sip_password" type="string">
  The SIP password for the imported number. Treat this value as sensitive.
</ParamField>

***

### Response

<ResponseField name="success" type="boolean">
  Whether the request succeeded.
</ResponseField>

<ResponseField name="message" type="string">
  Human-readable status message.
</ResponseField>

<ResponseField name="data" type="object">
  Returned data.

  <Expandable title="data">
    <ResponseField name="id" type="string">
      id field.
    </ResponseField>

    <ResponseField name="phone" type="string">
      phone field.
    </ResponseField>

    <ResponseField name="type" type="string">
      type field.
    </ResponseField>

    <ResponseField name="name" type="string">
      name field.
    </ResponseField>

    <ResponseField name="termination_uri" type="string">
      termination\_uri field.
    </ResponseField>

    <ResponseField name="sip_username" type="string">
      sip\_username field.
    </ResponseField>

    <ResponseField name="sip_password" type="string">
      sip\_password field.
    </ResponseField>

    <ResponseField name="status" type="string">
      status field.
    </ResponseField>

    <ResponseField name="created_at" type="string">
      created\_at field.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200 theme={null}
  {
    "success": true,
    "message": "Request completed successfully",
    "data": {
      "id": "id_123",
      "phone": "+14155550100",
      "type": "twilio",
      "name": "Support Bot",
      "termination_uri": "sip:example@provider.com",
      "sip_username": "sip-user",
      "sip_password": "secret-password",
      "status": "active",
      "created_at": "2026-03-14T12:00:00Z"
    }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml POST /api/v1/phone-numbers/import/
openapi: 3.0.1
info:
  title: Agni API
  version: 1.0.0
  description: >-
    Agni API for managing agents, tools, widget settings, telephony, and
    integrations.
servers:
  - url: https://api.ravan.ai
security:
  - X-Api-Key: []
tags:
  - name: AgentService
  - name: AgentToolService
  - name: WidgetSettingsService
  - name: PhoneService
  - name: AppointmentService
  - name: GHLService
  - name: CalComService
  - name: CampaignService
  - name: ContactService
  - name: CallingService
  - name: RAGService
  - name: ModelService
  - name: HealthService
paths:
  /api/v1/phone-numbers/import/:
    post:
      tags:
        - PhoneService
      summary: Import Phone Number
      operationId: ImportPhoneNumber
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportPhoneNumberRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportPhoneNumberResponse'
components:
  schemas:
    ImportPhoneNumberRequest:
      type: object
      properties:
        phone:
          type: string
          description: Phone number to import (E.164 format)
        type:
          type: string
          description: Type of phone number (e.g. sip, pstn)
        name:
          type: string
          description: Friendly name for the number
        termination_uri:
          type: string
          description: SIP termination URI
        sip_username:
          type: string
          description: SIP username for authentication
        sip_password:
          type: string
          description: SIP password for authentication
    ImportPhoneNumberResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          properties:
            id:
              type: string
            phone:
              type: string
            type:
              type: string
            name:
              type: string
            termination_uri:
              type: string
            sip_username:
              type: string
            sip_password:
              type: string
            status:
              type: string
            created_at:
              type: string
  securitySchemes:
    X-Api-Key:
      type: apiKey
      in: header
      name: X-Api-Key

````