PhoneContext
UEF提供のテレフォニック・イベントおよびアクションをカプセル化します。 MultiChannelAdaptorContextオブジェクトから導出するには、channelTypeをPHONEとして渡すことで、getCommunicationChannelContext APIをコールします。
構文
構文は次のとおりです:
getCommunicationChannelContext(channelType: McaChannels): Promise<ICommunicationChannelContext>;
getCommunicationChannelContextをコールしてPhoneContextにアクセスする方法のTypescriptの例を次に示します:
const uiEventsFrameworkInstance: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('appname', 'v1');
const multiChannelAdaptorContext: IMultiChannelAdaptorContext = await uiEventsFrameworkInstance.getMultiChannelAdaptorContext();
const phoneContext: IPhoneContext = await multiChannelAdaptorContext.getCommunicationChannelContext('PHONE') as IPhoneContext;
getCommunicationChannelContextをコールしてPhoneContextにアクセスする方法のJavascriptの例を次に示します:
const uiEventsFrameworkInstance = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('appname', 'v1');
const multiChannelAdaptorContext = await uiEventsFrameworkInstance.getMultiChannelAdaptorContext();
const phoneContext = await multiChannelAdaptorContext.getCommunicationChannelContext('PHONE');
PhoneContextでサポートされているイベントおよびアクションを示す図を次に示します。
サポートされているイベント
イベント名 | 説明 | 例 |
---|---|---|
OnToolbarAgentCommand | これは制御可能なイベントです。 つまり、このイベントを解決または拒否して制御するには、このイベント・コールバック関数の戻り値としてpromiseを渡す必要があります。 このイベント・サブスクリプションが通知されると、イベント・レスポンスでコマンドgetActiveInteractionCommandsをチェックし、そのoutDataでpromiseを解決することで、そのコマンドのoutDataを渡すことができます。 イベント・サブスクリプションは、MCAコードの初期化中に1回のみ追加できます。 このイベント通知は、セッションごとに1回のみ表示されます。 | onToolbarAgentCommand |
OnToolbarInteractionCommand | これは制御可能なイベントです。 このイベントを解決または拒否して制御するには、このイベント・コールバック関数の戻り値としてpromiseを渡す必要があります。このイベント・サブスクリプションが通知されると、イベント・レスポンスでコマンドを確認できます。 サポートされているコマンドは、accept、disconnect、reject、setActiveです。 これらのコマンドは、エージェントがFusionアプリケーションで行う可能性のある受入れ、切断および拒否操作に対応します。 このイベント・レスポンスのコールバックで、これらの各コマンドのロジックをワイヤー・アップできます。 | onToolbarInteractionCommand |
onDataUpdated | Fusionアプリケーションで発生するDataUpdateイベントをリスニングするために使用されます。 制御できないイベントです | onDataUpdated |
onOutgoingEvent | Fusionアプリケーションで発生するoutBoundコール・イベントをリスニングするために使用します。 これは制御不能なイベントです。 このイベントの通知時にアウトバウンド・コール接続のロジックをワイヤリングできます。 | onOutgoingEvent |
サポートされている操作
工程名 | 説明 | 例 |
---|---|---|
newCommEvent | これは、リング受信シナリオがある場合にユーザーが公開する必要がある処理です。 たとえば、ユーザーがエージェントをコールしようとすると、Fusionアプリケーションには「受入れ」または「拒否」ボタンを含む通知が表示されます。 これを有効にするには、MCA統合CTIでnewCommEventリクエストを公開する必要があります。 | newCommEvent |
startCommEvent | これは、newCommEventの場合、コール開始シナリオがあるときにユーザーが公開する必要があるアクションです。 たとえば、インバウンド・コール・シナリオの場合、ユーザーはonToolbarInteractionCommandをリスニングし、コマンドをAcceptとして通知を受信すると、そのコール接続を確立するためにこのアクションを公開する必要があります。 | startCommEvent |
closeCommEvent | これは、コール拒否シナリオがある場合にユーザーが公開する必要がある処理です。 たとえば、エージェントがコール通知で「辞退」をクリックすると、CTI統合コード・ベースは、同じサブスクリプションが追加されている場合、onAgentInteractionCommandイベントの通知を「辞退」コマンドで取得します。 | closeCommEvent |
outboundCommError | ツールバーは、このAPIを公開して、アウトバウンド・イベントの開始時にエラーが発生したことをFusionアプリケーションに通知できます。 このエラーは、イベントの識別子(電話番号、Eメールなど)を使用して接続を確立できない場合に発生します。 | outboundCommError |
getConfiguration | ツールバーがFusionアプリケーションでサポートされている機能を評価できるようにする構成情報を取得するには | getConfiguration |
disableFeature | ツールバーで機能を実装していないため、使用可能な機能のサブセットを無効にする必要があることをFusionアプリケーションに通知します。 | disableFeature |
readyForOperation | ツールバーが操作可能であることをFusionアプリケーションに通知 | readyForOperation |
agentStateEvent | Fusionアプリケーションに、指定されたチャネルのユーザーのサインイン・ステータスまたは可用性ステータスの変更について通知 | agentStateEvent |
サポートされているメソッド
メソッド名 | 説明 | リファレンス |
---|---|---|
サブスクライブ | PhoneContextでサポートされているイベントをリスニングする関数。 たとえば、onToolbarInteractionCommand、onDataUpdated、onOutgoingEventです。 | APIのサブスクライブ |
subscribeOnce | PhoneContextでサポートされているイベントを1回のみリスニングする関数。 たとえば、onToolbarInteractionCommand、onDataUpdated、onOutgoingEventです。 | SubscribeOnce API |
公開 | SidePaneContextオブジェクトでPhoneContextでサポートされている操作を公開するファンクション。 たとえば、getConfiguration、agentStateEvent、readyForOperation、disableFeature、newCommEvent、startCommEvent、closeCommEvent、outboundCommErrorです。 | APIの公開 |
処分 | PhoneContextオブジェクトでサブスクライブされているすべてのイベントを処分または削除するファンクション。 | APIの処分 |
getSupportedEvents | PhoneContextオブジェクトでサポートされているすべてのイベントを取得する関数。 | IPhoneContextのgetSupportedEventsエントリを参照してください。 |
getSupportedActions | PhoneContextオブジェクトでサポートされているすべてのアクションを取得するファンクション。 | IPhoneContextのgetSupportedActionsエントリを参照してください。 |
getChannelType |
PhoneContext APIリクエストでチャネル・タイプを取得するファンクション(ORA_SVC_PHONEなど)。 | IPhoneContextのgetChannelTypeエントリを参照してください。 |
getChannel |
コンテキスト・オブジェクトの型を取得する関数。 値はPHONEです。 | IPhoneContextのgetChannelエントリを参照してください。 |
getFrameOrigin |
PhoneContextオブジェクト・リクエストでフレームの起点を取得する関数。 | IPhoneContextのgetFrameOriginエントリを参照してください。 |
getToolbarName |
PhoneContextオブジェクト・リクエストでツールバー名を取得する関数。 | IPhoneContextのgetToolbarNameエントリを参照してください。 |
getVersion |
PhoneContextオブジェクト・リクエストでツールバー名を取得する関数。 | IPhoneContextのgetVersionエントリを参照してください。 |
getEventSource |
PhoneContextオブジェクト・リクエストでイベント・ソースを取得する関数。 | IPhoneContextのgetEventSourceエントリを参照してください。 |