Skip to main content

@dialstack/sdk / index / DialStackInstance

Interface: DialStackInstance

Defined in: sdk/src/types/core.ts:566

The DialStack SDK instance returned by loadDialstackAndInitialize()

Properties​

account​

TypeScript
account: AccountResource;

Defined in: sdk/src/types/core.ts:638

addresses​

TypeScript
addresses: AddressesResource;

Defined in: sdk/src/types/core.ts:641

aiAgents​

TypeScript
aiAgents: AIAgentsResource;

Defined in: sdk/src/types/core.ts:631

audioClips​

TypeScript
audioClips: AudioClipsResource;

Defined in: sdk/src/types/core.ts:625

availablePhoneNumbers​

TypeScript
availablePhoneNumbers: AvailablePhoneNumbersResource;

Defined in: sdk/src/types/core.ts:622

buttonTemplates​

TypeScript
buttonTemplates: ButtonTemplatesResource;

Defined in: sdk/src/types/core.ts:636

calls​

TypeScript
calls: CallsResource;

Defined in: sdk/src/types/core.ts:619

dectBases​

TypeScript
dectBases: DECTBasesResource;

Defined in: sdk/src/types/core.ts:637

deskphones​

TypeScript
deskphones: DeskphonesResource;

Defined in: sdk/src/types/core.ts:634

devices​

TypeScript
devices: DevicesResource;

Defined in: sdk/src/types/core.ts:635

dialPlans​

TypeScript
dialPlans: DialPlansResource;

Defined in: sdk/src/types/core.ts:626

extensions​

TypeScript
extensions: ExtensionsResource;

Defined in: sdk/src/types/core.ts:633

locations​

TypeScript
locations: LocationsResource;

Defined in: sdk/src/types/core.ts:640

phoneNumberOrders​

TypeScript
phoneNumberOrders: PhoneNumberOrdersResource;

Defined in: sdk/src/types/core.ts:623

phoneNumbers​

TypeScript
phoneNumbers: PhoneNumbersResource;

Defined in: sdk/src/types/core.ts:621

portOrders​

TypeScript
portOrders: PortOrdersResource;

Defined in: sdk/src/types/core.ts:624

queues​

TypeScript
queues: QueuesResource;

Defined in: sdk/src/types/core.ts:629

ringGroups​

TypeScript
ringGroups: RingGroupsResource;

Defined in: sdk/src/types/core.ts:628

schedules​

TypeScript
schedules: SchedulesResource;

Defined in: sdk/src/types/core.ts:627

sharedVoicemailBoxes​

TypeScript
sharedVoicemailBoxes: SharedVoicemailBoxesResource;

Defined in: sdk/src/types/core.ts:632

users​

TypeScript
users: UsersResource;

Defined in: sdk/src/types/core.ts:639

voiceApps​

TypeScript
voiceApps: VoiceAppsResource;

Defined in: sdk/src/types/core.ts:630

voicemails​

TypeScript
voicemails: VoicemailsResource;

Defined in: sdk/src/types/core.ts:620

Methods​

addAppearanceTarget()​

TypeScript
addAppearanceTarget(element): void;

Defined in: sdk/src/types/core.ts:581

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

create()​

TypeScript
create<T>(tagName): ComponentElement[T];

Defined in: sdk/src/types/core.ts:572

Create a new embedded component

Type Parameters​

T​

T extends ComponentTagName

Parameters​

tagName​

T

Returns​

ComponentElement[T]

fetchAllPages()​

TypeScript
fetchAllPages<T>(fetchFn): Promise<T[]>;

Defined in: sdk/src/types/core.ts:591

Fetch all pages of a paginated list endpoint

Type Parameters​

T​

T

Parameters​

fetchFn​

(opts) => Promise<PaginatedResponse<T>>

Returns​

Promise<T[]>

fetchApi()​

TypeScript
fetchApi(path, options?): Promise<Response>;

Defined in: sdk/src/types/core.ts:589

Make an authenticated API request

Parameters​

path​

string

options?​

RequestInit

Returns​

Promise<Response>

getAppearance()​

TypeScript
getAppearance(): AppearanceOptions | undefined;

Defined in: sdk/src/types/core.ts:613

Get current appearance options

Returns​

AppearanceOptions | undefined

logout()​

TypeScript
logout(): Promise<void>;

Defined in: sdk/src/types/core.ts:587

Log out and clean up the session

Returns​

Promise<void>

off()​

TypeScript
off<K>(event, handler?): void;

Defined in: sdk/src/types/core.ts:597

Unsubscribe from real-time call events

Type Parameters​

K​

K extends "call.incoming"

Parameters​

event​

K

handler?​

CallEventHandler<CallEventMap[K]>

Returns​

void

on()​

TypeScript
on<K>(event, handler): void;

Defined in: sdk/src/types/core.ts:595

Subscribe to real-time call events

Type Parameters​

K​

K extends "call.incoming"

Parameters​

event​

K

handler​

CallEventHandler<CallEventMap[K]>

Returns​

void

removeAppearanceTarget()​

TypeScript
removeAppearanceTarget(element): void;

Defined in: sdk/src/types/core.ts:583

Internal

Inverse of DialStackInstance.addAppearanceTarget.

Parameters​

element​

HTMLElement

Returns​

void

resolveRoutingTarget()​

TypeScript
resolveRoutingTarget(target): Promise<
  | {
  extension_number?: string | null;
  id: string;
  name: string | null;
  type:   | "voice_app"
     | "user"
     | "dial_plan"
     | "ring_group"
     | "queue"
     | "shared_voicemail";
}
| null>;

Defined in: sdk/src/types/core.ts:599

Resolve a routing target TypeID to its type and display name

Parameters​

target​

string

Returns​

Promise< | { extension_number?: string | null; id: string; name: string | null; type: | "voice_app" | "user" | "dial_plan" | "ring_group" | "queue" | "shared_voicemail"; } | null>

routingTargets()​

TypeScript
routingTargets(): Promise<RoutingTarget[]>;

Defined in: sdk/src/types/core.ts:611

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()​

TypeScript
update(updateOptions): void;

Defined in: sdk/src/types/core.ts:585

Update appearance for all components

Parameters​

updateOptions​

UpdateOptions

Returns​

void

On this page