Campos de trechos de widget compatíveis no Amazon Connect que são personalizáveis - Amazon Connect

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Campos de trechos de widget compatíveis no Amazon Connect que são personalizáveis

A tabela a seguir lista os campos de trechos do widget de comunicação que você pode personalizar. O código de exemplo após a tabela mostra como usar os campos de trecho.

Campo de trecho Tipo Descrição Documentação adicional

snippetId

String

Obrigatória, gerada automaticamente

n/a

styles

String

Obrigatória, gerada automaticamente

n/a

supportedMessagingContentTypes

Array

Obrigatória, gerada automaticamente

n/a

customLaunchBehavior

Objeto

Personalize como o site renderiza e lança o ícone do widget hospedado

Personalizar o comportamento de inicialização do widget e o ícone do botão para seu site hospedado no Amazon Connect, mais adiante neste tópico

authenticate

Função

Função de retorno de chamada para habilitar a segurança JWT no site

Etapa 2: especificar os domínios do site em que você espera exibir o widget de comunicação, anteriormente nesta seção.

customerDisplayName

Função

Transmitir o nome de exibição do cliente durante a inicialização de um contato

Transmitir o nome de exibição do cliente quando um chat do Amazon Connect é iniciado, posteriormente nesta seção.

customStyles

Objeto

Substituir os estilos CSS padrão

Transmitir propriedades personalizadas para substituir os padrões no widget de comunicação do Amazon Connect, posteriormente nesta seção.

chatDurationInMinutes

Número

A duração total da sessão de chat recém-iniciada

Padrão: 1.500 - Mín 60, Máx: 10.080

enableLogs

Booleano

Habilitar os logs de depuração

Padrão: False

language

String

O Amazon Connect pode fazer traduções para códigos de idioma de formato ISO-639 aceitos. Para obter mais informações, consulte https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes.

nota

Isso não traduziria substituições de texto personalizadas e conteúdo de mensagens (tanto enviadas quanto recebidas).

Padrão: en_US. Aceitos: “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

Booleano

Desabilite o rastreamento das métricas do lado do cliente por meio do widget de comunicação.

Padrão: False

nonce

String

Valor de handshake entre iframe e política csp do site do cliente. Exemplo: csp do cliente permite o valor de 1234 nonce, o iframe que extrai outro script deve ter o mesmo valor de 1234 nonce para que o navegador saiba que é um script confiável pelo site pai do iframe.

Padrão: indefinido

customizationObject

Objeto

Personalizar o layout e a transcrição do widget

Para obter mais informações, consulte Personalizações adicionais para seu widget de chat do Amazon Connect, mais adiante nesta seção.

contactAttributes

Objeto

Passe atributos para o fluxo de contato diretamente do código do trecho, sem nenhuma configuração de JWT

Para obter mais informações, consulte Pass contact attributes when a chat initializes.

customDisplayNames

Objeto

Substitua as configurações de nome de exibição e logotipo do sistema ou bot definidas no site de administração do Amazon Connect.

Para obter mais informações, consulte How to pass override system and bot display names and logos for the communications widget.

contactMetadataHandler

Função

Função de retorno de chamada para acessar o contactId. Por exemplo, adicione um receptor de eventos para lidar com cenários como chamadas à função StopContact com o contactId quando a guia do navegador for fechada ou manter a persistência do chat com um contactId anterior.

registerCallback

Objeto

Isso permite executar retornos de chamada para os eventos do ciclo de vida expostos.

Para acessar mais informações, consulte amazon-connect-chatjs.

  • Os eventos expostos do sistema são 'PARTICIPANT_IDLE' , 'CHAT_ENDED', 'PARTICIPANT_RETURNED', 'PARTICIPANT_JOINED', 'PARTICIPANT_LEFT', 'CONNECTION_ESTABLISHED', 'CONNECTION_LOST' e 'AUTHENTICATION_INITIATED'. O retorno de chamada AUTHENTICATION_INITIATED é executado quando o contato atinge o bloco de fluxo Autenticar cliente.

  • Os eventos personalizados expostos são WIDGET_FRAME_CLOSED.

initialMessage

String

A mensagem a ser enviada para o chat recém-criado. Restrições de comprimento: mínimo de 1, máximo de 1.024.

Para invocar o bot Lex configurado no fluxo de contato usando uma mensagem inicial, modifique o bloco Obter fluxo de entrada do cliente selecionando a opção Inicializar bot com mensagem. Para obter mais informações, consulte How to configure Get customer input flow block.

authenticationParameters

Objeto

Isso habilita o bloco de fluxo Autenticar cliente.

Para obter mais informações, consulte Habilitar a autenticação do cliente.

mockLexBotTyping

Booleano

Habilite o indicador de digitação simulada para mensagens do Lex Bot.

Padrão: False

customStartChat

Função

Função de retorno de chamada para chamar a API Start Chat do seu backend.

Para acessar mais informações, consulte Interface de usuário de widget hospedada com API Start Chat personalizada

O exemplo a seguir mostra como adicionar campos de trecho ao script HTML que adiciona o widget de chat ao site.

(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/>