Skip to main content
POST
/
api
/
v1
/
phone-numbers
/
create
/
telephony
/
Create Telephony Type
curl --request POST \
  --url https://api.ravan.ai/api/v1/phone-numbers/create/telephony/ \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "type": "<string>",
  "owner_type": "<string>",
  "friendly_name": "<string>",
  "client_id": "<string>",
  "client_secret": "<string>"
}
'
{
  "success": true,
  "message": "Request completed successfully",
  "data": {
    "id": "id_123",
    "type": "twilio",
    "owner_type": "twilio",
    "friendly_name": "Support Bot",
    "status": "active",
    "created_at": "2026-03-14T12:00:00Z",
    "termination_uri": "sip:example@provider.com",
    "sip_username": "sip-user",
    "sip_password": "secret-password"
  }
}

​
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

​
type
string
The telephony provider type to configure. Use the provider value supported by your account.
​
owner_type
string
The owner type for the connected account or resource. Use the provider-specific value expected by the integration.
​
friendly_name
string
A human-readable label for the phone number. Use a name that helps your team identify its purpose.
​
client_id
string
The OAuth client ID from the connected provider.
​
client_secret
string
The OAuth client secret from the connected provider. 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",
    "type": "twilio",
    "owner_type": "twilio",
    "friendly_name": "Support Bot",
    "status": "active",
    "created_at": "2026-03-14T12:00:00Z",
    "termination_uri": "sip:example@provider.com",
    "sip_username": "sip-user",
    "sip_password": "secret-password"
  }
}

Authorizations

​
X-Api-Key
string
header
required

Body

application/json
​
type
string

Telephony provider type (e.g. twilio, vonage)

​
owner_type
string

Owner type (e.g. organization, user)

​
friendly_name
string

Human-readable label for this telephony config

​
client_id
string

Provider client/account ID

​
client_secret
string

Provider client secret or auth token

Response

200 - application/json

Successful response

​
success
boolean
​
message
string
​
data
object