SDK Reference
Auto-generated from TypeScript source. Every public export of every DialStack SDK package, with its signature, parameters, return type, and a link to the source line in the public SDK repo.
For narrative guides (installation, authentication, theming, getting started with React or Web Components), see SDK. This page is the exhaustive, machine-generated surface.
Packages
| Import | Use from | Ships |
|---|---|---|
@dialstack/sdk-js | Plain HTML, Vue, Svelte, Angular | Initialization, the REST client, the web components |
@dialstack/sdk-js/pure | SSR, tests | The same surface, registering nothing on import |
@dialstack/sdk-react | React apps | The provider and the hooks every component needs |
@dialstack/sdk-webrtc | Any framework | The headless softphone, zero dependencies |
@dialstack/sdk-server | Node.js backends | REST client, webhooks, media streams |
React component subpaths
Each component is its own entry point, so an import pulls only what it renders.
| Import | Ships |
|---|---|
…/softphone | <SoftphoneProvider>, <Softphone>, the call hooks |
…/dial-plan | <DialPlan>, the visual editor |
…/onboarding | <OnboardingPortal> |
…/ai-agent | <AIAgent> and the FAQ prefill helpers |
…/call-logs | <CallLogs> |
…/voicemails | <Voicemails> |
…/call-history | <CallHistory> |
…/phone-numbers | <PhoneNumbers> |
…/phone-number-ordering | <PhoneNumberOrdering> |
Reading this reference
Each module's page lists its exports grouped by kind:
- Functions — the verbs (e.g.,
loadDialStack,initialize, hooks). - Variables — the components and other const exports (e.g.,
CallLogs,Voicemails). - Interfaces — the shapes of props and option objects (e.g.,
CallLogsProps). - Type aliases — discriminated unions and named types.
- Classes — e.g., the
DialStackserver client.
Source links on every symbol point at the corresponding line in the public
dialstack-sdk repo.