Widget web SDK: Référence API

integrationId

Obligatoire

Identifiant d'intégration public copié depuis le canal de widget DobroDesk.

string

launcher

Valeur par défaut: default

Options de navigation native et de présentation du launcher ou du panneau web.

"default" | "hidden" = "default"

locale

Valeur par défaut: auto

Locale du widget pour le contenu. Le web utilise auto par défaut; les bundles natifs prennent actuellement en, uk, de et es en charge.

string? = "auto"

loaderUrl

Valeur par défaut: https://widget.dobrodesk.com/widget/loader/v1.min.js

URL du script loader navigateur versionné. Si elle est omise, le loader hébergé par DobroDesk est utilisé.

string?

appearance

Objet partagé appearance-v2: couleurs, typographie, mise en page et ombre dans les limites documentées.

DobroDeskWidgetAppearance?

appearanceElement

Objet partagé appearance-v2: couleurs, typographie, mise en page et ombre dans les limites documentées.

HTMLElement?

container

Options de navigation native et de présentation du launcher ou du panneau web.

HTMLElement?

identityToken

Une fonction backend qui renvoie un JWT client signé et de courte durée. Le secret de signature reste hors de l'application.

string?

helpCenterHandoffToken

Met à jour une identité signée à courte durée de vie ou un jeton de transfert vers le Help Center.

string?

openOnReady

Valeur par défaut: false

Options de navigation native et de présentation du launcher ou du panneau web.

boolean?

previewContext

Contexte JSON limité fourni aux actions d'hôte explicitement enregistrées.

DobroDeskWidgetPreviewContext?

prefill

Contexte JSON limité fourni aux actions d'hôte explicitement enregistrées.

DobroDeskWidgetPrefill?

context

Contexte JSON limité fourni aux actions d'hôte explicitement enregistrées.

DobroDeskWidgetContext?

hostActions

Callbacks d'application autorisés pour les actions guidées du widget. Ils n'authentifient pas les requêtes réseau.

Record<string, DobroDeskWidgetHostActionHandler>?

createDobroDeskWidget

Crée le client et valide la configuration.

createDobroDeskWidget(options: DobroDeskWidgetOptions) -> DobroDeskWidgetClient

Erreurs

• widget_context_invalid
• widget_mount_container_invalid
• widget_appearance_invalid

ready

Se résout lorsque le chargement du loader web et la liaison avec le frame sont terminés.

ready: Promise<void>

open / close / toggle

Ouvre le panneau du widget.

open(): void; close(): void; toggle(): void

hide / show

Masque la présentation du widget.

hide(): void; show(): void

logout

Termine la session et libère les fonctions optionnelles.

logout(): void

destroy

Détruit le page widget et libère l'instance active.

destroy(): void

setLauncherVisibility

Affiche ou masque le launcher intégré sans fermer le widget.

setLauncherVisibility(visible: boolean): void

setLocale

Modifie la locale du widget.

setLocale(locale: string): void

prefill

Définit les informations du client avant le début de la conversation.

prefill(value: DobroDeskWidgetPrefill): void

setIdentityToken

Met à jour une identité signée à courte durée de vie ou un jeton de transfert vers le Help Center.

setIdentityToken(token: string): void

setHelpCenterHandoffToken

Met à jour une identité signée à courte durée de vie ou un jeton de transfert vers le Help Center.

setHelpCenterHandoffToken(token: string): void

setPreviewContext

Définit le contexte de prévisualisation opérateur conservé en mémoire pour le loader web.

setPreviewContext(context: DobroDeskWidgetPreviewContext): void

openHelp / openArticle

Ouvre la vue Help du widget.

openHelp(): void; openArticle(articleId: string): void

requestHuman

Demande le transfert configuré vers un agent humain.

requestHuman(): void

setContext / getContext

Remplace le contexte limité des actions de l'hôte.

setContext(value): void; getContext(): DobroDeskWidgetContext

updateAppearance

Applique une surcharge d'apparence validée à l'exécution.

updateAppearance(appearance: DobroDeskWidgetAppearance): void

Erreurs

• widget_appearance_invalid

resetAppearance

Rétablit l'apparence d'exécution aux valeurs de l'administration ou fournies.

resetAppearance(appearance?: DobroDeskWidgetAppearance): void

refreshAppearance

Relit les variables CSS de l'hôte et applique les valeurs dans les limites autorisées.

refreshAppearance(hostElement?: HTMLElement): void

getAppearance

Renvoie l'apparence effective et la source de ses champs.

getAppearance(): DobroDeskWidgetAppearanceSnapshot | null

getState

Renvoie l'état actuel du widget sans abonnement.

getState(): DobroDeskWidgetState

DobroDeskWidgetLoadingState

L'état de chargement partagé est idle, starting-session, loading-messages, sending-message, waiting-for-assistant, executing-action, reconnecting ou flushing-outbox.

{ active: boolean; phase: idle | initializing | loading-content | loading-session | sending-message | waiting-for-response | executing-action | reconnecting | error; operationId?; kind?; scope?; requestId?; actionId?; startedAt?; errorCode? }

DobroDeskWidgetEventType

Les événements natifs et des wrappers utilisent l'enveloppe partagée loading, session, snapshot, message accepté, erreur et session effacée.

opened | closed | conversationStarted | messageSent | messageReceived | formSubmitted | handoffRequested | handoffStateChanged | unreadCountChanged | actionProposed | actionConfirmed | actionCompleted | actionFailed | hostActionRequested | stateChanged | loadingChanged

onStateChange

Informe l'hôte des changements d'état du widget.

onStateChange(listener): () => void

onLoadingChange

Informe l'hôte des phases de chargement et de reconnexion.

onLoadingChange(listener): () => void

on / off

S'abonne à un événement du widget nommé.

on(eventType, listener): () => void; off(eventType, listener): void

DobroDeskWidgetErrorCode

Gérez les codes stables lisibles par machine et gardez les diagnostics du serveur hors de l'interface client.

widget_ready_timeout | widget_context_invalid | widget_mount_container_invalid | widget_appearance_invalid | host_action_failed | host_action_invalid_result | host_action_timeout | widget_logged_out | widget_identity_changed | widget_destroyed