概要

XML Services Interface（XSI）は、アプリケーションと電話システム間の通信を可能にするプロトコルです。 サポートされている XML オブジェクトと URI を使用して、独自の XSI サービスを電話機に追加できます。

電話機をサービスに登録した後、ユーザーは [設定] > [ネットワークとサービス] > [Cisco XML サービス] に移動して、電話機で設定されているすべてのサービスにアクセスできます。 Cisco XML サービスはデフォルト名です。 名前を変更することもできます。 ユーザに簡単なアクセスを提供するために、ソフトキーまたは回線キーに XML アプリケーションを追加できます。

サポートされている機能は次のとおりです。

  • メッセージ (画像とテキスト)
  • ページング

サポートされている XML オブジェクト

  • Cisco IP 電話メニュー

  • Cisco IP 電話

  • Cisco IP Phone 入力

  • Cisco IP 電話

  • Cisco IP 電話Image

  • Cisco IP PhoneImageFile

  • Cisco IP 電話 アイコン メニュー

  • Cisco IP 電話 IconFileMenu

  • Cisco IP PhoneStatus (9841 を除く)

  • Cisco IP PhoneStatusFile（9841 を除く）

  • Cisco IP 電話

サポートされている URI

  • デバイス

  • にダイヤルします

  • 編集ダイル

  • 初期化

  • 鍵

  • 再生 (着信音のみ)

  • ソフトキー

XSI サービス設定の詳細については、「Cisco Unified IP Phone Services アプリケーション開発ノート」を参照してください。

XML サービスに接続する電話の設定

1

電話機の管理 Web ページにアクセスします。

2

[音声 > 電話] の順に選択します。

3

[XML サービス] セクションで、[XML サービスのパラメータ] で定義されている [XML アプリケーション サービス名] パラメータと [XML アプリケーション サービス URL] パラメータを設定します。

4

（オプション）アプリケーション サービスにアクセスするための認証を追加するには、次のフィールドを設定します。 XML ユーザー名、XML パスワード、CISCO XML EXE の有効化、および CISCO XML EXE 認証モード。

5

[すべての変更を保存] をクリックします。

XML サービスのパラメータ

次の表は、電話機のウェブインターフェイスの [音声] > [電話] タブの下にある [XML サービス] セクションにおける XML アプリケーションパラメータの機能と使用方法を定義しています。 また、パラメータを設定するために、XML コードを使用して電話機設定ファイル（cfg.xml）に追加される文字列のシンタックスを定義します。

表 1. XML サービスのパラメータ

パラメータ

デフォルトとオプション

説明

XML アプリケーション サービス名

デフォルト: 空です

XML アプリケーションの名前。 この名前は、Web アプリケーションの選択肢として電話機に表示されます。

次の形式で文字列を入力することで、電話機設定の XML ファイル（cfg.xml）でこのパラメータを設定することもできます。

<XML_Application_Service_Name ua="na">XML アプリ名</XML_Application_Service_Name>

XML アプリケーション サービス URL

デフォルト: 空です

XML アプリケーションがある URL。

次の形式で文字列を入力することで、電話機設定の XML ファイル（cfg.xml）でこのパラメータを設定することもできます。

<XML_Application_Service_URL ua="na">https://server.com/path/app.xml</XML_Application_Service_URL>

マクロ変数は XML URL でサポートされています。 有効なマクロ変数については、「XML URL でサポートされているマクロ変数」を参照してください。

URL では、HTTP または HTTP プロトコルのみがサポートされています。

XML ユーザー名

デフォルト: 空です

認証目的の XML サービス ユーザ名。

次の形式で文字列を入力することで、電話機設定の XML ファイル（cfg.xml）でこのパラメータを設定することもできます。

<XML_User_Name ua="na">ユーザー名</XML_User_Name>

XML パスワード

デフォルト: 空です

指定された XML ユーザ名の XML サービス パスワード。

このフィールドに入力したパスワードは、設定ファイル（cfg.xml）に次のように表示されます。

<!-- <XML_Password ua="na">;*************</XML_Password> -->

CISCO XML EXE の有効化

デフォルト: いいえ

オプション: はい、いいえ

XML アプリケーション サーバにアクセスするために認証が必要なかどうかを指定します。

次の形式で文字列を入力することで、電話機設定の XML ファイル（cfg.xml）でこのパラメータを設定することもできます。

<CISCO_XML_EXE_Enable ua="na">はい</CISCO_XML_EXE_Enable>

CISCO XML EXE 認証モード

デフォルト: ローカル クレデンシャル

オプション: 信頼できる、ローカル クレデンシャル、リモート クレデンシャル

Cisco XML EXE の認証モードを指定します。

  • [信頼済み(Trusted)]:ローカル クレデンシャルに関係なく認証は実行されません。

  • [ローカル クレデンシャル(Local Credential)]:認証は、設定されている場合、ローカル クレデンシャルを使用したダイジェスト認証に基づきます。 ローカル クレデンシャルが設定されていない場合、認証は実行されません。

  • リモート クレデンシャル:認証は、Web ページの XML アプリケーションで設定されたリモート クレデンシャルを使用したダイジェスト認証に基づきます（XML アプリケーション サーバにアクセスするには）。

次の形式で文字列を入力することで、電話機設定の XML ファイル（cfg.xml）でこのパラメータを設定することもできます。

<CISCO_XML_EXE_Auth_Mode ua="na">ローカル クレデンシャル</CISCO_XML_EXE_Auth_Mode>

ソフトキーに XML アプリケーションを追加

頻繁に使用するアプリケーションをソフトキーに追加して、ユーザがサービスに簡単にアクセスできるようにします。

始める前に

XML アプリケーション サービスは適切に構成されています。

1

電話機の管理 Web ページにアクセスします。

2

[音声 > 電話] の順に選択します。

3

[プログラム可能なソフトキー] セクションで、[プログラム可能なソフトキーの有効化] を [はい] に設定します。

このパラメータは、設定ファイル (cfg.xml) でも設定できます。 次の形式で文字列を入力します。

<Programmable_Softkey_Enable ua="na">はい</Programmable_Softkey_Enable>
4

[プログラム可能なソフトキー] セクションで、PSK1 から PSK16 の利用可能なフィールドを次の形式で編集します。

fnc=xml;url=<xml_app_path>;nme=<app_name>

url は XML アプリケーションが保存されているリンクです。nme は電話画面上のアプリケーションの表示名です。

例 fnc=xml;url=http://10.77.21.37/xmlapp/menu.xml;nme=Menu

このパラメータは、設定ファイル (cfg.xml) でも設定できます。 次の形式で文字列を入力します。

<PSK_n ua="na">fnc=xml;url=http://10.77.21.37/xmlapp/menu.xml;nme=Menu<configuration code></PSK_n>

n はソフトキー番号です。

5

[すべての変更を保存] をクリックします。

回線キーに XML アプリケーションを追加

頻繁に使用するアプリケーションを回線キーに追加して、ユーザが簡単にサービスにアクセスできるようにします。

始める前に

XML アプリケーション サービスは適切に構成されています。

1

電話機の管理 Web ページにアクセスします。

2

[音声 > 電話] の順に選択します。

3

回線キーを選択します。

4

[内線] パラメータを [無効] に設定して、内線を無効にします。

ダイレクト PLK 設定機能が無効になっている場合は、拡張機能を回線キーに追加するために拡張機能を無効にする必要があります。 この機能が有効になっている場合は、このステップをスキップできます。 詳細については、「直接 PLK 設定を有効にする」を参照してください。
5

[拡張機能] パラメータで、次の形式で文字列を入力します。

fnc=xml;url=<xml_app_path>;nme=<app_name>

url は XML アプリケーションが保存されているリンクです。nme は電話画面上のアプリケーションの表示名です。

例 fnc=xml;url=http://10.77.21.37/xmlapp/menu.xml;nme=Menu

このパラメータは、設定ファイル (cfg.xml) でも設定できます。 次の形式で文字列を入力します。

<Extended_Function_n_ ua="na">fnc=xml;url=http://10.77.21.37/xmlapp/menu.xml;nme=Menu<configuration code></Extended_Function_n_>

ここで、n は内線番号です。

6

[すべての変更を保存] をクリックします。

XML URL でサポートされているマクロ変数

XML URL でマクロ変数を使用できます。 次のマクロ変数がサポートされています。

  • ユーザ ID:UID1、UID2 から UIDn

  • 表示名:DISPLAYNAME1、DISPLAYNAME2 から DISPLAYNAMEn

  • 認証 ID:AUTHID1、AUTHID2 から AUTHIDn

  • プロキシ:PROXY1、PROXY2 から PROXYn

  • 小文字の 16 進数を使用した MAC アドレス - MA

  • 製品名:PN

  • 製品シリーズ番号 - PSN

  • シリアル番号:SERIAL_NUMBER

表 2. サポートされているマクロ
マクロ名マクロ展開
$$$ の形式は、単一の $ 文字に展開されます。
A ～ P汎用パラメータ GPP_A ～ GPP_P で置き換えられます。
SA から SD特殊目的パラメータ GPP_SA ～ GPP_SD で置き換えられます。 これらのパラメータは、プロビジョニングで使用されるキーまたはパスワードを保持します。
$SA ~ $SD は、オプションの再同期 URL 修飾子 --key の引数として認識されます。
MA小文字の 16 進数 (000e08aabbcc) を使用する MAC アドレス。
MAU大文字の 16 進数 (000E08AABBCC) を使用する MAC アドレス。
マック16 進数のペア (00:0e:08:aa:bb:cc) をコロンで区切るために小文字の 16 進数を使用する MAC アドレス。
pnさん製品名。ビデオ電話 8875、卓上電話 9851 など。
PSN (航空機)製品シリーズ番号。例:8875、9841、9861
SNシリアル番号文字列。たとえば、88012BA01234。
CCERTコードSSL クライアント証明書のステータス（インストールされているか未インストール）。
IPローカルサブネット内の電話機の IP アドレス（192.168.1.100 など）。
先端インターネットで見られるように、電話機の外部 IP（66.43.16.52 など）。

swverバー

ソフトウェア バージョンの文字列。 例:

電話.3-2-1-0104-37

うーん

ハードウェア バージョンの文字列。 例: 2.0.1

プロイセン

プロビジョニングの状態（数値文字列）:

-1 = 明示的な再同期要求

0 = 電源再同期

1 = 定期的な再同期

2 = 再同期に失敗しました。再試行してください

アップgst

アップグレード状態（数字文字列）:

1 = 最初のアップグレード試行

2 = アップグレードに失敗しました。再試行してください

アップガー

前のアップグレード試行の結果メッセージ（ERR）。http_get の失敗など。

prvtmrさん

最後の再同期試行からの秒数。

upgtmr さん

最後のアップグレード試行からの秒数。

regtmr1

回線 1 が SIP サーバーへの登録を失ってからの秒数。

regtmr2

回線 2 が SIP サーバーへの登録を失ってからの秒数。

アップコンド

従来のマクロ名。

スキーム

再同期またはアップグレード URL の解析後に取得される TFTP、HTTP、または HTTPS のいずれかのファイル アクセス スキーム。

サービス

再同期またはアップグレード URL の解析後に取得される、要求ターゲット サーバ ホスト名。

サーブ

再同期またはアップグレード URL の解析後に取得され、場合によっては DNS ルックアップに従うことで、要求ターゲット サーバの IP アドレス。

ポート

再同期またはアップグレード URL の解析後に取得された要求ターゲット UDP/TCP ポート。

パス

再同期またはアップグレード URL の解析後に取得される、要求ターゲット ファイル パス。

エラー

再同期またはアップグレード試行の結果メッセージ。 結果の syslog メッセージを生成するときにのみ有用です。 この値は、アップグレード試行時に UPGERR 変数に保存されます。

UID

回線 n ユーザ ID 設定パラメータの内容。

イスクスト

単位がカスタマイズされている場合、value=1、そうでない場合は 0。

カスタマイズステータスは、Web UI 情報ページで確認できます。

受信Name最初の接続、呼出音、または着信コールに関連付けられた名前。
リモート番号

最初の接続、呼び出し、または着信コールの電話番号。 複数のコールが存在する場合、最初に見つかったコールに関連付けられているデータが提供されます。

ディスプレイ名Name回線 N 表示名設定パラメータの内容。
AUTHIDn回線 N 認証 ID 設定パラメータの内容。