POST
/
v1
/
numbers
/
buy
curl --request POST \
  --url https://api.vocode.dev/v1/numbers/buy \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "area_code": "<string>",
  "telephony_account_connection": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "telephony_provider": "vonage"
}'
{
  "active": true,
  "example_context": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inbound_agent": {
    "actions": [],
    "context_endpoint": "<string>",
    "conversation_speed": 123,
    "endpointing_sensitivity": "auto",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "initial_message": "<string>",
    "initial_message_delay": 123,
    "interrupt_sensitivity": "low",
    "ivr_navigation_mode": "default",
    "language": "en",
    "noise_suppression": true,
    "openai_account_connection": {
      "credentials": {
        "openai_api_key": "<string>"
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "account_connection_openai",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "openai_model_name_override": "<string>",
    "prompt": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vector_database": {
      "api_environment": "<string>",
      "api_key": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "index": "<string>",
      "type": "vector_database_pinecone",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "voice": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "voice_azure",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "voice_name": "<string>"
    },
    "webhook": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subscriptions": [],
      "url": "<string>",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "label": "<string>",
  "number": "<string>",
  "outbound_only": true,
  "telephony_account_connection": {
    "credentials": {
      "twilio_account_sid": "<string>",
      "twilio_auth_token": "<string>"
    },
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "account_connection_twilio",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "telephony_provider": "vonage",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
area_code
string
telephony_account_connection
string
telephony_provider
enum<string>
default: vonage
Available options:
vonage,
twilio

Response

200 - application/json
active
boolean
default: true
example_context
object
id
string
required
inbound_agent
object
required
label
string
default:
number
string
required
outbound_only
boolean
default: false
telephony_account_connection
object
telephony_provider
enum<string>
default: vonage
Available options:
vonage,
twilio
user_id
string
required
Get NumberUpdate Number