onInteractionEnd
このハンドラは、エージェントとのやり取りが終了した後に呼び出されます。このイベントには、完了したやり取りに関するすべてのデータが含まれます。Communicator Widget 1.0でのみ利用可能です。Communicator Widget 2.0 SDKではサポートされていません。
リクエスト
構文
| on('ON_INTERACTION_REMOVED', handler: OnInteractionEndHandler): void
interactionId: string 状態: InteractionState タイプ: InteractionType subject: string associatedObjects: InteractionAssociatedObjectsData callParties: CallParty[] callMuted: boolean callRecording: boolean attachedData: AttachedData phoneNumber?: string メール?: string callDirection?: CallDirection startTime?: number 終了時刻?: number duration?: number 説明?: string disposition?: string グローバルインタラクションID?: string サービス?: string 再生URL?: string 録音URL?: string DNIS?: string ANI?: string origination?: InteractionOrigination } type InteractionType = "音声" | "チャット" | "メール" type InteractionState = "不明" | "キュー" | "ivr" | "wrap_up" | "wrap_up_hold" | "delivered" | "delivery_pending" | "hold" | "完了" type InteractionOrigination = "dialpad" | "dialpad-検索" | "ディレクトリ" | "履歴" | "お気に入り" | "ワークアイテム" | "インターアクション" | "連絡先プロフィール" | "ヘルプ" | "会議" | "auto" | "integration-api" type CallDirection = "インバウンド" | "アウトバンド" type CallParty = { id: string name: string 電話: string userId?: string } |
パラメータ
| パラメータ | パラメータ値 | データ型 | オプション/必須 | 説明 |
| interaction | ||||
| 入力 | 文字列 | 必須 | インタラクションの種類を示します。認識される種類は以下の通りです:
| |
| agentId | 文字列 | 必須 | エージェントのid | |
| interactionId | 文字列 | 必須 | インタラクションのid | |
| globalInteractionId | 文字列 | オプション | インタラクションのグローバルインタラクション ID (GIID) | |
| サービス | 文字列 | オプション | そのインタラクションに関連するサービスの名前 | |
| callParties | 文字列 | 必須 | 通話参加者のリストを提供します。なお、これはタイプが「音声」であるインタラクションに適用されます。 詳細:
| |
| callMuted | ブール値 | 必須 | true に設定するとコールのミュートが有効になり、false に設定するとコールのミュートは有効になりません。なお、コール以外のインタラクションでは常に false となります。 | |
| callRecording | ブール値 | 必須 | true に設定すると通話録音は有効になり、false に設定すると通話録音は無効になります。通話以外の操作については、常に false に設定される点にご注意ください。 | |
| disposition | 文字列 | オプション | このインタラクションの処理結果カテゴリーの名前 | |
| recordingUrl | 文字列 | オプション | 通話録音のURLです。なお、これはタイプが'「音声」であるインタラクションに適用されます。 | |
| callDirection | 文字列 | オプション | コールのタイプです。認識される方向は以下の通りです:
なお、これはtypeが「音声」であるインタラクションに適用されます。 | |
| DNIS | 文字列 | オプション | ダイヤル番号認識サービス (DNIS)です。なお、これはタイプが「音声」であるインタラクションに適用されます。 | |
| transferANI | ? | オプション | 転送時の自動番号識別(ANI)です。なお、これはタイプが'「音声」であるインタラクションに適用されます。 | |
| phoneNumber | 文字列 | オプション | 受信先の電話番号です。なお、これはタイプが「音声」であるインタラクションに適用されます。 | |
| startTime | 数値 | オプション | インタラクションの開始日時 | |
| endTime | 数値 | オプション | インタラクションの終了日時 | |
| duration | 数値 | オプション | インタラクションの duration(秒単位) | |
| 発生元 | 文字列 | オプション | インタラクションがどのように開始されたかを示します。あらかじめ定義された値のリストがあります。 |
リクエスト例
const interactionsList: InteractionData[] = [];
function interactionRemovedCallback(data: InteractionData) {
const delIndex = interactionsList.findIndex(item => item.interactionId === data.interactionId);
if (delIndex !== -1) {
interactionsList.splice(delIndex, 1);
}
}
adApi.on("ON_INTERACTION_REMOVED", interactionRemovedCallback);
戻り値
null