Skip to main content
POST
Import Phone Number

Authorizations

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

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

Response

boolean
Whether the request succeeded.
string
Human-readable status message.
object
Returned data.

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