概述

XML 服务接口(XSI)是一种允许应用程序和电话系统之间进行通信的协议。 您可以使用受支持的 XML 对象和 URI 将自己的 XSI 服务添加到电话中。

在为电话订阅服务后,用户可以通过导航到 设置 > 网络和服务 > Cisco XML 服务来访问电话上所有已配置的服务。 缺省名称为 Cisco XML 服务。您也可以更改名称。为了方便用户访问,您可以将 XML 应用程序添加到软键或线路键。

支持的功能包括:

  • 消息(图像和文本)
  • 寻呼

支持的 XML 对象

  • CiscoIPPhoneMenu

  • CiscoIPPhoneText

  • CiscoIPPhoneInput

  • CiscoIPPhoneDirectory

  • CiscoIPPhoneImage

  • CiscoIPPhoneImageFile

  • CiscoIPPhoneIconMenu

  • CiscoIPPhoneIconFileMenu

  • CiscoIPPhoneStatus(9841 除外)

  • CiscoIPPhoneStatusFile(9841 除外)

  • CiscoIPPhoneExecute

支持的 URI

  • 设备

  • 拨号

  • 编辑戴尔

  • 发起

  • 密钥

  • 播放(仅限铃声)

  • 软键

有关 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 服务参数

下表在电话 Web 界面的“语音>电话 ”选项卡下的 “XML 服务 ”部分中定义了 XML 应用程序参数 的功能和用 法。 它还定义了电话配置文件 (cfg.xml) 中添加的字符串的语法,其中包含用于配置参数的 XML 代码。

表 1. XML 服务参数

参数

默认值和选项

说明

XML Application Service Name

默认值:空

XML 应用程序的名称。 在电话上显示为 Web 应用程序选项。

您也可以通过输入以下格式的字符串,在电话配置 XML 文件 (cfg.xml) 中配置此参数:

<XML_Application_Service_Name ua=“na”>XML 应用名称</XML_Application_Service_Name>

XML Application Service 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 或 HTTPs 协议。

XML User Name

默认值:空

用于验证的 XML 服务用户名。

您也可以通过输入以下格式的字符串,在电话配置 XML 文件 (cfg.xml) 中配置此参数:

<XML_User_Name ua=“na”>username</XML_User_Name>

XML Password

默认值:空

指定 XML 用户名称的 XML 服务密码。

在此字段中输入的密码在配置文件(cfg.xml)中显示如下:

<!-- <XML_Password ua=“na”>*************</XML_Password> -->

CISCO XML EXE Enable

默认值:No

选项:Yes, No

指定是否需要验证以访问 XML 应用程序服务器。

您也可以通过输入以下格式的字符串,在电话配置 XML 文件 (cfg.xml) 中配置此参数:

<CISCO_XML_EXE_Enable ua=“na”>是的</CISCO_XML_EXE_Enable>

CISCO XML EXE Auth Mode

默认值:Local Credential

选项:受信任、本地凭据、远程凭据

指定 Cisco XML EXE 的验证模式。

  • Trusted — 无论本地凭证如何,都不执行任何验证。

  • Local Credential — 如果已设置,验证基于使用本地凭证的 digest 验证。 如果未设置本地凭证,则不执行验证。

  • Remote Credential — 验证基于使用远程凭证的 digest 验证,已在网页的 XML 应用中设置(便于访问 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

在可编程软键 部分中,按以下格式将 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

访问电话管理网页。

2

选择 Voice > Phone

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

  • 使用小写十六进制数字的 MAC 地址 — MA

  • 产品名称 — PN

  • 产品序列号 — PSN

  • 序列号 — SERIAL_NUMBER

表 2. 支持的宏
宏名称宏扩展
$$$ 扩展为单个 $ 字符。
A through P替换为通用参数 GPP_A 至 GPP_P。
SA through SD替换为专用参数 GPP_SA 至 GPP_SD。 这些参数存有在设置过程中使用的密钥或密码。
$SA 至 $SD 被认为是传递给可选重新同步 URL 限定符 — 密钥 — 的参数。
MA使用小写十六进制数字的 MAC 地址 (000e08aabbcc)。
MAU使用大写十六进制数字的 MAC 地址 (000E08AABBCC)。
MAC使用小写十六进制数字并用冒号分隔数字对的 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(在 Internet 上显示的 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

上次升级尝试的结果消息(错误);例如,http_get 失败。

PRVTMR

距离上次重新同步尝试的秒数。

UPGTMR

距离上次升级尝试的秒数。

REGTMR1

线路 1 丢失在 SIP 服务器的注册信息后经历的秒数。

REGTMR2

线路 2 丢失在 SIP 服务器的注册信息后经历的秒数。

UPGCOND

原来的宏名称。

SCHEME

文件访问方案,TFTP、HTTP 或 HTTPS 之一,在解析重新同步或升级 URL 后获得。

SERV

请求目标服务器主机名,在解析重新同步或升级 URL 后获得。

SERVIP

请求目标服务器 IP 地址,在解析重新同步或升级 URL 后获得,可能在 DNS 查找之后。

PORT

请求目标 UDP/TCP 端口,在解析重新同步或升级 URL 后获得。

PATH

请求目标文件路径,在解析重新同步或升级 URL 后获得。

ERR

重新同步或升级尝试的结果消息。 只有助于生成结果系统日志消息。 尝试升级时,值将保留在 UPGERR 变量中。

UIDn

线路 n UserID 配置参数的内容。

ISCUST

如果已对设备进行自定义,则值 = 1,否则值为 0。

可在“Web UI 信息”页上查看自定义状态。

INCOMINGNAME与第一个已接通、振铃或入站呼叫相关联的名称。
REMOTENUMBER

第一个已接通、振铃或入站呼叫的电话号码。 如果有多个呼叫,会提供与找到的第一个呼叫相关的数据。

DISPLAYNAMEn线路 N“显示名称”配置参数的内容。
AUTHIDn线路 N“验证 ID”配置参数的内容。