@dialstack/sdk-dev / js/src / DialStackInstance
Interface: DialStackInstance
Defined in: sdk/js/src/types/core.ts:707
The DialStack SDK instance returned by loadDialstackAndInitialize()
Extended by
Properties
account
account: AccountResource;
Defined in: sdk/js/src/types/core.ts:823
addresses
addresses: AddressesResource;
Defined in: sdk/js/src/types/core.ts:827
admin
admin: AdminResource;
Defined in: sdk/js/src/types/core.ts:825
aiAgents
aiAgents: AIAgentsResource;
Defined in: sdk/js/src/types/core.ts:816
audioClips
audioClips: AudioClipsResource;
Defined in: sdk/js/src/types/core.ts:810
availablePhoneNumbers
availablePhoneNumbers: AvailablePhoneNumbersResource;
Defined in: sdk/js/src/types/core.ts:805
buttonTemplates
buttonTemplates: ButtonTemplatesResource;
Defined in: sdk/js/src/types/core.ts:821
calls
calls: CallsResource;
Defined in: sdk/js/src/types/core.ts:800
dectBases
dectBases: DECTBasesResource;
Defined in: sdk/js/src/types/core.ts:822
deskphones
deskphones: DeskphonesResource;
Defined in: sdk/js/src/types/core.ts:819
devices
devices: DevicesResource;
Defined in: sdk/js/src/types/core.ts:820
dialPlans
dialPlans: DialPlansResource;
Defined in: sdk/js/src/types/core.ts:811
extensions
extensions: ExtensionsResource;
Defined in: sdk/js/src/types/core.ts:818
hardwareCatalog
hardwareCatalog: HardwareCatalogResource;
Defined in: sdk/js/src/types/core.ts:808
hardwareOrders
hardwareOrders: HardwareOrdersResource;
Defined in: sdk/js/src/types/core.ts:807
livemode
readonly livemode: boolean;
Defined in: sdk/js/src/types/core.ts:713
Whether this instance is operating on live data, from the publishable key's
prefix. pk_test_ keys reach sandbox and demo accounts, which are never
billed; pk_live_ keys reach live accounts only, which the API enforces.
locations
locations: LocationsResource;
Defined in: sdk/js/src/types/core.ts:826
phoneNumberOrders
phoneNumberOrders: PhoneNumberOrdersResource;
Defined in: sdk/js/src/types/core.ts:806
phoneNumbers
phoneNumbers: PhoneNumbersResource;
Defined in: sdk/js/src/types/core.ts:804
portOrders
portOrders: PortOrdersResource;
Defined in: sdk/js/src/types/core.ts:809
quality
quality: QualityResource;
Defined in: sdk/js/src/types/core.ts:803
queues
queues: QueuesResource;
Defined in: sdk/js/src/types/core.ts:814
remoteNumbers
remoteNumbers: RemoteNumbersResource;
Defined in: sdk/js/src/types/core.ts:801
ringGroups
ringGroups: RingGroupsResource;
Defined in: sdk/js/src/types/core.ts:813
schedules
schedules: SchedulesResource;
Defined in: sdk/js/src/types/core.ts:812
sharedVoicemailBoxes
sharedVoicemailBoxes: SharedVoicemailBoxesResource;
Defined in: sdk/js/src/types/core.ts:817
users
users: UsersResource;
Defined in: sdk/js/src/types/core.ts:824
voiceApps
voiceApps: VoiceAppsResource;
Defined in: sdk/js/src/types/core.ts:815
voicemails
voicemails: VoicemailsResource;
Defined in: sdk/js/src/types/core.ts:802
Methods
addAppearanceTarget()
addAppearanceTarget(element): void;
Defined in: sdk/js/src/types/core.ts:729
Internal
Register an arbitrary host element to receive dialstack-appearance-update
events when DialStackInstance.update is called. Used internally by
React-only SDK components (no underlying custom element) so they
participate in the same notification path as web components.
Parameters
element
HTMLElement
Returns
void
clientHeader()?
clientHeader?(): string;
Defined in: sdk/js/src/types/core.ts:794
Internal
The current DialStack-Client header value, for DialStack packages that
make their own requests (the softphone's signaling connection).
Returns
string
create()
create<T>(tagName): ComponentElement[T];
Defined in: sdk/js/src/types/core.ts:720
Create a new embedded component
Type Parameters
T
T extends ComponentTagName
Parameters
tagName
T
Returns
fetchAllPages()
fetchAllPages<T>(fetchFn): Promise<T[]>;
Defined in: sdk/js/src/types/core.ts:739
Fetch all pages of a paginated list endpoint
Type Parameters
T
T
Parameters
fetchFn
(opts) => Promise<PaginatedResponse<T>>
Returns
Promise<T[]>
fetchApi()
fetchApi(path, options?): Promise<Response>;
Defined in: sdk/js/src/types/core.ts:737
Make an authenticated API request
Parameters
path
string
options?
RequestInit
Returns
Promise<Response>
getAppearance()
getAppearance(): AppearanceOptions | undefined;
Defined in: sdk/js/src/types/core.ts:775
Get current appearance options
Returns
AppearanceOptions | undefined
logout()
logout(): Promise<void>;
Defined in: sdk/js/src/types/core.ts:735
Log out and clean up the session
Returns
Promise<void>
off()
off<K>(event, handler?): void;
Defined in: sdk/js/src/types/core.ts:745
Unsubscribe from real-time call events
Type Parameters
K
K extends keyof CallEventMap
Parameters
event
K
handler?
CallEventHandler<CallEventMap[K]>
Returns
void
on()
on<K>(event, handler): void;
Defined in: sdk/js/src/types/core.ts:743
Subscribe to real-time call events
Type Parameters
K
K extends keyof CallEventMap
Parameters
event
K
handler
CallEventHandler<CallEventMap[K]>
Returns
void
registerClientComponent()?
registerClientComponent?(packageName, component): void;
Defined in: sdk/js/src/types/core.ts:788
Internal
Report that a package's component was mounted.
Parameters
packageName
string
component
string
Returns
void
registerClientPackage()?
registerClientPackage?(name, version): void;
Defined in: sdk/js/src/types/core.ts:783
Internal
Report a DialStack package and its version in the DialStack-Client
header. Called by DialStack's own packages (e.g. @dialstack/sdk-react).
Optional so integrators' typed test doubles of the instance still compile.
Parameters
name
string
version
string
Returns
void
removeAppearanceTarget()
removeAppearanceTarget(element): void;
Defined in: sdk/js/src/types/core.ts:731
Internal
Inverse of DialStackInstance.addAppearanceTarget.
Parameters
element
HTMLElement
Returns
void
resolveRoutingTarget()
resolveRoutingTarget(target, options?): Promise<
| {
extension_number?: string | null;
id: string;
name: string | null;
timeout_seconds?: number | null;
type: | "voice_app"
| "user"
| "dial_plan"
| "ring_group"
| "queue"
| "shared_voicemail";
}
| null>;
Defined in: sdk/js/src/types/core.ts:757
Resolve a routing target ID to its type, display name, and how long it rings a caller on its own.
timeout_seconds is a ring group's or queue's stored timeout, or the sum
of a user's Find Me / Follow Me step timeouts, and is null for a target
with no ring duration of its own.
Results are cached per instance. Pass refresh: true after the target was
edited elsewhere to fetch it again and replace the cached entry.
Parameters
target
string
options?
refresh?
boolean
Returns
Promise<
| {
extension_number?: string | null;
id: string;
name: string | null;
timeout_seconds?: number | null;
type: | "voice_app"
| "user"
| "dial_plan"
| "ring_group"
| "queue"
| "shared_voicemail";
}
| null>
routingTargets()
routingTargets(): Promise<RoutingTarget[]>;
Defined in: sdk/js/src/types/core.ts:773
List all selectable inbound-routing targets for the current account by fanning out over the underlying resource lists and merging the results. Convenience aggregation over existing list endpoints — there is no dedicated routing-targets endpoint.
Returns
Promise<RoutingTarget[]>
update()
update(updateOptions): void;
Defined in: sdk/js/src/types/core.ts:733
Update appearance for all components
Parameters
updateOptions
Returns
void