This page is part of archived documentation for openHAB 3.4. Go to the current stable version
# oh-sipclient - SIP Client
SIP Client to start and answer SIP calls
oh-sipclient component allows to call and answer SIP calls using the JsSIP (opens new window) library.
The color of the call icon depends on the state of the connection to the SIP server:
- yellow: no connection yet, but
oh-sipclienttries to establish the connection
- green: successfully connected to the SIP server, ready to perform calls
When the call button is green, a tap on it either directly starts a call or opens a popup to choose from the phonebook. As soon as you start an outgoing call, a hangup button will be displayed. The hangup button is coloured yellow, if the call has not been accepted yet. If the call has been accepted, the hangup button will become red.
When a call is coming in, a green accept and a red decline button are displayed. If the call is accepted, a red hangup button is accepted.
oh-sipclient also supports video calling, playing ringtone as well as ringback sounds and performing DTMF operations, e.g. for doorstations to open the door.
iconSize Icon Size INTEGER
Size of the icon(s) in px
websocketUrl Websocket URL* TEXT
Full URL of the WebRTC SIP websocket, e.g. 'wss://siphost:8089/ws' or relative path, e.g. '/ws', for Android & iOS, you need wss (WebSocket secured)
domain Domain* TEXT
username Username* TEXT
password Password* TEXT
enableTones Enable tones BOOLEAN
Enable ringback and ring tone. Not recommended for mobile browsers, might cause issues. Ring tone might only work after interaction with the webpage.
hideCallerId Hide caller id BOOLEAN
Hides the username of the remote party on incoming call
phonebook Phonebook* TEXT
Single SIP Address (phone number) for a single call target or a comma-separated list of 'phoneNumber=name' for multiple call targets
enableVideo Enable Video BOOLEAN
Enable video calling
enableLocalVideo Enable Local Video View BOOLEAN
Display the local camera on video calls
defaultVideoAspectRatio Default Aspect Ratio TEXT
Default video aspect ratio used to size the widget before video is loaded. Defaults to 4/3, 16/9 and 1 are common alternatives.
dtmfString DTMF String TEXT
Display a button to send a preset DTMF string while in calls for remote doors, gates, etc...
enableSIPDebug Enable SIP debugging to the console BOOLEAN
# Inherited Properties
iconSize property is forwarded to the
icon-size property and the CSS
height attribute of the
f7-button (opens new window).
defaultVideoAspectRatio property is forwarded to the CSS
aspect-ratio attribute of the