Sign in

v2

latestOpenAPI 3.1.02026-08-05100545344.4 KB
phoneNumbers

Import phone number

Imports a phone number into your workspace for direct SIP dialing when your telephony provider does not offer elastic SIP trunking. Set provider_name to select the provider. For five9, ringcx, and zoom, Synthflow auto-fills the SIP domain (and for Five9, the outbound TLS proxy) from the deployment region, so you only need workspace_id, phone_number, provider_name, and optionally friendly_name. Credentials are not required for those providers. For custom trunks, set uac_enabled to true when your carrier or PBX requires outbound SIP REGISTER traffic, and optionally set uac_register_expires (60 to 3600 seconds, default 300).

post/custom-numbers

Headers

Authorizationstring required

Bearer authentication

Request body

workspace_idstring required

The workspace ID to associate the phone number with.

phone_numberstring required

The phone number to import. For most providers use E.164. Five9 and Zoom also accept non-E.164 integration or extension identifiers.

friendly_namestring

A human-readable name for the phone number.

provider_name'twilio' | 'telnyx' | 'vonage' | 'ring_central' | 'ringcx' | 'custom' | 'zoom' | 'five9'

Telephony provider for the imported number. Omit or use custom for a bring-your-own SIP trunk. Use five9, ringcx, or zoom for those integrations; SIP domain defaults are applied automatically for those three only.

trunk_usernamestring

Optional SIP trunk username for authentication. Required when uac_enabled is true. Not used for five9, ringcx, or zoom.

trunk_pwdstring

Optional SIP trunk password for authentication. Required when uac_enabled is true. Not used for five9, ringcx, or zoom.

termination_uristring

SIP domain or termination URI used for outbound calls (maps to sip_term_uri). Required for custom, twilio, telnyx, vonage, and ring_central. Optional for five9 (regional IP), ringcx (sip.ringcentral.com), and zoom (sip.zoom.com), which are filled automatically when omitted. Requests that omit it for a non-auto provider return 400.

sip_outbound_proxystring

Optional outbound proxy used for outbound calls and SIP REGISTER requests. For five9, Synthflow sets the regional TLS proxy automatically when omitted.

sip_auth_usernamestring

Optional auth username used for SIP REGISTER requests when it differs from trunk_username.

uac_enabledboolean

When true, Synthflow sends outbound SIP REGISTER traffic to your carrier or PBX so it can authenticate outbound calls. Requires trunk_username and trunk_pwd. Defaults to false.

uac_register_expiresinteger

SIP registration refresh interval in seconds. Only used when uac_enabled is true (or for providers that register implicitly, such as RingCentral). Whole numbers only, between 60 and 3600. Defaults to 300.

Response

200

statusstring

Whether the request was successful.