Skip to main content
POST
/
api
/
v1
/
phone-numbers
/
import
/
Import Phone Number
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>"
}
'
{
  "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"
  }
}

Authorizations

X-Api-Key
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.

Body

phone
string
The contact phone number in E.164 format. Example: +14157774444.
type
string
The imported number type. Use the value supported by your SIP or telephony setup.
name
string
The internal name of the resource. Use a clear name that your team can recognize in the dashboard and API responses.
termination_uri
string
The SIP termination URI for routing calls to the imported number.
sip_username
string
The SIP username for the imported number.
sip_password
string
The SIP password for the imported number. Treat this value as sensitive.

Response

success
boolean
Whether the request succeeded.
message
string
Human-readable status message.
data
object
Returned data.
{
  "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"
  }
}

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