SIP Trunks

Create SIP Trunk

Create a new SIP trunk with credentials, address, and proxy settings

Docs

post/user/phone-numbers/sip-trunks

Request

  • Base URL: https://app.famulor.de/api
  • URL: https://app.famulor.de/api/user/phone-numbers/sip-trunks
  • Auth: HTTP bearer

Request body

sip_trunk_typestring required

The type of SIP trunk: extension for a SIP extension, or number for a phone number (DID). This determines the expected format of the phone_number field.

phone_numberstring required

The SIP extension (1-15 characters, e.g. 1000) when sip_trunk_type is extension, or a phone number in E.164 format (e.g. +14155551234) when sip_trunk_type is number.

nicknamestring

A short, human-friendly label for the trunk (e.g. "Provider X — Main"). Maximum 50 characters.

sip_usernamestring required

Username for SIP authentication (3-128 characters)

sip_passwordstring required

Password for SIP authentication (minimum 3 characters)

sip_addressstring required

The SIP server address without port (e.g. sip.provider.com)

sip_calling_formatstring required

The outbound calling number format:

  • +e164 - International with + prefix (e.g. +12025550123)
  • e164 - International without + prefix (e.g. 12025550123)
  • national - National format without country code (e.g. 0741926265)
inbound_authorization_typestring required

How inbound calls are authenticated:

  • auth - Uses the same SIP username and password configured for outbound
  • ip - Whitelists specific IP addresses (requires allowed_inbound_ips)
country_codestring required

ISO 3166-2 country code where the SIP trunk is located (e.g. US, GB, DE). When sip_trunk_type is number, the country is auto-detected from the phone number if possible.

outbound_proxyboolean

Route outbound calls through a fixed IP address. Default: false. Only enable this if your SIP provider requires IP-based authentication for outbound traffic.

Response

Created

messagestring

Success message

dataobject

The created SIP trunk object (same fields as Get SIP trunk)

Changes

No recorded changes to this operation across all 1 revision of this API.