Compatibility
This page preserves the previous SDK documentation and its existing URL. The generated API reference was produced from SDK 0.1.5, source commit 4db9fbe925bf07a4b95e936a5bb172d6ab5820bb. Handbook behavior and compatibility claims below are historical descriptions, not a newly verified support guarantee. For the reviewed version-specific reference, see the SDK 0.1.5 overview.
Not stated in sourceRecorded SDK recommendationNot stated in sourceRecorded SDK rangeNot stated in sourcePlatform
The current SDK release is tested against the platform release shown above. SDK versions in the supported range are expected to interoperate with this platform release.
| Platform version | Recommended SDK | Supported SDK range |
|---|---|---|
| 0.9.17-patch2 | 0.1.5 | >=0.1.3 <0.2.0 |
| 0.9.17-patch1 | 0.1.5 | >=0.1.3 <0.2.0 |
| 0.9.17 | 0.1.5 | >=0.1.3 <0.2.0 |
| 0.9.16 | 0.1.5 | >=0.1.3 <0.2.0 |
| 0.9.15 | 0.1.4 | >=0.1.3 <0.2.0 |
| 0.9.14 | 0.1.3 | >=0.1.2 <0.2.0 |
| 0.9.13 | 0.1.3 | >=0.1.2 <0.2.0 |
Platform release notes always include a compatibility section. See /release-notes.
Browsers
| Capability | Required browser feature |
|---|---|
text, audio_playback, listen, browser_actions | WebSocket, fetch, modern Promise / async |
voice_conversation | All of the above plus RTCPeerConnection |
Every evergreen browser (Chrome, Edge, Firefox, Safari) released in the last two years meets the requirements. IE and legacy Edge are not supported.
getUserMedia({ audio: true }) is required for voice_conversation and is gated behind a user gesture in some browsers; place startCall inside a click handler.
React
react version | Status |
|---|---|
>=18 | Supported (uses useSyncExternalStore). |
<18 | Not supported. |
TypeScript
>=5.0 is recommended. The SDK ships full .d.ts (ESM) and .d.cts (CJS) typings.
Node
The SDK is browser-only at runtime. Node is supported for builds and tests via engines.node >= 18.
Backend requirements
Your backend must include these fields in the session-token response so the SDK can complete a voice call:
| Field | Purpose |
|---|---|
sessionId | Server-issued session identifier. |
wsToken | Token used to authenticate the channel WebSocket. |
wsUrl | URL of the channel WebSocket. |
telproDomain | TelPro routing hint; also seeds default ICE servers when iceServers is omitted on DelphiClient. |
webrtcGatewayUrl | WebSocket URL of the WebRTC gateway. Required for voice_conversation. |
The SDK does not expose a webrtcGatewayUrl config option — the value is per-session and comes from the token response. See Configuration.