Import Phone Number

Import Phone Number.

POST /api/v1/phone-numbers/import

Import Phone Number

cURL

curl --request POST \
  --url https://api.ravan.ai/api/v1/phone-numbers/import/ \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "phone": "<string>",
  "type": "<string>",
  "name": "<string>",
  "termination_uri": "<string>",
  "sip_username": "<string>",
  "sip_password": "<string>"
}
'

200

{
  "success": true,
  "message": "Request completed successfully",
  "data": {
    "id": "id_123",
    "phone": "[phone]",
    "type": "twilio",
    "name": "Support Bot",
    "termination_uri": "sip:[e-mail]",
    "sip_username": "sip-user",
    "sip_password": "secret-password",
    "status": "active",
    "created_at": "2026-03-14T12:00:00Z"
  }
}

Authorizations

X-Api-Key · string · required

Your Agni API key. Find it in your RavanAi.

---

Body

phone · string

Phone number to import (E.164 format)

type · string

Type of phone number (e.g. sip, pstn)

name · string

Friendly name for the number

termination_uri · string

SIP termination URI

sip_username · string

SIP username for authentication

sip_password · string

SIP password for authentication

---

Response

success · boolean

Whether the request succeeded.

message · string

Human-readable status message.

data · object

Returned data.

Show data

id · string

id field.

phone · string

phone field.

type · string

type field.

name · string

name field.

termination_uri · string

termination_uri field.

sip_username · string

sip_username field.

sip_password · string

sip_password field.

status · string

status field.

created_at · string

created_at field.

200

{
  "success": true,
  "message": "Request completed successfully",
  "data": {
    "id": "id_123",
    "phone": "[phone]",
    "type": "twilio",
    "name": "Support Bot",
    "termination_uri": "sip:[e-mail]",
    "sip_username": "sip-user",
    "sip_password": "secret-password",
    "status": "active",
    "created_at": "2026-03-14T12:00:00Z"
  }
}

Authorizations

X-Api-Key · string · header · required

Body

application/json

phone · string

Phone number to import (E.164 format)

type · string

Type of phone number (e.g. sip, pstn)

name · string

Friendly name for the number

termination_uri · string

SIP termination URI

sip_username · string

SIP username for authentication

sip_password · string

SIP password for authentication

Response

200 - application/json

Successful response

success · boolean

message · string

data · object

Show child attributes