A phone number configured for use with Vapi voice assistants for inbound and outbound calling.

VapiPhoneNumber

A phone number configured for use with Vapi voice assistants for inbound and outbound calling.

Properties

id (string): Unique identifier for the phone number.
phoneNumber (string): E.164 formatted phone number (+1234567890).
business ([[Business]]): The business that owns this phone number.
assistant ([[VapiAssistant]]): Default assistant for calls to this number.
name (string): Friendly name for the phone number.
description (string): Description of phone number purpose.
status (string): Status (active, inactive, suspended, cancelled).
type (string): Number type (local, toll-free, mobile, international).
provider (string): Telephony provider (twilio, vonage, bandwidth, vapi).
country (string): Country code (US, GB, CA, etc.).
region (string): State or region code.
city (string): City name.
areaCode (string): Area code.
capabilities (object): Supported capabilities (voice, sms, mms, fax).
direction (string): Supported direction (inbound, outbound, both).
purchaseDate (number): When number was purchased (Unix timestamp).
activationDate (number): When number was activated (Unix timestamp).
monthlyFee (number): Monthly fee in cents.
perMinuteCost (number): Cost per minute in cents.
setupFee (number): One-time setup fee in cents.
inboundSettings (object): Configuration for inbound calls.
outboundSettings (object): Configuration for outbound calls.
voicemailEnabled (boolean): Whether voicemail is enabled.
voicemailUrl ([[URL]]): URL for voicemail webhook.
recordingEnabled (boolean): Whether call recording is enabled.
transcriptionEnabled (boolean): Whether transcription is enabled.
callerIdName (string): Caller ID name for outbound calls.
forwardingEnabled (boolean): Whether call forwarding is enabled.
forwardingNumber (string): Number to forward calls to.
businessHours (object): Business hours configuration.
afterHoursAction (string): Action for after-hours calls (voicemail, forward, reject).
afterHoursMessage (string): Message for after-hours callers.
blockedNumbers (string[]): Numbers blocked from calling.
allowedNumbers (string[]): Allowed numbers (if whitelist mode enabled).
spamFilter (boolean): Whether spam filtering is enabled.
maxConcurrentCalls (number): Maximum concurrent calls allowed.
callRoutingRules (object[]): Rules for routing calls to different assistants.
webhookUrl ([[URL]]): Webhook URL for call events.
webhookSecret (string): Secret for validating webhooks.
totalCalls (number): Total number of calls on this number.
inboundCalls (number): Total inbound calls.
outboundCalls (number): Total outbound calls.
averageCallDuration (number): Average call duration in seconds.
totalMinutes (number): Total minutes used.
monthlyCost (number): Current month cost in cents.
tags (string[]): Tags for organization.
metadata (object): Custom key-value pairs for additional data.
created (number): Timestamp when number was added (Unix timestamp).
updated (number): Timestamp of last update (Unix timestamp).