Cisco Unified Communications IOS サービス API ガイド
Cisco Unified Communication IOS サー ビス API
Cisco Unified Communication IOS サービス API
発行日;2012/02/27 | 英語版ドキュメント(2011/11/04 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 2MB) | フィードバック

目次

Cisco Unified Communication IOS サービス API

概要

Cisco Unified Communication IOS サービス

プロバイダー

WSDL ファイル

着信ポート

アプリケーションの登録

登録されたセッションの状態

XCC プロバイダー

XCC プロバイダーの特性

XCC プロバイダー API

XCC コール メディア セット属性

XCC コール メディア分岐

XCC 接続

XSVC プロバイダー

XSVC プロバイダーの特性

XSVC プロバイダー API

XSVC ルート

アラームの定義

統計情報の定義

XCDR プロバイダー

XCDR プロバイダー API

XCDR CDR

Call Detail Record(コール詳細レコード)

次の作業

Cisco Unified Communication IOS サービス API

この章では、Cisco Unified Communication IOS サービス アプリケーション プログラミング インターフェイス(CUCISAPI)について説明します。CUCISAPI は、Cisco Unified Communication IOS サービスにインターフェイスを提供することにより、Cisco Integrated Services Router(ISR)上の高度な Cisco Unified Communication アプリケーションおよびサービスの開発を可能にします。

CUCISAPI を使用すると、開発者は、次のユニファイド コミュニケーション IOS サービスにアクセスできます。

拡張コール制御サービス

拡張サービスアビリティ サービス

拡張コール詳細レコード(CDR)サービス

概要

CUCISAPI を使用すると、音声ゲートウェイ上の Cisco Unified Communication IOS サービスと対話するアプリケーションを開発できます。このアプリケーションは、SOAP メッセージを介して Cisco Unified Communication IOS サービスにアクセスします。

図 1-1 に、Cisco Unified Communication IOS サービス インターフェイスを示します。シスコは現在、拡張コール制御(XCC)プロバイダー、拡張コール詳細レコード(XCDR)プロバイダー、および拡張サービスアビリティ(XSVC)プロバイダーをサポートしています。

図 1-1 Cisco Unified Communication IOS サービス インターフェイス

 

Cisco Unified Communication IOS サービス

Web サービスは標準に基づいたフレームワークであり、異なるプラットフォームで動作するアプリケーションが、インターネットを介して対話できるようにします。Cisco Unified Communication IOS サービスは、Web サービスと同様に、プラットフォームに依存せず、言語もニュートラルです。CUCISAPI を使用すると、任意の言語およびオペレーティング システムでアプリケーションを開発でき、音声ゲートウェイで実行している Cisco Unified Communication IOS サービスと直接通信できます。

Cisco Unified Communication IOS サービス API では、次の標準およびプロトコルをサポートしています。

XML 1.0

Web Services Description Language(WSDL)1.1

SOAP バージョン 1.2

HTTP バージョン 1.1

プロバイダー

音声ゲートウェイ上のプロバイダーは、音声ゲートウェイ上のサービスをリモート アプリケーションに提供します。Cisco Unified Communication IOS サービス API は、次のプロバイダー オブジェクトで構成されており、アプリケーションとプロバイダーの対話を可能にします。

XCC プロバイダー:拡張コール制御(XCC)プロバイダーは、アプリケーションによるコール制御とリアルタイム コール モニタリングの実行を可能にする動作をサポートします。

XCDR プロバイダー:拡張コール詳細レコード(XCDR)プロバイダーは、アプリケーションに CDR 情報を提供し、コールが終了したときにアプリケーションに通知します。

XSVC プロバイダー:拡張サービスアビリティ(XSVC)プロバイダーは、トランク ステータスをモニタし、リアルタイム リンク ステータスおよび設定変更通知をアプリケーションに提供します。

各プロバイダーは一意の URL ID を持ち、SOAP メッセージを介してアプリケーションと通信します。プロバイダーの状態は、次のいずれかになります。

In-service:プロバイダーはアクティブであり、使用可能な状態です。

Shutdown:プロバイダーはディセーブルであり、使用不可能になっています。この状態のプロバイダーに関連付けられた API メソッドは、無効になります。

図 1-2 に、IOS コンポーネント間の関係を示します。

図 1-2 Cisco Unified Communication IOS サービス コンポーネント

 

プロバイダーが音声ゲートウェイに設定され、イネーブルになると、次の機能が実行されます。

アプリケーションとプロバイダー間の登録プロセスを管理する。

プロバイダーのステータスが変わったときにアプリケーションに通知する。

適切なプロバイダーに着信メッセージを渡す。

メッセージ交換の失敗があったときに、プロバイダーに通知する。

アクティブな登録セッションを維持するために、プローブ メッセージを送信する。

アプリケーションのステータスを検出するために、ネガティブ プローブ メッセージを送信する。応答失敗数が、設定されたネガティブ プローブ メッセージの数を超えると、音声ゲートウェイはアプリケーションの登録を解除します。

WSDL ファイル

CUCISAPI では、WSDL 仕様を使用して、音声ゲートウェイで使用できるサービスを定義します。これらのサービスは、音声ゲートウェイ上のプロバイダーとして表示されます。

表 1-1 に、Cisco Unified Communications IOS サービスの名前空間を示します。

 

表 1-1 Cisco Unified Communication IOS サービスの名前空間

サービス
ロケーション

XCC

http://www.cisco.com/schema/cisco_xcc/v1_0

XCDR

http://www.cisco.com/schema/cisco_xcdr/v1_0

XSVC

http://www.cisco.com/schema/cisco_xsvc/v1_0

着信ポート

表 1-2 に、アプリケーションがサーバとの通信に使用する URL および着信ロケーションを示します。

表 1-2 着信ポートのロケーション

サービス
名前空間

XCC

http://<access_router>:8090/cisco_xcc 1

XCDR

http://<access_router>:8090/cisco_xcdr 1

XSVC

http://<access_router>:8090/cisco_xsvc 1

1.access_router は、Cisco Unified Communications IOS サービスと通信するルータのホスト名または IP アドレスです。

アプリケーションの登録

アプリケーションを音声ゲートウェイに登録するには、まず、アプリケーションのサービス URL をルータに設定する必要があります。この URL を使用して、アプリケーションからのメッセージを認証します。ルータが初めて起動したときに、プロバイダーはその設定にあるアプリケーションにステータス メッセージを送信します。プロバイダーのステータスが変わると、ルータからステータス メッセージが送信されます。

アプリケーションは、適切なプロバイダーに登録メッセージを送信することによって、登録を開始します。プロバイダーは、一意の登録 ID を生成し、その ID をアプリケーションに送信します。一意の登録 ID は登録されたセッションを識別するもので、登録されたセッション中に送信されるすべてのメッセージに使用されます。

登録されたセッションの状態

登録されたセッションの状態と、プロバイダーとアプリケーションの間で送信されるメッセージのステータスは、次のいずれかの値になります。

定常状態:この状態は、登録されたセッションの通常の状態です。メッセージと確認応答は、通常、この状態で交換されます。

キープアライブ状態:送信するメッセージがプロバイダーにない場合、音声ゲートウェイは登録されたアプリケーションにキープアライブ プローブ メッセージを送信します。これにより、アプリケーションとプロバイダー間の接続がアクティブのままとなります。この状態で送信されるメッセージには、プロバイダーのヘルスおよび接続ステータスの情報が含まれます。

ネガティブ プローブ状態:応答失敗数が最大応答失敗数を超えると、登録されたセッションはネガティブ プローブ状態になります。ネガティブ プローブ状態では、音声ゲートウェイがネガティブプローブ メッセージを送信し、アプリケーションとの定常状態またはキープアライブ状態の再確立を試みます。ネガティブ プローブ状態で送信されるメッセージはネガティブ プローブ メッセージのみです。ネガティブ プローブ メッセージに対する正常な応答を受信すると、登録されたセッションは定常状態またはキープアライブ状態に戻り、通常のメッセージが再開されます。

未登録状態:セッションが未登録であり、プロバイダーとアプリケーションの間でメッセージは交換されません。セッションは、次の状況で未登録状態になります。

アプリケーションがプロバイダーとの登録を解除した場合

アプリケーションがプローブ メッセージへの応答に失敗した場合

管理者が音声ゲートウェイ上のプロバイダー サービスをシャットダウンした場合

XCC プロバイダー

XCC プロバイダーは、アプリケーションに、標準コールのすべてのレッグを制御する機能を提供します。XCC プロバイダーを使用すると、アプリケーションでは補助コール制御の実行と、一部のネットワーク要素の制御が可能になります。

XCC プロバイダーの特性

XCC プロバイダーには次の特性があります。

XCC プロバイダーは、アプリケーションが、コールのライフ サイクル全体を通してコールのステートフル制御を維持できるようにします。

XCC プロバイダーは、アプリケーションが、コール中のイベント通知に登録し、受信できるようにします。アプリケーションは、コールの存続中にイベントの登録を変更できます。

XCC プロバイダーは、ネットワークでトリガーされたイベントに対してサービスを起動できるようにします。このプロバイダーは、ダイレクトなアプリケーション要求からの通知を報告します。

XCC プロバイダーは一般的なコール モデルに従っており、基礎をなす通信プロトコルやアーキテクチャは開発者に表示されません。XCC プロバイダーは、コール セッションの状態を維持および管理するためにハイレベルなコール制御モデルを使用します。

図 1-3 に、XCC コール制御の抽象化を示します。

図 1-3 XCC コール制御

 

XCC プロバイダー API

アプリケーションが XCC プロバイダーに登録されると、アプリケーションはモニタリングの対象とするイベント フィルタ パラメータを設定し、XCC プロバイダーはコールをモニタするための接続リスナーをインストールします。XCC は、コールまたは接続イベントが設定されたイベント フィルタに一致すると、アプリケーションに通知します。アプリケーションがイベント フィルタ パラメータを更新すると、その更新は既存のコールではなく、新規のコールのみに適用されます。

表 1-3 では、XCC プロバイダー API について説明します。追加情報については、「XCC プロバイダー API」を参照してください。

 

表 1-3 XCC プロバイダー API

XCC プロバイダー API
方向
説明

RequestXccRegister

アプリケーションから XCC プロバイダーへ

メッセージでブロッキング タイムアウト、接続イベント、またはメディア フィルタに対するイベント フィルタ設定と一緒に送信される登録要求。

RequestXccUnRegister

アプリケーションから XCC プロバイダーへ

アプリケーションから送信される、登録解除を要求するメッセージ。

RequestXccControlUpdate

アプリケーションから XCC プロバイダーへ

更新された接続またはメディア イベント フィルタ、および更新されたブロッキング タイムアウト設定と一緒に送信されるメッセージ。

ResponseXccRegister

XCC プロバイダーからアプリケーションへ

登録要求への応答として送信されるメッセージ。

ResponseXccUnRegister

XCC プロバイダーからアプリケーションへ

登録解除要求への応答として送信されるメッセージ。

ResponseXccControlUpdate

XCC プロバイダーからアプリケーションへ

更新されたイベント フィルタ要求への応答として送信されるメッセージ。

NotifyXccStatus

XCC プロバイダーからアプリケーションへ

XCC プロバイダーのステータスを報告するために送信される動作トリガー メッセージ。次のステータスが有効です。

IN_SERVICE

SHUTDOWN

SolicitXccProbing

XCC プロバイダーからアプリケーションへ

登録セッションの動作を維持し、アプリケーションのヘルスをチェックするために送信されるブロッキング メッセージ。

SolicitXccProviderUnRegister

XCC プロバイダーからアプリケーションへ

XCC プロバイダーがシャットダウン状態になったこと、および登録セッションが現在未登録であることをアプリケーションに通知するために送信されるブロッキング メッセージ。

ResponseXccProbing

アプリケーションから XCC プロバイダーへ

XCC プローブ メッセージへの応答として送信されるメッセージ。

ResponseXccProviderUnRegister

アプリケーションから XCC プロバイダーへ

XCC 未登録メッセージへの応答として送信されるメッセージ。

XCC コール API は、コールに関連付けられたエンドポイントおよびトランクを記述します。XCC コール API の API、および関連付けられた XCC 接続は、コールにおける制御およびメディア フローを記述します。プロバイダーは、コールの状態が変わるとアプリケーションに通知し、コール、アドレス、および接続の更新情報を送信します。

図 1-4 は、音声ゲートウェイで次の 3 つの状態のいずれかにあるコールの抽象化を示しています。

IDLE:すべてのコールの初期状態。アイドル状態のコールには、接続はありません。

ACTIVE:アクティビティが進行中のコール。アクティブ状態のコールには、1 つまたは複数の接続が関連付けられています。

INVALID:すべてのコールの最終状態。すべての接続を失ったコールは、この状態に移行されます。無効状態のコールには、接続はありません。

 

図 1-4 コール抽象化モデル

 

表 1-4 では、XCC コール API について説明します。

 

表 1-4 XCC コール API

動作
方向
説明

RequestXccCallRelease

アプリケーションから XCC プロバイダーへ

コール セッションの解放を要求するために送信されるメッセージ。

ResponseXccCallRelease

XCC プロバイダーからアプリケーションへ

アプリケーションのコール解放要求への応答として送信されるメッセージ。

RequestXccCallMediaForking

アプリケーションから XCC プロバイダーへ

コール セッションに対するメディア分岐をイネーブルにするために送信されるメッセージ。

RequestXccCallMediaSetAttributes

アプリケーションから XCC プロバイダーへ

コールが「音声」から「FAX」に変更された場合など、コール セッションのメディア属性が変更されたことを通知するために送信されるメッセージ。

ResponseXccCallMediaForking

XCC プロバイダーからアプリケーションへ

アプリケーションのメディア分岐要求への応答として送信されるメッセージ。

ResponseXccCallMediaSetAttributes

XCC プロバイダーからアプリケーションへ

アプリケーションのメディア セット属性要求への応答として送信されるメッセージ。

NotifyXccCallData

XCC プロバイダーからアプリケーションへ

コール セッションで次のいずれかの状況が発生した場合に、アプリケーションに通知するために送信される動作トリガー メッセージ。

モードが変更された。

DTMF2 ディジットが検出された。

非アクティブまたはアクティブなメディアが検出された。

2.DTMF = デュアルトーン マルチ周波数

XCC コール メディア セット属性

外部アプリケーションは、音声ゲートウェイでコール上のコール メディア セット属性に対する変更を検出でき、音声ゲートウェイに通知イベント メッセージを送信させることができます。 表 1-5 に、ゲートウェイが検出できるコール メディア セット属性を示します。

 

表 1-5 コール メディア セット属性

コール メディア セット属性
説明

Call Mode Change

コールが次のコール モード間で変更されたときに、音声ゲートウェイで検出できるようにします。

音声コール

FAX コール

ビデオ コール

モデム コール

データ コール

(注) 無制限のベアラ機能値を持つ ISDN コールは、データ コールとして報告されます。

DTMF

音声ゲートウェイが、メディア ストリームまたは DTMF リレーの DTMF ディジットを検出できるようにします。

(注) DTMF イベントが IOS で検出された場合、通知イベント メッセージにタイムスタンプが含まれます。

(注) 通知イベント メッセージの場合、アプリケーションはクロックを同期させるために NTP3 サーバとして音声ゲートウェイを使用します。

Media Activity

メディア アクティビティ状態が「Active」から「Inactive」、またはその逆に変更されたときに、音声ゲートウェイが検出できるようします。

Tone

音声ゲートウェイが、指定された次のトーンを検出できるようにします。

ビジー トーン

ダイヤル トーン

リングバック トーン

アウトオブサービス トーン

2 つ目のダイヤル トーン

(注) スーパーバイザ トーン検出機能がイネーブルである場合、FXO 音声に対するトーン検出はサポートされません。

Media Forking

接続されたコールのメディア分岐で、RTP アドレスを対象として設定できるようにします。メディア分岐の詳細については、「XCC コール メディア分岐」を参照してください。

3.NTP = ネットワーク タイム プロトコル。

XCC コール メディア分岐

外部アプリケーションは、コールに対するメディア分岐を要求できます。アプリケーションは、メディア分岐を要求する際に、XCC プロバイダーに一意のリモート RTP ポートを 2 つ(nearEndAddr および farEndAddr)提供する必要があります。XCC プロバイダーは、コールの着信接続を識別し、送信(TX)パケットと受信(RX)パケットを分岐して、それらのパケットをターゲットの RTP ポートに送信します。XCC プロバイダーは、分岐された TX メディア ストリームに nearEndAddr 要素を使用し、RX メディア ストリームを記録するために farEndAddr XCC 要素を使用します。分岐された 2 つのメディア ストリームは、「SEND ONLY」方向で音声ゲートウェイから送信されます。

メディア分岐には、次の制限があります。

音声メディア ストリームのみがサポートされます。

分岐された IPv4 RTP メディア ストリームのみがサポートされます。

分岐されたメディア ストリーム上でのメディアの混合はサポートされません。

分岐されたメディア ストリーム上でのメディアのネゴシエーションはサポートされません。言い換えれば、分岐されたメディア ストリームのコーデックは変更できません。ターゲットのメディア サーバが分岐されたメディア ストリームの動的なコーデック形式をサポートしている場合、G.711 など、サポートされているコーデックを音声ゲートウェイに設定する必要があります。

メディアの再ネゴシエーションはサポートされません。

接続が解除されると、メディア分岐は終了します。

補足サービスはサポートされません。

セッションごとに 1 つのメディア分岐要求だけがサポートされます。XCC プロバイダーは、アプリケーションからの追加のメディア分岐要求を拒否します。

XCC プロバイダーは、NotifyXccCallData メッセージに次のいずれかの状態を含めることで、アプリケーションをメディア分岐のステータスで更新します。

FORK_FAILED:メディア分岐の設定に失敗しました。ターゲットの RTP アドレスでは、分岐された RTP 接続を確立できません。

FORK_STARTED:メディア分岐に成功しました。分岐された TX と RX の両方の RTP 接続が確立され、ターゲットの RTP アドレスに接続されています。

FORK_DONE:メディア分岐が完了しました。分岐された TX と RX の両方の RTP 接続が解放されています。

XCC 接続

XCC 接続は、XCC コールにおける関係と、コール内のエンドポイントまたはトランクを記述します。図 1-5 に、接続状態を示します。

図 1-5 接続状態

 

表 1-6 では、接続状態のほか、アプリケーションが特定の接続状態に関するイベント通知を設定するときに、音声ゲートウェイとアプリケーションの間で発生する可能性のあるアクティビティおよび交換について説明します。

 

表 1-6 接続状態

接続状態
説明
音声ゲートウェイとアプリケーションの間のアクティビティと送信されるメッセージ

IDLE

すべての新しい接続の初期状態。この状態では、接続はコールでアクティブではありませんが、コールおよびアドレスの参照は有効です。

音声ゲートウェイ

音声ゲートウェイは、着信コールに関する NotifyXccConnectionData(CREATED) メッセージを送信します。

発信コールに関するメッセージは送信されません。

AUTHORIZE_CALL_ATTEMPT

発信元エンドポイントが、認可されるまで待機しています。

音声ゲートウェイ

音声ゲートウェイは、コールを一時停止状態にして、SolicitXccConnectionAuthorize() メッセージを送信し、アプリケーションからの応答を待ちます。

アプリケーション

アプリケーションは、処理を続行するか、コールを解放するためにゲートウェイ宛てに ResponseXccConnectionAuthorize() メッセージを送信します。

ADDRESS_COLLECT

ゲートウェイが、発信側から情報を収集しています。

メッセージは送信されません。

ADDRESS_ANALYZE

ゲートウェイは、発信側の情報収集を完了し、ダイヤル プランに応じてその情報を分析および変換しています。

音声ゲートウェイ

音声ゲートウェイは、コールを一時停止状態にして、SolicitXccConnectionAddressAnalyze() メッセージを送信し、アプリケーションからの応答を待ちます。

アプリケーション

アプリケーションは、ゲートウェイにコール ルートを返信するか、ResponseXccConnectionAddressAnalyze () メッセージでルート選択を行うように音声ゲートウェイに委任します。

CALL_DELIVERY

発信コールに対して、音声ゲートウェイがルートを選択し、指定の着信側エンドポイントでコールを設定する要求を送信します。

着信コールに関するメッセージは送信されません。

音声ゲートウェイ

音声ゲートウェイは、発信コールに関する NotifyXccConnectionData(CREATED) メッセージおよび NotifyXccConnectionData(CALL) DELIVERY) メッセージを送信します。

ALERTING

エンドポイントに着信コールが通知されています。

音声ゲートウェイ

音声ゲートウェイは、NotifyXccConnectionData(ALERTING) メッセージを送信します。

CONNECTED

コールの接続およびアドレスがアクティブです。

音声ゲートウェイ

音声ゲートウェイは、NotifyXccConnectionData(CONNECTED) メッセージを送信します。

DISCONNECTED

接続が非アクティブになりました。

音声ゲートウェイ

音声ゲートウェイは、NotifyXccConnectionData(DISCONNECTED) メッセージを送信します。

表 1-7 では、XCC 接続 API について説明します。

 

表 1-7 XCC 接続 API

接続
方向
説明

RequestXccConnectionRelease

アプリケーションから XCC プロバイダーへ

コールの接続の解放を要求するために送信されるメッセージ。

ResponseXccConnectionRelease

XCC プロバイダーからアプリケーションへ

アプリケーションの接続解放要求への応答として送信されるメッセージ。

SolicitXccConnectionAuthorize

XCC プロバイダーからアプリケーションへ

アプリケーションからのコール認可を要求するために送信されるブロック メッセージ。

SolicitXccConnectionAddressAnalyze

XCC プロバイダーからアプリケーションへ

分析するアプリケーションのアドレス情報と一緒に送信されるブロック メッセージ。

ResponseXccConnectionAuthorize

アプリケーションから XCC プロバイダーへ

XCC プロバイダーの接続認可要求への応答として送信されるメッセージ。

RequestXccConnectionAuthorizeDone

アプリケーションから XCC プロバイダーへ

コールの処理を続行するか、コールを解放することを XCC プロバイダーに指示するために送信されるメッセージ。

ResponseXccConnectionAddressAnalyze

アプリケーションから XCC プロバイダーへ

コールの処理を続行するか、コールを解放することを XCC プロバイダーに指示するために送信される応答メッセージ。

RequestXccConnectionAddressAnalyzeDone

アプリケーションから XCC プロバイダーへ

アプリケーションがアドレス分析を完了したときに送信されるメッセージ。

このメッセージは、プロバイダーによるコールの処理方法に関する情報を提供し、アプリケーションがモニタリングの対象とする接続イベント フィルタを示します。

ResponseXccConnectionAuthorizeDone

XCC プロバイダーからアプリケーションへ

XCC プロバイダーがアプリケーションの XccConnectionAuthorizeDone 要求を完了したときに送信される応答メッセージ。

ResponseXccConnectionAddressAnalyzeDone

XCC プロバイダーからアプリケーションへ

XCC プロバイダーがアプリケーションの XccConnectionAddressAnalyzeDone 要求を完了したときに送信される応答メッセージ。

NotifyXccConnectionData(connection_state)

XCC プロバイダーからアプリケーションへ

次の接続状態をアプリケーションに通知するために送信される動作トリガー メッセージ。

CREATED

REDIRECTED

ALERTING

CONNECTED

TRANSFERRING

DISCONNECTED

HANDOFFLEAVE

HANDOFFJOIN

XSVC プロバイダー

拡張サービスアビリティ プロバイダー(XSVC プロバイダー)は、トランクのヘルスをモニタし、アプリケーションにリアルタイム トランク ステータスを提供します。

XSVC プロバイダーは、従来の公衆電話交換網(PSTN)トランクと VoIP トランクの両方をモニタできます。トランク ステータスのモニタを開始するには、XSVC プロバイダーを設定し、対象のトランク グループに XSVC 用のルート リスナーをインストールする必要があります。ルート リスナーは、トランク グループ リソース マネージャと通信して、T1/E1 トランクに関するアラーム情報を含むトランクの情報を取得します。

PSTN トランクの場合、トランク グループは DS1、FXO、または PRI インターフェイスなど、同じシグナリング特性を持つインターフェイスの論理グループです。トランク グループは、複数の PRI インターフェイスを持つことができ、FXO もサポートできますが、FXO インターフェイスと T1/E1 インターフェイスを混合させることはできません。トランク グループ リソース マネージャは、トランク グループの論理設定をサポートします。

VoIP トランクの場合、トランク マネージャは、インターネット制御メッセージ プロトコル(ICMP)の ping を使用して VoIP トランクをモニタします。トランク マネージャは最大 1000 個のトランクをサポートします。

アプリケーションは、XSVC プロバイダーに登録されると、すべてのルートまたは特定のルートのスナップショット情報を受信するために使用するハンドラを取得します。XSVC プロバイダーは、最大 8 つの異なるアプリケーションをサポートでき、各アプリケーションは特定のトランク グループをモニタできます。

図 1-6 に、アプリケーション、XSVC ルート、および XSVC プロバイダー間の関係を示します。

 

図 1-6 XSVC プロバイダー

XSVC プロバイダーの特性

XSVC プロバイダーには次の特性があります。

XSVC プロバイダーは、リモート アプリケーションに到達できないと、イベント情報メッセージを破棄します。

アプリケーションは、XSVC プロバイダーに登録するか、スナップショットを使用して、更新された最新のトランク情報を取得する必要があります。

登録時に、アプリケーションは、登録されたセッションに対するイベント フィルタを設定できます。イベント フィルタは、登録されたこのセッションにのみ適用されます。

XSVC プロバイダーは、現在のトランクの状態を報告します。XSVC プロバイダーは、トランクの設定に対する変更について、変更が有効になるまで報告しません。

XSVC プロバイダー API

アプリケーションが XSVC プロバイダーに登録されると、ルート リスナーがトランク インターフェイスにインストールされます。フィルタが登録メッセージに指定されていない場合、XSVC プロバイダーはどのイベントも除外しません。アプリケーションが最新のトランク設定を受信できるよう、ROUTE_CONF_UPDATED イベントは除外しないことを推奨します。

表 1-8 では、XSVC プロバイダー API について説明します。追加情報については、「XSVC プロバイダー API」を参照してください。

 

表 1-8 XSVC プロバイダー API

XSVC プロバイダー
方向
説明

RequestXsvcRegister

アプリケーションから XSVC プロバイダーへ

メッセージでイベント フィルタ設定と一緒に送信される登録要求。

RequestXsvcUnRegister

アプリケーションから XSVC プロバイダーへ

アプリケーションから送信される、登録解除を要求するメッセージ。

ResponseXsvcRegister

XSVC プロバイダーからアプリケーションへ

アプリケーションの登録要求への応答として送信されるメッセージ。

ResponseXsvcUnRegister()

XSVC プロバイダーからアプリケーションへ

アプリケーションの登録解除要求への応答として送信されるメッセージ。

NotifyXsvcStatus

XSVC プロバイダーからアプリケーションへ

XSVC プロバイダーの状態が変わったときに、アプリケーションに通知するために送信される動作トリガー メッセージ。

SolicitXsvcProbing

XSVC プロバイダーからアプリケーションへ

登録セッションの動作を維持し、アプリケーションのヘルスをチェックするために送信されるブロッキング メッセージ。

SolicitXsvcProviderUnRegister

XSVC プロバイダーからアプリケーションへ

XSVC プロバイダーがシャットダウン状態になったこと、および登録セッションが現在未登録であることをアプリケーションに通知するために送信されるブロッキング メッセージ。

ResponseXsvcProbing

アプリケーションから XSVC プロバイダーへ

XSVC プローブ メッセージへの応答として送信されるメッセージ。

ResponseXsvcProviderUnRegister

アプリケーションから XSVC プロバイダーへ

XSVC 未登録メッセージへの応答として送信されるメッセージ。

XSVC ルート

ルート スナップショット API を使用することで、アプリケーションは、現在モニタされているすべてのルートの要約を要求し、音声ゲートウェイから簡潔な形式で受信できます。また、アプリケーションは、特定のルートをリッスンするようにフィルタを設定できます。さらに、XSVC プロバイダーが特定のルートの詳細情報を送信するように要求することもできます。T1/E1 トランクの場合、XSVC プロバイダーはチャネル、使用可能チャネルの合計、アラーム、およびエラー統計情報などの追加情報を送信します。

表 1-9 では、XSVC プロバイダー API について説明します。

 

表 1-9 XSVC ルート API

XSVC ルート
方向
説明

RequestXsvcRouteSetFilter

アプリケーションから XSVC プロバイダーへ

アプリケーションがモニタの対象とするルートを指定するメッセージ。

RequestXsvcRouteSnapshot

アプリケーションから XSVC プロバイダーへ

すべてのモニタ対象ルートの簡潔な情報を要求するメッセージ。

RequestXsvcRouteStats

アプリケーションから XSVC プロバイダーへ

特定のルートの統計情報を要求するメッセージ。

RequestXsvcRouteData

アプリケーションから XSVC プロバイダーへ

特定のルートの詳細情報を要求するために送信されるメッセージ。

ResponseXsvcRouteSetFilter

XSVC プロバイダーからアプリケーションへ

アプリケーションのルート フィルタ要求メッセージへの応答として送信されるメッセージ。

ResponseXsvcRouteSnapshot

XSVC プロバイダーからアプリケーションへ

モニタされているすべてのルートの簡潔な情報(名前とリンク情報のみ)と一緒に送信されるメッセージ。

ResponseXsvcRouteStats

XSVC プロバイダーからアプリケーションへ

ルートの統計情報と一緒に送信される応答メッセージ。

ResponseXsvcRouteData

XSVC プロバイダーからアプリケーションへ

ルートの詳細情報と一緒に送信される応答メッセージ。

NotifyXsvcRouteConfiguration

XSVC プロバイダーからアプリケーションへ

トランク グループで XSVC オプションがイネーブルまたはディセーブルになったとき、または、XSVC オプションがイネーブルのトランク グループで次のルート設定変更が発生した場合に送信される、動作トリガー メッセージ。

新規のトランクまたは VoIP トランクが追加された場合

トランクまたは VoIP トランクが削除された場合

既存のトランク グループ内のトランクが変更された場合

トランクまたは VoIP トランクが変更された場合

NotifyXsvcRouteStatus

XSVC プロバイダーからアプリケーションへ

リンク ステータスが UP から DOWN に、またはその逆に変更されたときなど、ルート ステータスの変更があった場合に、アプリケーションに通知するために送信される動作トリガー メッセージ。

送信される情報は、簡潔な形式になります。

(注) このイベントは、アラーム ステータスに変更があった場合にもトリガーされます。

アラームの定義

表 1-10 では、XSVC ルート メッセージに表示される可能性のあるアラームの定義について説明します。

 

表 1-10 アラームの定義

アラーム
定義

NoAlarm

アラームなし

RcvFarEndLOF

遠端 LOF4 表示(Yellow アラームとしても知られる)

XmtFarEndLOF

近端送信 LOF 表示

RcvAIS

遠端から AIS を送信中5

XmtAIS

近端から AIS を送信中

LossOfFrame

近端 LOF(Red アラームとしても知られる)

LossOfSignal

近端信号消失

LoopbackState

近端にループ バックあり

T16AIS

E1 TS16 AIS

RcvFarEndLOMF

遠端から TS16 LOMF を送信中6

RcvFarEndLOMF

近端から TS16 LOMF を送信中

RcvTestCode

近端でテスト コードを検出

OtherFailure

ここに定義されていない回線ステータス

UnavailSigState

近端が使用不可能な信号状態にある

NetEquipOOS

通信事業者の機器がサービス停止中

RcvPayloadAIS

DS2 ペイロード AIS

Ds2PerfThreshold

DS2 パフォーマンスしきい値

4.LOF = フレーム損失。

5.AIS = アラーム表示信号。

6.LOMF = マルチフレーム損失。

統計情報の定義

表 1-10 に、収集され、XSVC ルート メッセージに表示される可能性のある統計情報の定義を示します。

 

表 1-11 統計情報の定義

統計
定義

LCV

ライン コーディング違反エラー イベント

PCV

パス コーディング違反エラー イベント

CSS

制御スリップ秒数

SEFS

重大エラー フレーム秒数

LES

ライン エラー秒数

DM

低下分数

ES

エラー秒数

BES

バースト エラー秒数

SES

重大エラー秒数

UAS

使用不可能秒数

XCDR プロバイダー

XCDR プロバイダーは、コールが終了したときに、登録されているアプリケーションにコール詳細レコード(CDR)の情報を送信します。CDR には、コールの統計情報と、発信側および着信側の情報が CSV 形式で記録されています。XCDR プロバイダーは、最大 8 つのリモート アプリケーションをサポートできます。

アプリケーションは、XCDR プロバイダーに登録されると、CDR レコードの受信に使用できるハンドラを取得します。アプリケーションは、CDR を簡潔な形式で受信するか、詳細な形式で受信するかを選択できます。


) デフォルトでは、XCDR プロバイダーは、帯域幅の節約のために簡潔な形式で CDR レコードを送信します。


図 1-7 に、アプリケーション、CDR、および XCDR プロバイダー間の関係を示します。

 

図 1-7 XCDR

XCDR プロバイダー API

表 1-12 では、XCDR プロバイダー API について説明します。追加情報については、「XCDR プロバイダー API」を参照してください。

 

表 1-12 XCDR プロバイダー API

XCDR プロバイダー
方向
説明

RequestXcdrRegister

アプリケーションから XCDR プロバイダーへ

登録要求メッセージ。アプリケーションは、ルート設定変更通知を受信するか、またはルート ステータス変更を受信するかどうかを指定できます。

RequestXcdrUnRegister

アプリケーションから XCDR プロバイダーへ

アプリケーションから XCDR プロバイダーに送信される登録解除要求メッセージ。

ResponseXcdrRegister

XCDR プロバイダからアプリケーションへ

アプリケーションの登録要求への応答として送信されるメッセージ。

ResponseXcdrUnRegister

XCDR プロバイダからアプリケーションへ

アプリケーションの登録解除要求への応答として送信されるメッセージ。

NotifyXcdrStatus

XCDR プロバイダからアプリケーションへ

XCDR プロバイダーの状態が変わったときに、アプリケーションに通知するための動作トリガー メッセージ。

SolicitXcdrProbing

XCDR プロバイダからアプリケーションへ

登録セッションの動作を維持し、アプリケーションのヘルスをチェックするために送信されるブロッキング メッセージ。

SolicitXcdrProviderUnRegister

XCDR プロバイダからアプリケーションへ

XCDR プロバイダーがシャットダウン状態になったこと、および登録セッションが現在未登録であることをアプリケーションに通知するために、音声ゲートウェイから送信されるブロッキング メッセージ。

ResponseXcdrProbing

アプリケーションから XCDR プロバイダーへ

XCDR プローブ メッセージへの応答として送信されるメッセージ。

ResponseXcdrProviderUnRegister

アプリケーションから XCDR プロバイダーへ

XCDR 未登録メッセージへの応答として送信されるメッセージ。

XCDR CDR

XCDR CDR は、CDR 情報の収集と、アプリケーションに送信されるイベントの生成を実行します。アプリケーションは、RequestXcdrSetAttribute メッセージを使用して、CDR レコードを簡潔な形式にするか、または詳細な形式にするかどうかを指定できます。

表 1-13 では、XCDR CDR API について説明します。

 

表 1-13 XCDR CDR API

XCDR CDR
方向
説明

RequestXcdrSetAttribute

アプリケーションから XCDR プロバイダーへ

CDR 形式を指定するために送信される要求メッセージ。

ResponseXcdrSetAttribute

XCDR プロバイダからアプリケーションへ

アプリケーションの CDR 形式要求への応答として送信されるメッセージ。

NotifyXcdrRecord

XCDR プロバイダからアプリケーションへ

コール詳細レコードを伴うメッセージ。

Call Detail Record(コール詳細レコード)

コール詳細レコード フィールドの名前と順序の詳細については、『 CDR Accounting for Cisco IOS Voice Gateways 』を参照してください。

次の作業

プロバイダーとアプリケーションの対話の詳細と、メッセージの例については、「プロバイダーとアプリケーションの対話」を参照してください。

API の要素の詳細については、XCC、XCDR、および XSVC プロバイダー API のリファレンス ガイドを参照してください。