Bidang cuplikan widget yang didukung di Connect Customer yang dapat disesuaikan

Tabel berikut mencantumkan bidang cuplikan widget komunikasi yang dapat Anda sesuaikan. Contoh kode setelah tabel menunjukkan cara menggunakan bidang cuplikan.

Bidang cuplikan	Tipe	Deskripsi	Dokumentasi tambahan
`snippetId`	String	Wajib, dibuat secara otomatis	n/a
`styles`	String	Wajib, dibuat secara otomatis	n/a
`supportedMessagingContentTypes`	Array	Wajib, dibuat secara otomatis	n/a
`customLaunchBehavior`	Objek	Sesuaikan bagaimana situs web Anda merender dan meluncurkan ikon widget yang dihosting	Sesuaikan perilaku peluncuran widget dan ikon tombol untuk situs web Anda yang dihosting di Connect Customer, nanti dalam topik ini
`authenticate`	Fungsi	Fungsi callback untuk mengaktifkan keamanan JWT di situs web Anda	Langkah 2: Tentukan domain situs web tempat Anda berharap untuk menampilkan widget komunikasi, sebelumnya di bagian ini.
`customerDisplayName`	Fungsi	Berikan nama tampilan pelanggan saat menginisialisasi kontak	Berikan nama tampilan pelanggan saat obrolan Connect Customer dimulai, nanti di bagian ini.
`customStyles`	Objek	Mengganti gaya CSS default	Meneruskan properti kustom untuk mengganti default di widget komunikasi di Connect Customer, nanti di bagian ini.
`chatDurationInMinutes`	Bilangan	Total durasi sesi obrolan yang baru dimulai	Standar: 1500 - Min 60, Maks: 10080
`enableLogs`	Boolean	Aktifkan log debugging	Bawaan: salah
`language`	String	Connect Customer dapat melakukan terjemahan untuk kode bahasa ISO-639 format yang didukung. Untuk informasi selengkapnya, lihat https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes. catatan Ini tidak akan menerjemahkan penggantian teks khusus dan konten pesan (baik dikirim maupun diterima).	Default: en_US. Didukung: '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', 'nL_KR', 'Ko_KR', '_NL', 'nn_NO' 'pt_BR', 'pt_PT', 'sk_SK', 'sv_SE', 'zh_CN', 'zh_TW'
`disableCSM`	Boolean	Nonaktifkan pelacakan metrik sisi klien dari widget komunikasi.	Bawaan: salah
`disableAsyncViewResponse`	Boolean	Nonaktifkan pengiriman pesan teks saat tampilan menunggu respons dalam obrolan. Setel ini ke `true` jika pesan teks diharapkan diproses oleh blok aliran (misalnya, cabang tidak cocok).	Default: false. Jika salah, mengirim pesan diperbolehkan saat tampilan tertunda, dan pesan teks tidak diproses oleh blok alur.
`nonce`	String	Nilai jabat tangan antara iframe dan kebijakan csp situs web pelanggan. Contoh: csp pelanggan mengizinkan nilai nonce 1234, iframe yang menarik skrip lain harus memiliki nilai nonce 1234 yang sama sehingga browser tahu itu adalah skrip tepercaya oleh situs induk iframe.	Default: tidak ditentukan
`customizationObject`	Objek	Sesuaikan tata letak widget dan transkrip	Untuk informasi lebih lanjut, lihatKustomisasi tambahan untuk widget obrolan Connect Customer, nanti di bagian ini.
`contactAttributes`	Objek	Teruskan atribut ke aliran kontak langsung dari kode cuplikan, tanpa pengaturan JWT	Untuk informasi selengkapnya, lihat M eneruskan atribut kontak saat obrolan diinisialisasi.
`customDisplayNames`	Objek	Ganti nama tampilan Sistem atau Bot dan konfigurasi logo yang ditetapkan di situs web admin Amazon Connect.	Untuk informasi selengkapnya, lihat Cara melewati sistem penggantian nama dan logo tampilan bot untuk widget komunikasi.
`contactMetadataHandler`	Fungsi	Fungsi callback untuk mengakses ContactID. Misalnya, tambahkan pendengar acara untuk menangani skenario seperti memanggil StopContact fungsi dengan contactID saat tab browser ditutup atau mempertahankan persistensi obrolan dengan contactID sebelumnya.
`registerCallback`	Objek	Hal ini memungkinkan untuk mengeksekusi callback untuk peristiwa siklus hidup yang terekspos. Untuk informasi lebih lanjut, lihat amazon- connect-chatjs.	Peristiwa yang terpapar sistem adalah `'PARTICIPANT_IDLE'` `'CHAT_ENDED'` `'PARTICIPANT_RETURNED'`,`'PARTICIPANT_JOINED'`,`'PARTICIPANT_LEFT'`,`'CONNECTION_ESTABLISHED'`,`'CONNECTION_LOST'`,, dan`'AUTHENTICATION_INITIATED'`. `AUTHENTICATION_INITIATED`callback dijalankan ketika kontak mencapai blok Otentikasi Pelanggan aliran. Peristiwa terekspos khusus adalah`WIDGET_FRAME_CLOSED`.
`initialMessage`	String	Pesan yang akan dikirim ke obrolan yang baru dibuat. Batasan Panjang: Minimum 1, Maksimum 1024.	Untuk memanggil bot Lex yang dikonfigurasi dalam aliran kontak menggunakan pesan awal, ubah blok aliran masukan Dapatkan pelanggan dengan memilih opsi In isialisasi bot dengan pesan. Untuk informasi selengkapnya, lihat Cara mengonfigurasi Get blok alur masukan pelanggan.
`authenticationParameters`	Objek	Hal ini memungkinkan blok Otentikasi Pelanggan aliran	Untuk informasi selengkapnya, lihat Aktifkan otentikasi pelanggan.
`mockLexBotTyping`	Boolean	Aktifkan indikator pengetikan mengejek untuk pesan Lex Bot.	Bawaan: salah
`customStartChat`	Fungsi	Fungsi callback untuk memanggil Start Chat API dari backend Anda.	Untuk informasi selengkapnya, lihat UI widget yang di-host dengan Start Chat API kustom

Contoh berikut menunjukkan cara menambahkan bidang cuplikan ke skrip HTML yang menambahkan widget obrolan ke situs web Anda.


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

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Tambahkan antarmuka pengguna obrolan ke situs web Anda

Sesuaikan perilaku peluncuran widget dan ikon tombol

Bidang cuplikan widget yang didukung di Connect Customer yang dapat disesuaikan

catatan