Webphone SDK
SDK method reference
The documented lifecycle, calling, device and configuration methods.
Lifecycle
IllyVoipWebRtcPhone.create(options)
Loads the IllyVoIP browser runtime, fetches bootstrap, and prepares the browser phone instance.
phone.refreshBootstrap()
Refreshes the managed browser token/bootstrap immediately instead of waiting for the scheduled refresh window.
phone.connect()
Starts WSS signaling without registering yet.
phone.register()
Registers the current SIP identity for inbound calls.
phone.unregister()
Stops inbound registration but keeps the transport available.
phone.disconnect()
Stops transport and clears the live browser session.
Calling
phone.call(target)
Creates an outbound browser call and returns an IllyVoipCall.
phone.answer(callId?)
Answers the active incoming call or the specific call id.
phone.reject(callId?)
Rejects a ringing inbound call.
phone.hangup(callId?)
Ends an active or ringing call.
phone.transfer(target, callId?)
Blind-transfers the current call using SIP REFER.
In-call controls
call.mute() / call.unmute()
Disables or restores the local microphone track.
call.hold() / call.resume()
Sends hold/unhold re-INVITEs over SIP/WebRTC.
call.sendDtmf("123#")
Sends RFC 2833 / INFO DTMF through the live call.
call.remoteIdentity()
Reads the remote SIP identity in a normalized shape.
Devices & state
phone.listDevices()
Enumerates browser microphones, speakers, and cameras.
phone.setInputDevice(deviceId)
Updates the preferred input device for the next call leg.
phone.setOutputDevice(deviceId)
Switches remote audio playback when the browser supports setSinkId().
phone.getState()
Returns a compact snapshot of connectivity, registration, and active calls.
Advanced configuration
tokenProvider(context) / tokenBootstrapUrl
Recommended managed auth flow. Forward only routing context such as region; derive the SIP identity from your authenticated server-side principal before minting each bootstrap or failover token.
region
Pins bootstrap to a specific IllyVoIP POP such as de, us, or sg.
sipUserId
Selects an identity only in raw or already server-authorized flows; never trust a browser-supplied value when minting managed tokens.
tones.incoming / tones.outgoing
Configures synthesized ringtone/ringback tones or points the SDK at custom audio sources for browser playback.
registerHeaders / callHeaders / answerHeaders
Adds custom SIP headers globally for registration, outbound calls, or answering inbound calls.
mode: "raw"
Bypasses bootstrap and builds the browser client from explicit SIP credentials and WSS settings.
sipPassword / sipDomain / wsServer / iceServers
Low-level raw mode inputs for migrations, kiosks, or self-managed edge routing.