この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
この章では、Simple Object Access Protocol(SOAP)および HTML over HTTP インターフェイスについて説明します。これらのインターフェイスは、Cisco WebDialer Version 1.0(3) 用にカスタマイズされた電話帳検索アプリケーションの開発に使用します。この章の内容は次のとおりです。
• 「定義」
この章は、Cisco WebDialer を使用して Cisco CallManager IP テレフォニー システムと互換性のあるクライアント アプリケーションを開発するソフトウェア開発者を対象としています。 ここでは、開発者が次のテクノロジーおよび言語を十分に理解していることを前提としています。
• Simple Object Access Protocol(SOAP)
• Extensible Markup Language(XML)
• Hypertext Transfer Protocol(HTTP)
• Hypertext Markup Language(HTML)
• Web Service Definition Language(WSDL)
開発者は Cisco CallManager およびそのアプリケーションについても理解している必要があります。 Cisco CallManager および関連するほかのテクノロジーに関するドキュメントは、「このマニュアルについて」の 「関連資料」にあります。
この項で説明するコール フローは、Cisco WebDialer を使用するクライアントおよびブラウザベースのアプリケーションに対するイベントのフローを示すもので、Cisco WebDialer 向けのカスタマイズされたアプリケーションを設計する際に役に立ちます。
図 3-1は、Microsoft Outlook プラグインなどのクライアント アプリケーションから WebDialer Servlet に対する発信コールのコール フローを示しています。 ユーザはクライアント アプリケーションのアドレス帳で、 ダイヤル または 電話をかける 操作を行います。 ユーザが初めて電話をかける場合、アプリケーションにはそのユーザに関する認証情報も設定情報もありません。
図 3-1 クライアントベース アプリケーションの場合の Cisco WebDialer コール フロー
ユーザが初めて電話をかける場合は、次のようなフローになります。
1. クライアントは設定された WebDialer Servlet に makeCallSoap 要求を送信します。
2. WebDialer Servlet はユーザの認証を試みます。図 3-1 では、認証情報が不完全であるかまたは存在しないために、認証に失敗したことが示されています。
3. WebDialer Servlet は認証失敗応答をクライアント アプリケーションに送信します。
4. クライアント アプリケーションは、ユーザ ID とパスワードの入力を求めるダイアログボックスをユーザのコンピュータ画面に表示します。 ユーザはこの情報を入力して[ サブミット] ボタンをクリックします。 この時点で、今後アプリケーションが呼び出される場合に備えて、ユーザ ID とパスワードが保存されます。
5. アプリケーションは再送 SOAP 要求を WebDialer Servlet に送信します。 要求にはユーザに関する資格情報が含まれます。
6. WebDialer Servlet がユーザを認証します。
7. WebDialer Servlet は要求内に不足している設定情報を読み取ります。
8. WebDialer Servlet はクライアント アプリケーションに設定エラー メッセージを返します。
9. クライアント アプリケーションは getConfigSoap 要求を WebDialer Servlet に送信します。
10. WebDialer Servlet は電話帳に保管されたユーザの設定情報を使用して応答します。
11. クライアント アプリケーションは、ユーザに設定の選択またはアップデートを求める 設定ダイアログボックスをユーザのコンピュータ場面に表示します。 ユーザはこの情報を入力して[ サブミット] ボタンをクリックします。 今後アプリケーションが呼び出される場合に備えて、ユーザの設定情報が保存されました。
12. クライアントは makeCallSoap 要求を WebDialer Servlet に再送信します。 この要求にはユーザの設定情報が含まれます。
13. WebDialer Servlet はユーザを認証し、makeCallSoap 要求に含まれる情報を使用して電話番号をダイヤルします。 クライアントに成功または失敗のメッセージを返します。
(注) 次の場合、コール フローは直接、12. に進みます。
• アプリケーションのインストール時に、資格情報および設定情報がすでに保存されている場合
図 3-2 は、HTTP ベースのブラウザ アプリケーションを使用した場合のコール フローを示しています。このようなアプリケーションには、ディレクトリ検索ページ、個人用アドレス帳、または Cisco CallManager に組み込まれた Cisco CallManager ディレクトリ検索ページ(directory.asp)などがあります。
ユーザはクライアント アプリケーションのアドレス帳で、 ダイヤル または 電話をかける 操作を行います。 ユーザが初めて電話をかける場合、アプリケーションにはそのユーザに関する認証情報も設定情報もありません。
ユーザが初めて電話をかける場合は、次のようなフローになります。
1. クライアントは設定された WebDialer Servlet に makeCall HTTP 要求を送信します。 クエリー文字列には通話先の番号が含まれます。
2. WebDialer Servlet がユーザを認証します。 認証情報が不完全であるかまたは存在しないため、認証は失敗します。
(注) ユーザの資格情報が要求と共に送信される場合、認証は成功し、コール フローは直接 7. に進みます。
3. WebDialer Servlet は、ユーザ認証のための認証ダイアログをクライアント ブラウザに送信します。
4. ユーザはユーザ ID とパスワードを入力して[ サブミット] ボタンをクリックします。
5. クライアントはユーザの資格情報を含む makeCallHTTP 要求を WebDialer Servlet に送信します。
6. WebDialer Servlet がユーザを認証します。
7. WebDialer Servlet は要求と共に送信された Cookie 内の設定情報を読み取ります。
8. 要求が初めて行われた場合、Servlet は応答に Cookie を含めてクライアントのブラウザに送信します。 クライアントの資格情報を含んだ Cookie はクライアントのブラウザに保存されます。 クライアントの資格情報は、ユーザ ID、IP アドレス、および要求時刻です。
9. ユーザは設定ダイアログボックスにアップデート内容を入力して[ サブミット] ボタンをクリックします。
10. クライアントのブラウザは WebDialer Servlet に makeCall HTTP 要求を送信します。 要求には、資格情報および設定情報がパラメータ形式で入っている Cookie が含まれます。
11. WebDialer Servlet は資格情報を使用してユーザを認証し、設定情報をメモリに保存します。
12. WebDialer Servlet は makeCall 確認ダイアログを Cookie に保存された設定情報と共にクライアントのブラウザに送信します。 Cookie は今後呼び出される場合に備えて、クライアントのブラウザに保存されます。
13. ユーザのコンピュータ画面に[コールの開始] ダイアログボックスが表示されます。 ユーザは、別の makeCall HTTP 要求を WebDialer Servlet に送信する[ ダイヤル] ボタンをクリックします。
14. WebDialer Servlet は Cookie 内の資格情報を使用してユーザを認証し、Cookie から設定情報を取得して電話をかけます。
15. Servlet は、通話を終了するために endCall 確認ダイアログをユーザに送信して応答します。 End Call ダイアログボックスがユーザのコンピュータ画面に表示され、サービス パラメータに設定した時間だけ表示され続けます。
後続の要求のコール フローはすべて 12. で始まり、15. で終わります。
図 3-2 ブラウザベース アプリケーションの場合の Cisco WebDialer コール フロー
Cisco WebDialer アプリケーションは次の 2 つのインターフェイス経由で WebDialer Servlet と相互に対話します。
• SOAP over HTTP インターフェイス:このインターフェイスは Simple Object Access Protocol(SOAP)に基づいており、Microsoft Outlook アドインや SameTime Client プラグインなどのデスクトップ アプリケーションの開発に使用します。開発者は isClusterUserSoap インターフェイスを使用して Redirector Servlet と同様の機能性が必要なマルチクラスタ アプリケーションを設計できます。
• HTML over HTTP インターフェイス:このインターフェイスは HTTP プロトコルに基づいており、Cisco CallManager ディレクトリ検索ページ(directory.asp)などの Web ベースのアプリケーション開発に使用します。 開発者はこのインターフェイスを使用すると、マルチクラスタ アプリケーションの設計に Redirector Servlet を使用できます。
Cisco WebDialer の SOAP インターフェイスにアクセスするには、「Cisco WebDialer WSDL」の Cisco WebDialer Web Service Definition Language(WSDL)を使用します。
makeCallSoap インターフェイスは、サービス名 WebdialerSoap について、URL http://ipaddress/wdsoap/servlet/rpcrouter への SOAP 要求を開始することによってアクセスします。 この URL で、ipaddress は Cisco CallManager サーバの IP アドレスです。 この SOAP インターフェイスは Microsoft Outlook プラグインなどのプラグイン クライアントに使用されます。
|
|
|
|
|
|
---|---|---|---|---|---|
ユーザまたはプロキシ ユーザのユーザ ID かパスワード。 プロキシ ユーザ作成方法の詳細については、「プロキシ ユーザの作成(オプション)」を参照してください。 |
「Cisco WebDialer WSDL」にある資格情報のデータ型を参照してください。 |
||||
コールの開始に使用されるプロファイル。 一般的なプロファイルの例は、IP Phone または回線などの発信側デバイスです。 |
「Cisco WebDialer WSDL」にあるプロファイルのデータ型を参照してください。 |
戻り値とそのデータ型については、「Cisco WebDialer WSDL」を参照してください。
|
|
|
|
|
---|---|---|---|---|
endCallSoap インターフェイスは、サービス名 WebdialerSoap について、
URL http://ipaddress/wdsoap/servlet/rpcrouter への SOAP 要求を開始することによってアクセスします。 この URL で、ipaddress は Cisco WebDialer を設定した Cisco CallManager サーバの IP アドレスです。
この SOAP インターフェイスは Microsoft Outlook アドインなどのプラグイン ベースのクライアントに使用されます。
|
|
|
|
|
|
---|---|---|---|---|---|
ユーザまたはプロキシ ユーザのユーザ ID またはパスワード。 プロキシ ユーザを作成する方法については、「プロキシ ユーザの作成(オプション)」を参照してください。 |
「Cisco WebDialer WSDL」にある資格情報のデータ型を参照してください。 |
||||
通話の開始に使用されるプロファイル。 一般的なプロファイルの例は、IP Phone または回線などの発信側デバイスです。 |
「Cisco WebDialer WSDL」にあるプロファイルのデータ型を参照してください。 |
戻り値とそのデータ型については、「Cisco WebDialer WSDL」を参照してください。
|
|
|
|
|
---|---|---|---|---|
getProfileSoap インターフェイスは、サービス名 WebdialerSoap について、
URL http://ipaddress/wdsoap/servlet/rpcrouter への SOAP 要求を開始することによってアクセスします。 この URL で、ipaddress は Cisco WebDialer を設定した Cisco CallManager サーバの IP アドレスです。
この SOAP インターフェイスは Microsoft Outlook アドインなどのプラグイン ベースのクライアントに使用されます。
|
|
|
|
|
|
---|---|---|---|---|---|
ユーザまたはプロキシ ユーザのユーザ ID またはパスワード。 プロキシ ユーザを作成する方法については、「プロキシ ユーザの作成(オプション)」を参照してください。 |
「Cisco WebDialer WSDL」にある資格情報のデータ型を参照してください。 |
||||
戻り値とそのデータ型については、「Cisco WebDialer WSDL」を参照してください。
|
|
|
|
|
---|---|---|---|---|
ユーザに関連付けられた電話機について、一連の電話機または回線を返す。 WDDeviceInfo データ型については、Cisco WebDialer WSDL を参照してください。 |
||||
isClusterUserSoap インターフェイスは、サービス名 WebdialerSoap について、
URL http://ipaddress/wdsoap/servlet/rpcrouter への SOAP 要求を開始することによってアクセスします。 この URL で、ipaddress は Cisco WebDialer を設定した Cisco CallManager サーバの IP アドレスです。
この SOAP インターフェイスは Microsoft Outlook アドインなどのプラグイン ベースのクライアントに使用されます。Cisco WebDialer がネットワーク上にインストールされているさまざまな場所に通話をリダイレクトする、Redirector Servlet と同様の機能性が必要なマルチクラスタ アプリケーションに使用されます。 アプリケーションはこのインターフェイスを使用してユーザにサービスを提供している Cisco WebDialer の場所を見つけて確認します。この後に、その Cisco WebDialer に対する makeCall、endCall または getProfile 要求が続きます。
|
|
|
|
|
|
---|---|---|---|---|---|
戻り値とそのデータ型については、「Cisco WebDialer WSDL」を参照してください。
|
|
|
---|---|---|
ユーザがクラスタの電話帳に存在する場合、結果は true。 ユーザがクラスタの電話帳に存在しない場合、結果は false。 |
makeCall インターフェイスは、カスタマイズされた電話帳検索アプリケーションで使用されます。 また、Cisco CallManager に組み込まれているディレクトリ検索ページ(directory.asp)でも使用されます。 makeCall インターフェイスは、URL http://ipaddress/webdialer/Webdialer への HTTP 要求を開始することによってアクセスします。 この URL で、ipaddress は Cisco WebDialer を設定した Cisco CallManager サーバの IP アドレスです。
このインターフェイスは、ブラウザが Cookie を受け入れるブラウザベースのアプリケーションで使用されます。 ブラウザで Cookie を使用できない場合、ユーザ プロファイルはそのセッションの間だけ存在します。 ディレクトリ検索ページの有効化に使用するスクリプトの例は、「JavaScript の例」を参照してください。
|
|
|
|
|
|
---|---|---|---|---|---|
アプリケーションがコールを行う宛先の番号。 この番号はアプリケーション ダイヤル ルールを適用することにより、通常の電話番号に変換されます。 ダイヤル ルールの説明については、「アプリケーション ダイヤル ルールの設定(オプション)」を参照してください。 |
|
|
---|---|
Cisco WebDialer が適切なダイアログと、成功またはエラーの該当するメッセージを表示する。 アクティブ セッションがない場合は認証ダイアログを表示する。 |
makeCallProxy インターフェイスは、URL http://ipaddress/webdialer/Webdialer?cmd=doMakeCallProxy への HTTP 要求を開始することによってアクセスします。 このインターフェイスは、ブラウザが Cookie を受け入れるブラウザベースのアプリケーションで使用されます。 ブラウザで Cookie を使用できない場合、ユーザ プロファイルはそのセッションの間だけ存在します。
makeCallProxy インターフェイスは個人用アドレス帳などのアプリケーションで使用され、http://cmserver/CCMUser の CCMUser ページ内で定義されます。 アプリケーションの資格情報を使用し、プロキシとしてユーザに代わって通話を開始します。 これらのユーザは、CCMUser ページにアクセスする前に自身を認証しているため、ユーザ ID とパスワードの再入力は求められません。 アプリケーションは、プロキシ ユーザのユーザ ID とパスワードを要求内でクエリー文字列形式で送信するか、または POST メッセージ本文内のパラメータとして送信します。
ディレクトリ検索ページの有効化に使用するスクリプトの例は、「JavaScript の例」を参照してください。
|
|
---|---|
次に説明する Cisco WebDialer 用 Web Service Definition Language(WSDL)は WSDL 仕様に基づいています。 この Cisco WebDialer 用 WSDL は、Cisco WebDialer サーバ インストールでは次の場所でも使用できます。
http://<WebDialer サーバ名>/webdialer/wsdl/WebdialerSoap.wsdl
この特定の WSDL と、このドキュメントで説明したインターフェイスを使用して、Cisco WebDialer 用にカスタマイズされたアプリケーションを開発できます。 Cisco CallManager、SOAP、および WSDL の参照文献の一覧は、「このマニュアルについて」の 「関連資料」を参照してください。
この JavaScript は、ディレクトリ検索ページから Cisco WebDialer を有効にするサンプル スクリプトです。
このスクリプトは、すべてのユーザが 1 クラスタだけに存在する場合、単一クラスタ アプリケーションに対して使用されます。
このスクリプトは、すべてのユーザがさまざまなクラスタに分散する場合に使用されます。