Sign in
Numbers

Set call forwarding

REQUIRED SCOPES <code>['numbers:write']</code><br>Set call forwarding

post/numbers/{number}/call_forwarding

Path parameters

numberstring required

The ID of the Number

Request body

numberstring required

Phone number

is_activeboolean required

Is active

extensioninteger nullable

Extension

is_call_whisperboolean

Play short message before the call

call_whisperstring nullable

A short message that plays before the call

is_screeningboolean

When enabled, you will be prompted to accept the call when answering the forwarded call

Example request

{
  "is_active": true
}

Response

OK

idinteger
organization_idinteger
countrystring
statestring
citystring
numberstring
number_vendor_idinteger
country_calling_codestring
national_numberstring
formattedNumberstring
formatted_numberstring
short_codeinteger
is_landlineinteger
is_toll_freeboolean
is_mobileboolean
is_aircallboolean
voiceboolean
use_organization_call_settingsboolean
voice_outboundboolean
mmsboolean
disabledboolean
has_profileboolean
verified_statusstring
numberable_idinteger
numberable_typestring

Changes

No recorded changes to this endpoint across all 2 revisions of this API.