{"id":13550,"date":"2026-04-12T10:03:23","date_gmt":"2026-04-12T10:03:23","guid":{"rendered":"https:\/\/www.siperb.com\/kb\/?p=13550"},"modified":"2026-04-15T20:31:18","modified_gmt":"2026-04-15T20:31:18","slug":"web-phone-config-options","status":"publish","type":"post","link":"https:\/\/www.siperb.com\/kb\/web-phone-config-options\/","title":{"rendered":"Configuration Options"},"content":{"rendered":"\n

The ProvisionPhone()<\/code> method accepts a configuration object that controls how the phone UI behaves, what features are enabled, and how it integrates with your application. This article documents all available options and how to use them.<\/p>\n\n\n\n

ProvisionPhone() Options<\/h2>\n\n\n\n

Pass a configuration object to ProvisionPhone()<\/code> with any or all of the following options:<\/p>\n\n\n\n

Option<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>
Provisioning<\/code><\/td>object<\/td>Yes<\/td>The provisioning object from GetProvisioning()<\/code> or a manually constructed object with SIP credentials<\/td><\/tr>
PhoneFrame<\/code><\/td>HTMLIFrameElement<\/td>Yes<\/td>The <iframe><\/code> element where the phone UI will render<\/td><\/tr>
ProfileUserId<\/code><\/td>string<\/td>Yes<\/td>A unique identifier for this phone instance (e.g., a session ID or user identifier)<\/td><\/tr>
SessionId<\/code><\/td>string<\/td>Yes<\/td>The session identifier, typically the SessionToken<\/code> from Login()<\/code><\/td><\/tr>
UserId<\/code><\/td>string<\/td>Yes<\/td>The user identifier from your session<\/td><\/tr>
EnableAvatar<\/code><\/td>boolean<\/td>No<\/td>Show user avatar in the phone UI (default: true<\/code>)<\/td><\/tr>
EnableSettings<\/code><\/td>boolean<\/td>No<\/td>Show settings panel accessible from the phone UI (default: false<\/code>)<\/td><\/tr>
EnableDialPad<\/code><\/td>boolean<\/td>No<\/td>Show dial pad for manual number entry (default: true<\/code>)<\/td><\/tr>
EnableCallTransfer<\/code><\/td>boolean<\/td>No<\/td>Enable call transfer functionality (default: true<\/code>)<\/td><\/tr>
EnableCallHold<\/code><\/td>boolean<\/td>No<\/td>Enable call hold functionality (default: true<\/code>)<\/td><\/tr>
EnableCallMute<\/code><\/td>boolean<\/td>No<\/td>Enable microphone mute during calls (default: true<\/code>)<\/td><\/tr>
EnableCallRecording<\/code><\/td>boolean<\/td>No<\/td>Enable call recording (if your account supports it) (default: true<\/code>)<\/td><\/tr>
EnableDeviceSelector<\/code><\/td>boolean<\/td>No<\/td>Show audio device (microphone\/speaker) selector in settings (default: true<\/code>)<\/td><\/tr>
UiThemeStyle<\/code><\/td>string<\/td>No<\/td>UI theme: 'light'<\/code>, 'dark'<\/code>, or 'system'<\/code> (follows OS preference) (default: 'light'<\/code>)<\/td><\/tr>
Language<\/code><\/td>string<\/td>No<\/td>UI language code (e.g., 'en'<\/code>, 'es'<\/code>, 'fr'<\/code>) or 'auto'<\/code> to detect from browser (default: 'auto'<\/code>)<\/td><\/tr>
OnLoad<\/code><\/td>function<\/td>No<\/td>Callback function invoked when the phone is fully loaded and ready to use<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

ProvisionPhone() Example<\/h2>\n\n\n\n
const<\/span> phone = await<\/span> window.Siperb.\"ProvisionPhone\"<\/span>({\n    Provisioning: provisioning,\n    PhoneFrame: document.getElementById(\"phone-iframe\"<\/span>),\n    ProfileUserId: \"user-session-001\"<\/span>,\n    SessionId: session.SessionToken,\n    UserId: session.UserId,\n    EnableAvatar: true<\/span>,\n    EnableSettings: true<\/span>,\n    EnableDialPad: true<\/span>,\n    EnableCallTransfer: true<\/span>,\n    EnableCallMute: true<\/span>,\n    UiThemeStyle: 'dark'<\/span>,\n    Language: 'en'<\/span>,\n    OnLoad: () => {\n        \/\/ Phone is ready<\/span>\n        console.log('Phone loaded'<\/span>);\n    }\n});<\/code><\/pre>\n\n\n\n
Manual Provisioning Object<\/h2>\n\n\n\n
For direct PBX connections (bypassing the Siperb proxy), you can construct a manual provisioning object instead of calling GetProvisioning()<\/code>. This object contains SIP credentials and connection details.<\/p>\n\n\n\n
Property<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
RegistrationMode<\/code><\/td>string<\/td>Connection type: \"Socket\"<\/code> for direct PBX connection, \"Proxy\"<\/code> for Siperb proxy<\/td><\/tr>
profileName<\/code><\/td>string<\/td>Display name for this phone profile (e.g., \u201cOffice Phone\u201d)<\/td><\/tr>
SipWssServer<\/code><\/td>string<\/td>The PBX server address (hostname or IP)<\/td><\/tr>
SipUsername<\/code><\/td>string<\/td>The SIP username for authentication<\/td><\/tr>
SipPassword<\/code><\/td>string<\/td>The SIP password for authentication<\/td><\/tr>
SipDomain<\/code><\/td>string<\/td>The SIP domain (usually the same as the server address)<\/td><\/tr>
ProfileUserName<\/code><\/td>string<\/td>The caller ID display name (appears on inbound calls)<\/td><\/tr>
SipContact<\/code><\/td>string<\/td>Contact user parameter; leave empty string if not needed<\/td><\/tr>
SipWebsocketPort<\/code><\/td>number<\/td>The WebSocket port for SIP over WebSocket (e.g., 8089<\/code>)<\/td><\/tr>
SipServerPath<\/code><\/td>string<\/td>The WebSocket path on the server (e.g., \"\/ws\"<\/code>)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Manual Provisioning Example<\/h2>\n\n\n\n
Here\u2019s how to use a manually constructed provisioning object for a direct connection:<\/p>\n\n\n\n
const<\/span> manualProvisioning = {\n    RegistrationMode: \"Socket\"<\/span>,\n    profileName: \"Direct PBX\"<\/span>,\n    SipWssServer: \"pbx.company.local\"<\/span>,\n    SipUsername: \"user@company.local\"<\/span>,\n    SipPassword: \"sip-password\"<\/span>,\n    SipDomain: \"pbx.company.local\"<\/span>,\n    ProfileUserName: \"John Doe\"<\/span>,\n    SipContact: \"\"<\/span>,\n    SipWebsocketPort: 8089<\/span>,\n    SipServerPath: \"\/ws\"<\/span>\n};\n\nconst<\/span> phone = await<\/span> window.Siperb.\"ProvisionPhone\"<\/span>({\n    Provisioning: manualProvisioning,\n    PhoneFrame: document.getElementById(\"phone-iframe\"<\/span>),\n    ProfileUserId: \"user-123\"<\/span>,\n    SessionId: \"session-token\"<\/span>,\n    UserId: \"user-id\"<\/span>\n});<\/code><\/pre>\n\n\n\n
Comparison: Provisioned vs Manual<\/h2>\n\n\n\n
Use GetProvisioning()<\/code> when:<\/p>\n\n\n\n