⚙️ SIP Core Settings

Here are all the options for SIP Core. The configuration file is located at /config/www/sip-config.json in your Home Assistant instance. You can edit this file to change the settings for SIP Core.

danger

The configuration file is currently located at the public www folder, which is not secure and can be accessed by anyone. So while we are working on a more secure solution, we recommend not to use shared passwords. And not to use the card if you have port forwarded the WSS port instead of using the Ingress feature until we have found a secure location for the configuration file.

caution

If your new options doesn't seem to be working, make sure to fully reload your browser with Ctrl + Shift + R.

SIP Core Options

Property	Type	Description	Example
auto_answer	boolean	Whether to automatically answer incoming calls	false
backup_user	SIP User	If no SIP user is configured for the currently logged in user, this SIP user will be used	-
custom_wss_url	string	Custom WebSocket URL to use when ingress is not setup	wss://sip.example.com/ws
ice_config	ICEConfig	-	-
pbx_server	string	The Asterisk server address. Set this when you don't use the add-on. Will use the Home Assistant hostname by default	192.168.0.10
popup_config	Popup Options or Custom Options	Configuration for your popup	-
popup_override_component	null | string	Set this to override the default popup component	my-custom-popup
sip_video	boolean	Experimental Whether to use video in SIP calls	false
users	Array of SIP User's	A array of SIP users. SIP Core will use the one with your HA username	-

Full Example

Complete SIP Core Configuration

loading...

See full example on GitHub

ICE Configuration Options

Property	Type	Description	Example
iceCandidatePoolSize	number	Number of ICE candidates to gather before signaling. Usually 0 or 1.	0
iceGatheringTimeout	number	Timeout in milliseconds for ICE gathering before continuing.	1000
iceServers	RTCIceServer[]	List of STUN/TURN servers for NAT traversal.	[{"urls": ["stun:stun.l.google.com:19302"]}]
iceTransportPolicy	RTCIceTransportPolicy	Which ICE candidates to use: "all" (default) or "relay" (TURN only).	"all"
rtcpMuxPolicy	"require"	Require RTP/RTCP multiplexing. Should always be "require".	"require"

ICE Configuration Example

loading...

See full example on GitHub

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

SIP User Options

Property	Type	Description	Example
display_name	string	The display name of the user	Jordy
extension	string	The SIP extension of the user. Will use the HA username if not set	100
ha_username	string	The Home Assistant username of the user	jordy
password	string	The SIP password of the user	mypassword

SIP User Example

loading...

See full example on GitHub