onGetKnowledgeBaseFolder

このハンドラーは、Communicatorウィジェットに表示するために、外部のKB（ナレッジベース）フォルダーのコンテンツを取得するために使用されます。結果には、KBフォルダーと記事が混在する場合があります。

注：データを返すハンドラーを複数設定した場合、最後のハンドラーからの結果のみが使用されます。

リクエスト

構文

on('ON_GET_KNOWLEDGE_BASE_FOLDER', handler: OnGetKnowledgeBaseFolderHandler): void type OnGetKnowledgeBaseFolderHandler = (options: KBFolderOptions) => SyncAsyncResult<EXTERNALKBITEMDATA[]> type KBFolderOptions = { language?: string folderId?: string } type ExternalKBItemData = ExternalKBArticleItem \| ExternalKBFolderItem type ExternalKBArticleItem = { id: string type: "記事" タイトル: string テキスト: string } type ExternalKBFolderItem = { id: string type: "フォルダー" タイトル: string }

パラメータ

パラメータ	パラメータ値	データ型	オプション／必須	説明
オプション
		オブジェクト	必須	リクエストパラメータ
	言語	文字列	オプション	Communicator ウィジェット KB で選択済みの言語です。その言語のコンテンツのみを受け取ることを目的としています。
folderId	文字列オプション	オプション	指定がない場合、リクエストはKBのルートコンテンツを対象とします。指定された場合、Communicatorウィジェットは、そのidを持つフォルダーのコンテンツを受信することを想定します。

リクエスト例

adApi.on("ON_GET_KNOWLEDGE_BASE_FOLDER", options => {

// 外部CRMからKBフォルダーのコンテンツをリクエストします
const kbArticlesAndFolders = externalCrmApi.getKBFolderContent(options.folderId)

// 結果をコンタクトセンターに返します
return kbArticlesAndFolders

})

戻り値

ExternalKBArticleItem および ExternalKBFolderItem の 2 種類の項目を含む配列を返します。

オブジェクト	オブジェクトの値	データ型	オプションですか？（Y/N）	値の説明
ExternalKBArticleItem
		オブジェクト		オブジェクトはKB記事を表します
	id	文字列		記事の一意のid
	入力	文字列		常に「記事」という値になります。記事項目とフォルダー項目を区別するのに役立ちます。
	タイトル	文字列		KB記事の見出し
テキスト	文字列		KB記事のコンテンツプレビュー（100文字以内を想定しています）
外部KBフォルダ項目
		オブジェクト		オブジェクトは KB フォルダーを表します
	id	文字列		フォルダーの一意の id
	入力	文字列		常に「フォルダー」という値になります。フォルダー項目と記事項目を区別するのに役立ちます。
タイトル	文字列		KBフォルダーのタイトル

< 前へ | 次へ >