提供: Bright Pattern Documentation
• English
addInteractionAssociatedObject
エージェントが指定されたインタラクションに関連付けたい、関連するアクティビティ履歴オブジェクトから選択されたオプションを、エージェントデスクトップアプリケーションに送信します。エージェントは、Communicatorウィジェットのユーザーインターフェースで関連オブジェクトを選択することができ、その結果はonInteractionRemovedコールバックのデータとして送信されます。
リクエスト
構文
| addInteractionAssociatedObject(object: InteractionAssociatedObject, interactionId?: string): Promise<OperationResult<null>> |
:
| type InteractionAssociatedObject = {
id: string type: string displayName: string displayType: string customFields: Record<STRING, string> } |
パラメータ
| パラメータ | パラメータ値 | データ型 | オプション/必須 | 説明 |
| オブジェクト | ||||
| id | 文字列 | 必須 | オブジェクトの一意のid | |
| 入力 | 文字列 | 必須 | オブジェクトのタイプ(例:連絡先、ケース、タスクなど) | |
| displayName | 文字列 | 必須 | オブジェクトの表示名 | |
| displayType | 文字列 | 必須 | オブジェクトの表示タイプ | |
| customFields | Record<string, string> | オプション | オブジェクトについて提供したい追加情報 | |
| interactionId | 文字列 | オプション | アクティブとして設定したいインタラクションの id です |
リクエスト例
addInteractionAssociatedObjectButton.onclick = () => {
let associatedObject: InteractionAssociatedObject | null = null
try {
associatedObject = JSON.parse(activeAssociatedObjectTextarea.value)
} catch (e) {
alert('関連オブジェクトの構造に構文エラーがあります。JSONを解析できません。')
}
if (!associatedObject) {
return
}
const itemId = activeAssociatedInteractionIdInput.値
adApi.addInteractionAssociatedObject(associatedObject, itemId)
}
戻り値
null