POST
/
v1
/
numbers
/
link
curl --request POST \
  --url https://api.vocode.dev/v1/numbers/link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "outbound_only": true,
  "phone_number": "<string>",
  "telephony_account_connection": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "active": true,
  "example_context": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inbound_agent": {
    "actions": [
      {
        "action_trigger": {
          "config": {},
          "type": "action_trigger_function_call"
        },
        "config": {
          "phone_number": "<string>"
        },
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "action_transfer_call",
        "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "ask_if_human_present_on_idle": true,
    "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": {
      "collect_fields": [
        {
          "description": "<string>",
          "field_type": "field_type_email",
          "label": "<string>",
          "name": "<string>"
        }
      ],
      "content": "<string>",
      "context_endpoint": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prompt_template": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "<string>",
        "required_context_keys": [
          "<string>"
        ],
        "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "run_do_not_call_detection": true,
    "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",
      "pitch": 123,
      "rate": 123,
      "type": "voice_azure",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "voice_name": "<string>"
    },
    "webhook": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "method": "GET",
      "subscriptions": [
        "event_message"
      ],
      "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
outbound_only
boolean
default: false
phone_number
string
required
telephony_account_connection
string
required

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