You need the "Manage Team Phone Numbers" permission to update a group number. You can only update your own personal numbers.
You can:
- Change a `label` of your number.
- Set up call forwarding via `forward_to` and `forward_to_enabled`.
- Set up a voicemail greeting by including a URL of an mp3 recording in `voicemail_greeting_url`. We require the URL to be secure (i.e. starting with https://).
- Modify which team members are part of a group number via `participants`. This should be a list of user IDs.
- Modify which external phone numbers are part of a group number via `phone_numbers`. This should be a list of phone numbers in E.164 international format, e.g. "+16503334444".
- Change how long (in seconds, 15-90) the number rings on inbound calls before moving on (e.g. to voicemail) via `inbound_ring_duration`.
Request
This endpoint expects an object.
forward_to_enabledbooleanOptional
inbound_ring_durationintegerOptional15-90
Number of seconds (15-90) to ring this number on inbound calls before moving on (e.g. to voicemail).
participantslist of stringsOptional
phone_numberslist of stringsOptional
press_1_to_acceptbooleanOptional
voicemail_greeting_urlstring or nullOptional
Response
Successful response
last_billed_pricedouble or null
next_billing_ondatetime or null
supports_mms_to_countrieslist of strings
supports_sms_to_countrieslist of strings
is_group_numberbooleanDeprecated
This field is deprecated and will be removed in a future update. Until then, it is set to false when the phone number has exactly one member (as defined by the participants field) and doesn’t have any of the “shared” configuration set up (e.g. a phone menu, lead-based routing, a non-default ring order, etc.), and true otherwise.
user_idstring or nullDeprecated
This field is deprecated. See the participants field 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 non-default ring order, etc.).
forward_tostring or nullOptional
forward_to_enabledbooleanOptional
forward_to_formattedstring or nullOptional
inbound_ring_durationinteger or nullOptional
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.
participantslist of stringsOptional
Every member of the phone number, as user IDs. If this field is absent, see user_id for the sole member.
phone_numberslist of stringsOptional
Present unless the phone number has exactly one member and no shared-number configuration (a phone menu, lead-based routing, a dial-out list, or a non-default ring order).
phone_numbers_formattedlist of stringsOptional
Present under the same condition as phone_numbers, with each value formatted for display.
press_1_to_acceptbooleanOptional
voicemail_greeting_urlstring or nullOptional
was_portedbooleanOptional
