address_idstring nullable required
bundle_idstring nullable required
carrier'twilio' | 'plivo' required
carrier_type'local' | 'national' | 'mobile' | 'tollfree' | 'shortcode' required
countrystring nullable required
date_createdstring date-time required
date_updatedstring date-time required
forward_tostring nullable
forward_to_enabledboolean
forward_to_formattedstring nullable
inbound_ring_durationinteger nullable
Number of seconds we ring this number on inbound calls before moving on (e.g. to voicemail). null means the default of 30 seconds is used.
is_group_numberboolean required
This field is deprecated and will be removed in a future update. Until then, it is set to false when participants has exactly one user and the phone number doesn't have any of the "shared" configuration set up (e.g. a phone menu, lead-based routing, a dial-out list, an assigned Group, a non-default ring order, etc.), and true otherwise.
is_premiumboolean required
This field is deprecated and will be removed in a future update. Until then, it is always false.
is_verifiedboolean required
last_billed_pricenumber nullable required
local_presence_enabledboolean required
Whether Local Presence can pick this phone number by proximity for a call or SMS made as a user.
mms_enabledboolean required
next_billing_onstring date-time nullable required
non_member_caller_id_enabledboolean required
Whether users who are not members of this phone number can use it as their outbound caller ID.
number_formattedstring required
organization_idstring required
participant_groupsstring[] required
IDs of the Groups assigned to this phone number. Members of these Groups ring on inbound calls, receive notifications for the number, and can use it as outbound caller ID. See the Groups API.
participantsstring[]
IDs of the users assigned directly to this phone number. Members of the Groups in participant_groups also ring on inbound calls, receive notifications for the number, and can use it as outbound caller ID.
phone_numbersstring[]
Present unless participants has exactly one user and the phone number has no shared-number configuration (a phone menu, lead-based routing, a dial-out list, an assigned Group, or a non-default ring order).
phone_numbers_formattedstring[]
Present under the same condition as phone_numbers, with each value formatted for display.
sms_enabledboolean required
supports_mms_to_countriesstring[] required
supports_sms_to_countriesstring[] required
type'internal' | 'external' | 'virtual' required
user_idstring nullable required
This field is deprecated. See the participants and participant_groups fields instead to learn who's assigned to this phone number. This user_id field will be removed in a future update. Until then, it is set to a specific user ID only if the given phone number has a single participant and no additional "shared" configuration (e.g. a phone menu, lead-based routing, a dial-out list, an assigned Group, a non-default ring order, etc.).
voice_agent_caller_id_enabledboolean required
Deprecated. Use voice_agents_local_presence_enabled. This field has the same value as voice_agents_local_presence_enabled, and it will be removed in a future update.
voice_agents_local_presence_enabledboolean required
Whether Local Presence can pick this phone number for calls and SMS that voice agents make in Auto caller ID mode.
voicemail_greeting_urlstring nullable