概要

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

電話をサービスに登録した後、ユーザは次の場所に移動して、電話で設定されたすべてのサービスにアクセスできます。 設定 > ネットワークとサービス > Cisco XML サービス。 Cisco XML サービス が既定の名前です。名前は変更することもできます。ユーザが簡単にアクセスできるようにするために、XML アプリケーションをソフトキーまたは回線キーに追加できます。

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

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

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

  • CiscoIPPhoneMenu

  • CiscoIPPhoneText

  • CiscoIPPhoneInput

  • CiscoIPPhoneDirectory

  • CiscoIPPhoneImage

  • CiscoIPPhoneImageFile

  • CiscoIPPhoneIconMenu

  • CiscoIPPhoneIconFile メニュー

  • CiscoIPPhoneStatus (9841 を除く)

  • CiscoIPPhoneStatusFile (9841 を除く)

  • CiscoIPPhoneExecute

サポートされている URI

  • Device

  • ダイヤル

  • EditDail

  • Init

  • キー

  • 再生 (着信音のみ)

  • ソフトキー

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

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

1

電話管理のウェブページにアクセスします。

2

[音声(Voice)] > [電話(Phone)] を選択します。

3

[ XML サービス セクションで、 XML アプリケーションサービス名 および XML アプリケーション サービスの URL パラメータの定義を次に示します。 XML サービスのパラメータ

4

(オプション) アプリケーションサービスへのアクセスに認証を追加するには、これらのフィールドを設定します: XML ユーザ名 XML パスワード CISCO XML EXE の有効化、および CISCO XML EXE 認証モード

5

クリック すべての変更を保存

XML サービスのパラメータ

以下の表では、 XML サービス セクション 音声 > 電話 タブを選択します。 また、パラメータを設定するために、XML コードを含む電話設定ファイルに追加される文字列のシンタックスも定義します。

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

パラメータ

デフォルトおよびオプション

説明

XML アプリケーション サービス名(XML Application Service Name)

デフォルト:空

XML アプリケーションの名前。 ウェブアプリケーションの選択肢として電話機に名前が表示されます。

次の形式で文字列を入力することによって、設定ファイル (cfg.xml) でこのパラメータを設定することができます。

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

XMLアプリケーションサービスURL(XML Application Service URL)

デフォルト:空

XML アプリケーションが配置されているURL

次の形式で文字列を入力することによって、設定ファイル (cfg.xml) でこのパラメータを設定することができます。

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

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

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

XMLユーザー名(XML User Name)

デフォルト:空

認証を目的としたXMLサービスのユーザ名。

次の形式で文字列を入力することによって、設定ファイル (cfg.xml) でこのパラメータを設定することができます。

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

XMLパスワード(XML Password)

デフォルト:空

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

このフィールドに入力したパスワードは、構成ファイル (cfg.xml) に次のように表示されます:

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

CISCO XML EXE 有効

デフォルト:[いいえ(No)]

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

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

次の形式で文字列を入力することによって、設定ファイル (cfg.xml) でこのパラメータを設定することができます。

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

CISCO XML EXE 認証モード

デフォルト: ローカル資格情報

オプション: 信頼済み、ローカル資格情報、リモート資格情報

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

  • 信用(Trusted)—ローカルの資格情報に関係なく認証は実行されません。

  • ローカル クレデンシャル—認証は、設定されている場合、ローカルの資格情報を使用したダイジェスト認証に基づきます ローカルの資格情報が設定されていない場合、認証は実行されません。

  • リモート クレデンシャル:認証は、(XML アプリケーション サーバにアクセスするために)ウェブページの XML アプリケーションで設定されているリモート資格情報を使用したダイジェスト認証に基づきます。

次の形式で文字列を入力することによって、設定ファイル (cfg.xml) でこのパラメータを設定することができます。

<CISCO_XML_EXE_Auth_mode ua="na">ローカル認証情報</CISCO_XML_EXE_Auth_mode>

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

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

はじめる前に

XML アプリケーション サービスが適切に設定されました。

1

電話管理のウェブページにアクセスします。

2

[音声(Voice)] > [電話(Phone)] を選択します。

3

[プログラム可能なソフトキー(Programmable Softkeys)] セクションで、[プログラム可能なソフトキー有効(Programmable Softkey Enable)] を [はい(Yes)] に設定します。

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

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

[ プログラム可能なソフトキー セクションで利用可能なフィールドを編集します PSK1PSK16 この形式:

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

ここで URL は XML アプリケーションが保存されているリンクです。 番号 はアプリケーションの電話スクリーン上の表示名です。

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<設定コード></PSK_n>

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

5

クリック すべての変更を保存

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

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

はじめる前に

XML アプリケーション サービスが適切に設定されました。

1

電話管理のウェブページにアクセスします。

2

[音声(Voice)] > [電話(Phone)] を選択します。

3

ライン キーを選択します。

4

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

直接 PLK 設定機能を無効にした場合、ラインキーに拡張機能を追加するために内線を無効にする必要があります。 機能が有効な場合は、この手順をスキップできます。 詳細については、次を参照してください。 直接 PLK 構成を有効にする
5

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

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

ここで URL は XML アプリケーションが保存されているリンクです。 番号 はアプリケーションの電話スクリーン上の表示名です。

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<設定コード></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 は、オプションの resync URL 修飾子 --key を引数として認識されます。
MA小文字の 16 進数を使用した MAC アドレス(000e08aabbcc)。
MAU大文字の 16 進数を使用した MAC アドレス(000E08AABBCC)。
MAC小文字の 16 進数を使用し、16 進数ペアがコロンで区切られた MAC アドレス(00:0e:08:aa:bb:cc)。
PN製品名;たとえば、ビデオ電話 8875、デスク フォン 9851 などです。
PSN製品シリーズ番号;例: 8875、9841、9861
SNシリアル番号の文字列。88012BA01234 など。
CCERTSSL クライアント証明書のステータス(インストール済みまたは未インストール)。
IPローカル サブネット内の電話機の IP アドレス。192.168.1.100 など。
EXTIPインターネットで表示される、電話機の外部 IP。66.43.16.52 など。

SWVER

ソフトウェア バージョン文字列。 たとえば、

PHONEOS.3-2-1-0104-37

HWVER

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

PRVST

プロビジョニングの状態(数値文字列)

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

0 = 電源投入再同期

1 = 定期的な再同期

2 = 再同期の失敗、再試行

UPGST

アップグレードの状態(数値文字列)

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

2 = アップグレードの失敗、再試行

UPGERR

前回のアップグレード試行の結果メッセージ(ERR)。http_get failed など。

PRVTMR

最後の再同期から経過した秒数。

UPGTMR

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

REGTMR1

SIP サーバで回線 1 が登録解除されてから経過した秒数。

REGTMR2

SIP サーバで回線 2 が登録解除されてから経過した秒数。

UPGCOND

レガシーのマクロ名。

SCHEME

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

SERV

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

SERVIP

おそらく DNS ルックアップの後、再同期またはアップグレード URL の解析後に取得される、要求ターゲット サーバの IP アドレス。

PORT

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

PATH

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

ERR

再同期またはアップグレード試行の結果のメッセージ。 結果の syslog メッセージを生成するときにのみ役立ちます。 アップグレード試行の場合、UPGERR 変数の値は保持されます。

UIDn

回線 n の UserID 設定パラメータの内容。

ISCUST

ユニットがカスタマイズされている場合、値は 1。それ以外の場合は 0。

カスタマイズの状況はウェブ UI 情報ページで確認できます。

INCOMINGNAME最初の接続、呼び出し、または着信コールに関連付けられた名前。
REMOTENUMBER

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

DISPLAYNAMEn回線 N の表示名設定パラメータの内容。
AUTHIDn回線 N の認証 ID 設定パラメータの内容。