Skip to main content

@dialstack/sdk-dev / js/src / DialStackInstance

Interface: DialStackInstance

Defined in: sdk/js/src/types/core.ts:577

The DialStack SDK instance returned by loadDialstackAndInitialize()

Extended by​

Properties​

account​

TypeScript
account: AccountResource;

Defined in: sdk/js/src/types/core.ts:664

addresses​

TypeScript
addresses: AddressesResource;

Defined in: sdk/js/src/types/core.ts:667

aiAgents​

TypeScript
aiAgents: AIAgentsResource;

Defined in: sdk/js/src/types/core.ts:657

audioClips​

TypeScript
audioClips: AudioClipsResource;

Defined in: sdk/js/src/types/core.ts:651

availablePhoneNumbers​

TypeScript
availablePhoneNumbers: AvailablePhoneNumbersResource;

Defined in: sdk/js/src/types/core.ts:648

buttonTemplates​

TypeScript
buttonTemplates: ButtonTemplatesResource;

Defined in: sdk/js/src/types/core.ts:662

calls​

TypeScript
calls: CallsResource;

Defined in: sdk/js/src/types/core.ts:645

dectBases​

TypeScript
dectBases: DECTBasesResource;

Defined in: sdk/js/src/types/core.ts:663

deskphones​

TypeScript
deskphones: DeskphonesResource;

Defined in: sdk/js/src/types/core.ts:660

devices​

TypeScript
devices: DevicesResource;

Defined in: sdk/js/src/types/core.ts:661

dialPlans​

TypeScript
dialPlans: DialPlansResource;

Defined in: sdk/js/src/types/core.ts:652

extensions​

TypeScript
extensions: ExtensionsResource;

Defined in: sdk/js/src/types/core.ts:659

livemode​

TypeScript
readonly livemode: boolean;

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

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​

TypeScript
locations: LocationsResource;

Defined in: sdk/js/src/types/core.ts:666

phoneNumberOrders​

TypeScript
phoneNumberOrders: PhoneNumberOrdersResource;

Defined in: sdk/js/src/types/core.ts:649

phoneNumbers​

TypeScript
phoneNumbers: PhoneNumbersResource;

Defined in: sdk/js/src/types/core.ts:647

portOrders​

TypeScript
portOrders: PortOrdersResource;

Defined in: sdk/js/src/types/core.ts:650

queues​

TypeScript
queues: QueuesResource;

Defined in: sdk/js/src/types/core.ts:655

ringGroups​

TypeScript
ringGroups: RingGroupsResource;

Defined in: sdk/js/src/types/core.ts:654

schedules​

TypeScript
schedules: SchedulesResource;

Defined in: sdk/js/src/types/core.ts:653

sharedVoicemailBoxes​

TypeScript
sharedVoicemailBoxes: SharedVoicemailBoxesResource;

Defined in: sdk/js/src/types/core.ts:658

users​

TypeScript
users: UsersResource;

Defined in: sdk/js/src/types/core.ts:665

voiceApps​

TypeScript
voiceApps: VoiceAppsResource;

Defined in: sdk/js/src/types/core.ts:656

voicemails​

TypeScript
voicemails: VoicemailsResource;

Defined in: sdk/js/src/types/core.ts:646

Methods​

addAppearanceTarget()​

TypeScript
addAppearanceTarget(element): void;

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

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/js/src/types/core.ts:590

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/js/src/types/core.ts:609

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/js/src/types/core.ts:607

Make an authenticated API request

Parameters​

path​

string

options?​

RequestInit

Returns​

Promise<Response>

getAppearance()​

TypeScript
getAppearance(): AppearanceOptions | undefined;

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

Get current appearance options

Returns​

AppearanceOptions | undefined

logout()​

TypeScript
logout(): Promise<void>;

Defined in: sdk/js/src/types/core.ts:605

Log out and clean up the session

Returns​

Promise<void>

off()​

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

Defined in: sdk/js/src/types/core.ts:615

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/js/src/types/core.ts:613

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/js/src/types/core.ts:601

Internal

Inverse of DialStackInstance.addAppearanceTarget.

Parameters​

element​

HTMLElement

Returns​

void

resolveRoutingTarget()​

TypeScript
resolveRoutingTarget(target): 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:624

Resolve a routing target TypeID 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.

Parameters​

target​

string

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

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

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

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/js/src/types/core.ts:603

Update appearance for all components

Parameters​

updateOptions​

UpdateOptions

Returns​

void

On this page