カスタマイズできる Amazon Connect でサポートされているウィジェットのスニペットフィールド - Amazon Connect

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

カスタマイズできる Amazon Connect でサポートされているウィジェットのスニペットフィールド

カスタマイズできるコミュニケーションウィジェットのスニペットフィールドを、次の表に一覧表示します。表の後のコード例は、スニペットフィールドの使用方法を説明しています。

スニペットフィールド タイプ 説明 追加のドキュメント

snippetId

String

必須、自動生成

該当なし

styles

String

必須、自動生成

該当なし

supportedMessagingContentTypes

配列

必須、自動生成

該当なし

customLaunchBehavior

オブジェクト

ウェブサイトのレンダリング方法とホストウィジェットアイコンの起動方法をカスタマイズする

Amazon Connect でホストされているウェブサイトのウィジェット起動動作とボタンアイコンをカスタマイズする、このトピックの後半

authenticate

関数

ウェブサイトで JWT セキュリティを有効にするコールバック関数

ステップ 2: コミュニケーションウィジェットを表示するウェブサイトのドメインを指定する、このセクションの前半

customerDisplayName

関数

コンタクト開始時に顧客の表示名を渡す

Amazon Connect チャットの開始時に顧客の表示名を渡す、このセクションの後半

customStyles

オブジェクト

デフォルトの CSS スタイルを上書きする

カスタムプロパティを渡して、Amazon Connect のコミュニケーションウィジェットのデフォルトを上書きする、このセクションの後半

chatDurationInMinutes

数値

新しく開始されたチャットセッションの合計時間

デフォルト: 1500 - 最小 60、最大:10080

enableLogs

ブール値

デバッグログを有効にする

デフォルト: false

language

String

Connect は、サポートされている ISO-639 形式の言語コードの翻訳を行うことができます。詳細については、https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes を参照してください。

デフォルト: en_US. サポート対象: 「de_DE」、「en_US」、「es_ES」、「fr_FR」、「id_ID」、「it_IT」、「ja_JP」、「ko_KR」、「pt_BR」、「zh_CN」

nonce

String

iframe と顧客ウェブサイトの CSP ポリシー間のハンドシェイク値。例: 顧客の CSP は 1234 ノンス値を許可する一方、別のスクリプトを取り込む iframe は、iframe の親サイトによって信頼されたスクリプトであることをブラウザが認識できるように、同じ 1234 ノンス値を持つ必要があります。

デフォルト: 不特定

customizationObject

オブジェクト

ウィジェットのレイアウトとトランスクリプトをカスタマイズする

詳細については、このセクションの後半の「Amazon Connect チャットウィジェットの追加カスタマイズ」を参照してください。

contactAttributes

オブジェクト

JWT の設定なしで、スニペットコードから直接コンタクトフローに属性を渡します。

詳細については、「チャットの初期化時に問い合わせ属性を渡す」を参照してください。

customDisplayNames

オブジェクト

Amazon Connect 管理ウェブサイトで設定されているシステムまたはボットの表示名とロゴの設定を上書きします。

詳細については、「コミュニケーションウィジェットのシステムやボットの表示名とロゴをオーバーライドする方法」を参照してください。

contactMetadataHandler

関数

contactId にアクセスするためのコールバック関数。例えば、ブラウザタブが閉じられたときに contactId で StopContact 関数を呼び出したり、以前の contactId でチャットの永続性を維持するなどのシナリオを処理するようなイベントリスナーを追加します。

registerCallback

オブジェクト

これにより、公開されたライフサイクルイベントのコールバックを実行することができます。

詳細については、「amazon-connect-chatjs」を参照してください。

  • システム公開イベントは'PARTICIPANT_IDLE'、、'CHAT_ENDED'、、 'PARTICIPANT_RETURNED''PARTICIPANT_JOINED''PARTICIPANT_LEFT'、、 'CONNECTION_ESTABLISHED'、および 'AUTHENTICATION_INITIATED'です。 AUTHENTICATION_INITIATED コールバックは'CONNECTION_LOST'、問い合わせが顧客の認証フローブロックに到達すると実行されます。

  • カスタム公開イベントは ですWIDGET_FRAME_CLOSED

initialMessage

String

新しく作成されたチャットに送信するメッセージ。長さの制限: 最小長は 1、最大長は 1024

初期メッセージを使用してコンタクトフローで設定された Lex ボットを呼び出すには、メッセージでボットを初期化オプションを選択して [顧客の入力の取得] フローブロックを変更します。詳細については、「[顧客の入力の取得] フローブロックの設定方法」を参照してください。

authenticationParameters

オブジェクト

これにより、顧客の認証フローブロックが有効になります。

詳細については、「顧客認証を有効にする」を参照してください。

mockLexBotTyping

ブール値

Lex Bot メッセージのモックタイピングインジケータを有効にします。

デフォルト: false

customStartChat

関数

バックエンドから Start Chat API を呼び出すコールバック関数。

詳細については、「カスタム Start Chat API を使用したホスト型ウィジェット UI」を参照してください。

次の例は、チャットウィジェットをウェブサイトに追加する HTML スクリプトにスニペットフィールドを追加する方法を示しています。

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