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
Deprecated. The distinction between personal and group numbers is being removed, and is_group_number will be removed in a future update.
is_premiumboolean required
is_verifiedboolean required
last_billed_pricenumber nullable required
mms_enabledboolean required
next_billing_onstring date-time nullable required
number_formattedstring required
organization_idstring required
phone_numbers_formattedstring[]
sms_enabledboolean required
supports_mms_to_countriesstring[] required
supports_sms_to_countriesstring[] required
type'internal' | 'external' | 'virtual' required
user_idstring nullable required
Deprecated. Set to the sole member's user ID for single-member numbers, otherwise null. user_id will be removed in a future update.
voicemail_greeting_urlstring nullable