- ホーム
- /
- 投稿記事
XML アプリケーション構成 (9800 および 8875 電話機用) (BroadWorks)
このヘルプ記事は、Cisco BroadWorks に登録されている Cisco デスクフォン 9800 シリーズおよび Cisco ビデオフォン 8875 に適用されます。 サポートされている XML オブジェクト、URI、および電話の Web ページで XSI サービスを構成する手順については、この記事をお読みください。
概要
XML サービス インターフェイス (XSI) は、アプリケーションと電話システム間の通信を可能にするプロトコルです。 サポートされている XML オブジェクトと URI を使用して、独自の XSI サービスを携帯電話に追加できます。
電話機をサービスに登録すると、 に移動して、電話機で設定されているすべてのサービスにアクセスできるようになります。 Cisco XML サービスはデフォルトのサービス名です。名前を変更することもできます。ユーザが簡単にアクセスできるように、XML アプリケーションをソフトキーまたはラインキーに追加できます。
サポートされている機能は次のとおりです。
- メッセージ(画像とテキスト)
- ページング
サポートされている XML オブジェクト
-
CiscoIPPhoneMenu
-
CiscoIPPhoneText
-
CiscoIPPhoneInput
-
CiscoIPPhoneDirectory
-
CiscoIPPhoneImage
-
CiscoIPPhoneImageFile
-
CiscoIPPhoneIconMenu
-
CiscoIPPhoneIconFileMenu
-
CiscoIPPhoneStatus(9811 と 9841 を除く)
-
CiscoIPPhoneStatusFile(9811 と 9841 を除く)
-
CiscoIPPhoneExecute
サポートされている URI
-
Device
-
ダイヤル
-
編集日
-
初期化
-
キー
-
再生(着信音のみ)
-
ソフトキー
XSI サービス構成の詳細については、 Cisco Unified IP Phone サービス アプリケーション開発ノートを参照してください。
XML サービスに接続するように電話を構成する
| 1 |
電話管理のウェブページにアクセスします。 |
| 2 |
を選択します。 |
| 3 |
XML サービス セクションで、 XML サービスのパラメーター で定義されているように、 XML アプリケーション サービス名 および XML アプリケーション サービス URLパラメーターを構成します。 |
| 4 |
(オプション) アプリケーション サービスにアクセスするための認証を追加するには、次のフィールドを構成します: XML ユーザ名、 XML パスワード、 Cisco XML EXE 有効化、および Cisco XML EXE 認証モード。 |
| 5 |
「すべての変更を保存」 をクリックします。 |
XML サービスのパラメータ
次の表は、電話の Web インターフェイスの Voice > セクションにある XML アプリケーション パラメータの機能と使用法を定義します。 また、パラメータを設定するために、XML コードを含む電話設定ファイルに追加される文字列のシンタックスも定義します。
|
パラメータ |
デフォルトとオプション |
説明 |
|---|---|---|
|
XML アプリケーション サービス名(XML Application Service Name) |
デフォルト:空 |
XML アプリケーションの名前。 ウェブアプリケーションの選択肢として電話機に名前が表示されます。 次の形式で文字列を入力することによって、設定ファイル (cfg.xml) でこのパラメータを設定することができます。
|
|
XMLアプリケーションサービスURL(XML Application Service URL) |
デフォルト:空 |
XML アプリケーションが配置されているURL 次の形式で文字列を入力することによって、設定ファイル (cfg.xml) でこのパラメータを設定することができます。
マクロ変数は XML URL でサポートされています。 有効なマクロ変数については、 「XML URL でサポートされるマクロ変数」を参照してください。 URL では HTTP または HTTPs プロトコルのみがサポートされます。 |
|
XMLユーザー名(XML User Name) |
デフォルト:空 |
認証を目的としたXMLサービスのユーザ名。 次の形式で文字列を入力することによって、設定ファイル (cfg.xml) でこのパラメータを設定することができます。
|
|
XMLパスワード(XML Password) |
デフォルト:空 |
指定された XML ユーザ名の XML サービスパスワード。 このフィールドに入力したパスワードは、構成ファイル (cfg.XML) に次のように表示されます。
|
|
CISCO XML EXE 有効 |
デフォルト:[いいえ(No)] オプション:はい、いいえ |
XML アプリケーションサーバにアクセスするために認証が必要かどうかを指定します。 次の形式で文字列を入力することによって、設定ファイル (cfg.xml) でこのパラメータを設定することができます。
|
|
CISCO XML EXE 認証モード |
デフォルト: ローカル資格情報 オプション: 信頼済み、ローカル資格情報、リモート資格情報 |
Cisco XML EXE の認証モードを指定します。
次の形式で文字列を入力することによって、設定ファイル (cfg.xml) でこのパラメータを設定することができます。
|
XML アプリケーションをソフトキーに追加する
ユーザがサービスに簡単にアクセスできるように、頻繁に使用するアプリケーションをソフトキーに追加します。
はじめる前に
XML アプリケーション サービスが適切に構成されました。
| 1 |
電話管理のウェブページにアクセスします。 |
| 2 |
を選択します。 |
| 3 |
[プログラム可能なソフトキー(Programmable Softkeys)] セクションで、[プログラム可能なソフトキー有効(Programmable Softkey Enable)] を [はい(Yes)] に設定します。 このパラメータは、設定ファイル(cfg.xml)でも設定できます。 次の形式で文字列を入力します。
|
| 4 |
プログラム可能なソフトキー セクションで、 PSK1 から PSK16 までの利用可能なフィールドを次の形式で編集します。 fnc=XML;url=<xml_app_path>;nme=<app_name>
ここで、
例 このパラメータは、設定ファイル(cfg.xml)でも設定できます。 次の形式で文字列を入力します。
ここで n はソフトキー番号です。 |
| 5 |
「すべての変更を保存」 をクリックします。 |
ラインキーに XML アプリケーションを追加する
ユーザがサービスに簡単にアクセスできるように、頻繁に使用するアプリケーションをラインキーに追加します。
はじめる前に
XML アプリケーション サービスが適切に構成されました。
| 1 |
電話管理のウェブページにアクセスします。 |
| 2 |
を選択します。 |
| 3 |
ライン キーを選択します。 |
| 4 |
[内線(Extension)] パラメータを [無効(Disabled)] に設定して、内線を無効にします。 直接 PLK 設定機能を無効にした場合、ラインキーに拡張機能を追加するために内線を無効にする必要があります。 機能が有効な場合は、この手順をスキップできます。 詳細については、「 Direct PLK 構成を有効にする」を参照してください。 |
| 5 |
[拡張機能(Extended Function)] パラメータに、次の形式で文字列を入力します。 fnc=XML;url=<xml_app_path>;nme=<app_name>
ここで、
例 このパラメータは、設定ファイル(cfg.xml)でも設定できます。 次の形式で文字列を入力します。
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
| マクロ名 | マクロ展開 |
|---|---|
| $ | $$ 形式は、単一の $ 文字に展開されます。 |
| 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 など。 |
| CCERT | SSL クライアント証明書のステータス(インストール済みまたは未インストール)。 |
| 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。 カスタマイズのステータスは、Web UI 情報ページで確認できます。 |
| INCOMINGNAME | 最初の接続、呼び出し、または着信コールに関連付けられた名前。 |
| REMOTENUMBER |
最初の接続、呼び出し、または着信コールの電話番号。 複数のコールがある場合は、最初に見つかったコールに関連付けられているデータが渡されます。 |
| DISPLAYNAMEn | 回線 N の表示名設定パラメータの内容。 |
| AUTHIDn | 回線 N の認証 ID 設定パラメータの内容。 |