Update a phone number

View as Markdown
Updates the configuration of a phone number.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

phone_number_slugstringRequired

The phone number slug (phone number without the leading +).

Request

This endpoint expects an object.
friendly_namestringOptional

A human-readable name for the phone number.

sip_auth_usernamestringOptional
SIP authentication username.
sip_outbound_proxystringOptional
SIP outbound proxy.
sip_term_uristringOptional

SIP termination URI / SIP domain. Required when changing the SIP domain for providers other than five9, ringcx, and zoom. You may also send termination_uri as an alias; it is mapped to sip_term_uri.

termination_uristringOptional

Alias for sip_term_uri (SIP domain). Required when setting the domain for providers other than five9, ringcx, and zoom.

provider_nameenumOptional

Telephony provider. When set to a non-auto provider without a SIP domain, the request fails with 400.

trunk_usernamestringOptional

SIP trunk username for authentication. Required when enabling uac_enabled.

trunk_pwdstringOptional

SIP trunk password for authentication. Required when enabling uac_enabled.

uac_enabledbooleanOptional

When true, Synthflow sends outbound SIP REGISTER traffic to your carrier or PBX. Requires trunk_username and trunk_pwd when enabling registration.

uac_register_expiresintegerOptional60-3600
SIP registration refresh interval in seconds. Whole numbers only, between 60 and 3600. Defaults to 300.

Response

200
statusstringOptional
Whether the request was successful.

Errors

400
Bad Request Error