Skip to main content

⚙️ SIP Core Settings

Here are all the options for SIP Core. The configuration can be set in the SIP Core integration settings.

Settings Reload

SIP Core checks if the settings changed on each window location change and restarts the SIP connection if needed. So you can change the settings and just navigate to another page to apply them.

SIP Core Options

PropertyTypeDescriptionExample
auto_answerbooleanWhether to automatically answer incoming callsfalse
backup_userSIP UserIf no SIP user is configured for the currently logged in user, this SIP user will be used-
custom_wss_urlstringCustom WebSocket URL to use when ingress is not setupwss://sip.example.com/ws
ice_configICEConfig--
pbx_serverstringThe Asterisk server address. Set this when you don't use the add-on. Will use the Home Assistant hostname by default192.168.0.10
popup_configPopup Options or Custom OptionsConfiguration for your popup-
popup_override_componentnull | stringSet this to override the default popup componentmy-custom-popup
sip_videobooleanExperimental Whether to use video in SIP callsfalse
usersArray of SIP User'sA array of SIP users. SIP Core will use the one with your HA username-

ICE Configuration Options

PropertyTypeDescriptionExample
iceCandidatePoolSizenumberNumber of ICE candidates to gather before signaling. Usually 0 or 1.0
iceGatheringTimeoutnumberTimeout in milliseconds for ICE gathering before continuing.1000
iceServersRTCIceServer[]List of STUN/TURN servers for NAT traversal.[{"urls": ["stun:stun.l.google.com:19302"]}]
iceTransportPolicyRTCIceTransportPolicyWhich ICE candidates to use: "all" (default) or "relay" (TURN only)."all"
rtcpMuxPolicy"require"Require RTP/RTCP multiplexing. Should always be "require"."require"

For more information, see the MDN Web Docs on RTCConfiguration.

SIP User Options

PropertyTypeDescriptionExample
display_namestringThe display name of the userJordy
extensionstringThe SIP extension of the user. Will use the HA username if not set100
ha_usernamestringThe Home Assistant username of the userjordy
passwordstringThe SIP password of the usermypassword