Champs d’extrait de widget pris en charge et personnalisables dans Amazon Connect - Amazon Connect

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Champs d’extrait de widget pris en charge et personnalisables dans Amazon Connect

Le tableau suivant répertorie les champs d’extrait de widget de communication que vous pouvez personnaliser. L’exemple de code figurant après le tableau montre comment utiliser les champs d’extrait.

Champ d’extrait Type Description Documentation supplémentaire

snippetId

Chaîne

Obligatoire, généré automatiquement

N/A

styles

Chaîne

Obligatoire, généré automatiquement

N/A

supportedMessagingContentTypes

Tableau

Obligatoire, généré automatiquement

N/A

customLaunchBehavior

Objet

Personnalisez la façon dont votre site Web affiche et lance l’icône du widget hébergé

Personnalisation du comportement de lancement du widget et de l’icône du bouton pour votre site Web hébergé sur Amazon Connect, plus loin dans cette rubrique.

authenticate

Fonction

Fonction de rappel pour activer la sécurité JWT sur votre site Web

Étape 2 : spécifier les domaines du site Web où vous souhaitez afficher le widget de communication, précédemment dans cette section.

customerDisplayName

Fonction

Transmettez le nom d’affichage du client lors de l’initialisation d’un contact

Transmission du nom d’affichage du client lors du démarrage d’un chat Amazon Connect, plus loin dans cette section.

customStyles

Objet

Remplacez les styles CSS par défaut

Transmission de propriétés personnalisées pour remplacer les valeurs par défaut dans le widget de communication dans Amazon Connect, plus loin dans cette section.

chatDurationInMinutes

Nombre

Durée totale de la session de chat nouvellement démarrée

Par défaut : 1 500, Min. : 60, Max. : 10 080

enableLogs

Booléen

Activez les journaux de débogage

Valeur par défaut : false

language

Chaîne

Amazon Connect peut effectuer des traductions pour les codes de langue au format ISO-639 pris en charge. Pour plus d’informations, consultez https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes.

Note

Cela ne traduirait pas les remplacements de texte personnalisés ni le contenu des messages (envoyés et reçus).

Par défaut : en_US. Pris en charge : 'cs_CZ', 'da_DK', 'de_DE', 'en_AU', 'en_CA', 'en_GB', 'en_US', 'es_ES', 'fi_FI', 'fr_FR', 'hu_HU', 'id_ID', 'it_IT', 'ja_JP', 'ko_KR', 'nl_NL', 'nn_NO' 'pt_BR', 'pt_PT', 'sk_SK', 'sv_SE', 'zh_CN', 'zh_TW'

disableCSM

Booléen

Désactivation du suivi des métriques côté client à partir du widget de communication.

Valeur par défaut : false

nonce

Chaîne

Valeur de négociation entre l’iframe et la politique CSP du site Web du client. Exemple : la politique CSP du client autorise la valeur nonce 1234, l’iframe qui extrait un autre script doit avoir la même valeur nonce 1234 pour que le navigateur sache qu’il s’agit d’un script approuvé par le site parent de l’iframe.

Valeur par défaut : non définie

customizationObject

Objet

Personnalisez la transcription et la disposition des widgets

Pour plus d’informations, consultez Personnalisations supplémentaires pour votre widget de chat Amazon Connect, plus loin dans cette section.

contactAttributes

Objet

Transmission des attributs au flux de contacts directement à partir de l’extrait de code, sans aucune configuration JWT

Pour plus d’informations, consultez Transmission des attributs de contact lors du démarrage du chat.

customDisplayNames

Objet

Remplacement des configurations du nom d’affichage et du logo du système ou du bot définies sur le site Web d’administration Amazon Connect.

Pour plus d’informations, consultez Comment remplacer les noms d’affichage et logos du système et du bot pour le widget de communication.

contactMetadataHandler

Fonction

Fonction de rappel pour accéder à contactId. Par exemple, ajoutez un écouteur d’événements pour gérer des scénarios tels que l’appel de la fonction StopContact avec le contactId lorsque l’onglet du navigateur est fermé ou pour assurer la persistance du chat avec un contactId précédent.

registerCallback

Objet

Cela permet d’exécuter des rappels pour les événements de cycle de vie exposés.

Pour plus d’informations, consultez amazon-connect-chatjs.

  • Les événements exposés du système sont 'PARTICIPANT_IDLE', 'CHAT_ENDED', 'PARTICIPANT_RETURNED', 'PARTICIPANT_JOINED', 'PARTICIPANT_LEFT', 'CONNECTION_ESTABLISHED', 'CONNECTION_LOST' et 'AUTHENTICATION_INITIATED'. Le rappel AUTHENTICATION_INITIATED est exécuté lorsque le contact atteint le bloc de flux Authentifier le client.

  • Les événements exposés personnalisés sont WIDGET_FRAME_CLOSED.

initialMessage

Chaîne

Message à envoyer au chat qui vient d’être créé. Contraintes de longueur : minimum 1, maximum 1 024.

Pour invoquer le robot Lex configuré dans le flux de contacts à l’aide d’un message initial, modifiez le bloc de flux Obtenir les données client en sélectionnant l’option Initialisez le robot avec le message. Pour plus d’informations, consultez Comment configurer le bloc de flux Obtenir les données client.

authenticationParameters

Objet

Cela active le bloc de flux Authentifier le client

Pour plus d’informations, consultez Activation de l’authentification des clients.

mockLexBotTyping

Booléen

Activez l’indicateur de saisie simulée pour les messages de robot Lex.

Valeur par défaut : false

customStartChat

Fonction

Fonction de rappel permettant d’appeler l’API Start Chat depuis le système dorsal.

Pour plus d’informations, consultez Interface utilisateur du widget hébergé avec API Start Chat personnalisée.

L’exemple suivant montre comment ajouter des champs d’extrait dans le script HTML qui ajoute le widget de chat à votre site Web.

(function(w, d, x, id) {   /* ... */})(window, document, 
'amazon_connect', 'widgetId');
 amazon_connect('snippetId', 'snippetId');
 amazon_connect('styles', /* ... */);
 amazon_connect('registerCallback', {
    // Custom event example
    // WIDGET_FRAME_CLOSED
    /**
     * This event is triggered when user clicks on the chat widget close button, 
     * either widget close button was clicked when error in the chat session or normally by the user. 
     * This event can be used for webview use cases to go back to main app
     * 
     * @param {string} status - The reason for widget closure
     *   - "error_chat": Indicates the user clicked on widget close button due to an error in the chat session
     *   - "close_chat": Indicates the user clicked on widget close button normally by the user
     */
    'WIDGET_FRAME_CLOSED': (eventName, { status }) => {
        // You can implement custom logic based on the status value(error_chat or close_chat)
        if (status == "error_chat") {
            // handle error chat
        } else if (status == "close_chat") {
            // handle close chat  
        } 
    },
    // System event example
    /**
     * chatDetails: { 
     *     contactId: string, 
     *     participantId: string,
     *     participantToken: string,
     * }
     * data: {
     *     AbsoluteTime?: string,
     *     ContentType?: string,
     *     Type?: string,
     *     ParticipantId?: string,
     *     DisplayName?: string,
     *     ParticipantRole?: string,
     *     InitialContactId?: string
     * }
     */
    'PARTICIPANT_JOINED': (eventName, { chatDetails, data }) => {
        alert(`${data.ParticipantRole} joined the chat.`);
    },
    'event_Name_3': callback(function),
    'event_Name_4': callback(function),
    // ...
}); 
amazon_connect('initialMessage', 'Your initial message string');
// ... 
amazon_connect('snippetFieldHere', /* ... */);
<script/>