Skip to main content

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

ImportUse fromShips
@dialstack/sdk-jsPlain HTML, Vue, Svelte, AngularInitialization, the REST client, the web components
@dialstack/sdk-js/pureSSR, testsThe same surface, registering nothing on import
@dialstack/sdk-reactReact appsThe provider and the hooks every component needs
@dialstack/sdk-webrtcAny frameworkThe headless softphone, zero dependencies
@dialstack/sdk-serverNode.js backendsREST client, webhooks, media streams

React component subpaths

Each component is its own entry point, so an import pulls only what it renders.

ImportShips
…/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 DialStack server client.

Source links on every symbol point at the corresponding line in the public dialstack-sdk repo.