Visão geral

XML Services Interface (XSI) é um protocolo que permite comunicação entre aplicativos e o sistema do telefone. Você pode adicionar seus próprios serviços XSI ao telefone usando os objetos XML e URIs compatíveis.

Depois de inscrever o telefone nos serviços, os usuários podem acessar todos os serviços configurados no telefone navegando pelos serviços de configuração> Atrabalho e o serviço >Cisco XML. O nome padrão dos serviços de XML Cisco. Você também pode alterar o nome. Para fornecer um acesso fácil aos usuários, você pode adicionar os aplicativos do XML a teclas de função ou teclas de linha.

Os recursos suportados são:

  • Mensagens (imagens e texto)
  • Paginação

Objetos XML com suporte

  • CiscoIPPhoneMenu

  • CiscoIPPhoneText

  • CiscoIPPhoneInput

  • CiscoIPPhoneDirectory

  • CiscoIPPhoneImage

  • CiscoIPPhoneImageFile

  • CiscoIPPhoneIconMenu

  • CiscoIPPhoneIconFileMenu

  • CiscoIPPhoneStatus (exceto 9841)

  • Arquivo de status do ciscoIPPhone (exceto 9841)

  • CiscoIPPhoneExecute

URIs suportadas

  • Dispositivo

  • Discar

  • EditarDail

  • Init

  • Chave

  • Reproduzir (apenas toques)

  • Tecla de função

Para obter mais detalhes sobre a configuração do serviço XSI, consulte Cisco Unified IP Phone Notas de Desenvolvimento de Aplicativo de Serviços.

Configurar um telefone para se conectar a um serviço de XML

1

Acesse a página da Web de administração do telefone.

2

Selecione Voz > Telefone.

3

Na seção XML Serviço , configure os parâmetros XML Nome do Serviço de Aplicativos e XML Serviço de Aplicativos, conforme definido em Parâmetros para serviços XML.

4

(Opcional) Para adicionar autenticação para acesso ao serviço do aplicativo, configure estes campos: XML Nome de usuário,XML Senha,CISCO XML ATIVAr EXE e CISCO XML Modo Auth EXE.

5

Clique em Salvar todas as alterações.

Parâmetros dos serviços XML

A tabela a seguir define a função e o uso dos parâmetros de aplicativo XML na seção Serviço XML sob a guia Voz > Phone na interface da Web do telefone. Ela também define a sintaxe da string que é adicionada ao arquivo de configuração do telefone (cfg.xml) com o código XML para configurar um parâmetro.

Tabela 1. Parâmetros dos serviços XML

Parâmetro

Padrão e opções

Descrição

Nome do serviço de aplicativos XML

Padrão: vazio

O nome do aplicativo XML. O nome é exibido no telefone como uma opção de aplicativo da Web.

Você também pode configurar esse parâmetro no arquivo XML de configuração do telefone (cfg.xml) inserindo uma string neste formato:

<XML_Application_Service_Name ua=">XML Nome do APP</XML_Application_Service_Name>

URL do serviço de aplicativos XML

Padrão: vazio

Insira a URL em que a aplicação do telefone está localizada.

Você também pode configurar esse parâmetro no arquivo XML de configuração do telefone (cfg.xml) inserindo uma string neste formato:

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

Variáveis de macro são suportadas em URLs XML. Para as variáveis de macro válidas, consulte as variáveis de macro suportadas em XML URLs.

Somente os protocolos HTTP ou HTTPs são suportados na URL.

Nome de usuário XML

Padrão: vazio

Nome de usuário do serviço XML para fins de autenticação.

Você também pode configurar esse parâmetro no arquivo XML de configuração do telefone (cfg.xml) inserindo uma string neste formato:

<XML_User_Name ua="na">username</XML_User_Name>

Senha XML

Padrão: vazio

Senha do serviço XML para o nome de usuário XML especificado.

A senha inserida nesse campo mostra o arquivo de configuração (cfg.xml) como o seguinte:

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

Ativar o CISCO XML EXE

Padrão: No

Opções: Sim, Não

Especifica se a autenticação é necessária para acessar o servidor de aplicativos XML.

Você também pode configurar esse parâmetro no arquivo XML de configuração do telefone (cfg.xml) inserindo uma string neste formato:

<CISCO_XML_EXE_Enable ua="na">Yes</CISCO_XML_EXE_Enable>

Modo de autenticação do CISCO XML EXE

Padrão: credencial local

Opções: confiável, Credencial local, Credencial remota

Especifica o modo de autenticação para o Cisco XML EXE.

  • Confiável — nenhuma autenticação é realizada, independentemente da credencial local.

  • Credencial local — a autenticação se baseia na autenticação Digest usando a credencial local, se definida. Se a credencial local não for definida, nenhuma autenticação será executada.

  • Credencial remota — a autenticação se baseia na autenticação Digest usando a credencial remota conforme definido no aplicativo XML na página da Web (para acessar um servidor de aplicativos XML).

Você também pode configurar esse parâmetro no arquivo XML de configuração do telefone (cfg.xml) inserindo uma string neste formato:

<CISCO_XML_EXE_Auth_Mode ua="na">EntradaLocal</CISCO_XML_EXE_Auth_Mode>

Adicionar um aplicativo XML a uma tecla de função

Adicione os aplicativos usados com frequência a teclas de função para que os usuários acessem o serviço facilmente.

Antes de começar

O XML Application Service foi devidamente configurado.

1

Acesse a página da Web de administração do telefone.

2

Selecione Voz > Telefone.

3

Na seção Teclas de função programáveis, defina Ativação da tecla de função programável como Sim.

Você também pode configurar esse parâmetro no arquivo de configuração (cfg.xml). Insira uma string neste formato:

<Programmable_Softkey_Enable ua="na">Yes</Programmable_Softkey_Enable>
4

Na seção Teclas de função programáveis, edite os campos disponíveis de PSK1 para PSK16 neste formato:

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

onde url é o link onde o XML aplicativo está armazenado; nme é o nome de exibição do aplicativo na tela do telefone.

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

Você também pode configurar esse parâmetro no arquivo de configuração (cfg.xml). Insira uma string neste formato:

<PSK_n ua="na">fnc=xml;url=http://10.77.21.37/xmlapp/menu.xml;nme=Menu<configuração código></PSK_n>

onde n é o número da tecla de função.

5

Clique em Salvar todas as alterações.

Adicionar um aplicativo XML a uma tecla de linha

Adicione os aplicativos usados com frequência às chaves de linha para que os usuários acessem os serviços facilmente.

Antes de começar

O XML Application Service foi devidamente configurado.

1

Acesse a página da Web de administração do telefone.

2

Selecione Voz > Telefone.

3

Selecione uma tecla de linha.

4

Defina o parâmetro Ramal como Desabilitado para desabilitar o ramal.

Se o recurso de Configuração de PLK direta estiver desativado, você deverá desativar o ramal para adicionar uma função ampliada à tecla de linha. Se o recurso estiver habilitado, você poderá ignorar esta etapa. Para obter detalhes, consulte a configuração de Ativar PLK direta.
5

No parâmetro Função estendida, insira uma string neste formato:

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

onde url é o link onde o XML aplicativo está armazenado; nme é o nome de exibição do aplicativo na tela do telefone.

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

Você também pode configurar esse parâmetro no arquivo de configuração (cfg.xml). Insira uma string neste formato:

<Extended_Function_n_ ua="na">fnc=xml;url=http://10.77.21.37/xmlapp/menu.xml;nme=Menu<configuração código></Extended_Function_n_>

onde n é o número do ramal.

6

Clique em Salvar todas as alterações.

Variáveis de macro suportadas em URLs XML

Você pode usar variáveis de macro em URLs XML. As seguintes variáveis de macro são suportadas:

  • ID do usuário — UID1, UID2 para UIDn

  • Nome de exibição — DISPLAYNAME1, DISPLAYNAME2 para DISPLAYNAMEn

  • ID de autenticação — AUTHID1, AUTHID2 para AUTHIDn

  • Proxy — PROXY1, PROXY2 para PROXYn

  • Endereço MAC usando dígitos hexadecimais em minúsculas — MA

  • Nome do produto — PN

  • Número da série do produto — PSN

  • Número de série — SERIAL_NUMBER

Tabela 2. Macros compatíveis
Nome da macro:Expansão da macro
$A forma $$ se expande para um único caractere $.
A a PSubstituído por parâmetros de finalidade geral GPP_A por meio de GPP_P.
SA a SDSubstituído por parâmetros de finalidade especial GPP_SA a GPP_SD. Esses parâmetros contêm chaves ou senhas usadas em provisionamento.
$SA a $SD são reconhecidos como argumentos para o qualificador de URL de ressincronização opcional, --key.
MAEndereço MAC usando dígitos hexadecimais minúsculos (000e08aabbcc).
MAUEndereço MAC usando dígitos de maiúsculas hexadecimais (000E08AABBCC).
MACEndereço MAC usando dígitos hexadecimais minúsculos com dois-pontos para separar pares de dígitos hexadecimais (00:0E: 08: AA: BB: CC).
PNNome do produto; por exemplo, Telefone de vídeo 8875, Telefone de mesa 9851.
PSNNúmero da série de produtos; por exemplo, 8875, 9841, 9861
SNCadeia de caracteres do número de série; por exemplo, 88012BA01234.
CCERTStatus do certificado do cliente SSL, instalado ou não instalado.
IPEndereço IP do telefone dentro de sua sub-rede local; por exemplo, 192.168.1.100.
EXTIPIP externo do telefone, como visto na Internet; por exemplo, 66.43.16.52.

SWVER

String de versão do software. Por exemplo:

PHONEOS.3-2-1-0104-37

HWVER

String de versão do hardware. Por exemplo, 2.0.1

PRVST

Estado de provisionamento (uma string numérica):

-1 = Solicitação de ressincronização explícita

0 = Ressincronização de inicialização

1 = Ressincronização periódica

2 = falha na ressincronização. tente novamente

UPGST

Estado da atualização (uma string numérica):

1 = Primeira tentativa de atualização

2 = Falha na atualização, tente novamente

UPGERR

Mensagem de resultado (ERR) da tentativa de atualização anterior; por exemplo http_get falhou.

PRVTMR

Segundos desde a última tentativa de ressincronização.

UPGTMR

Segundos desde a última tentativa de atualização.

REGTMR1

Segundos desde que a Linha 1 perdeu o registro com o servidor SIP.

REGTMR2

Segundos desde que a Linha 2 perdeu o registro com o servidor SIP.

UPGCOND

Nome da macro herdada.

SCHEME

Esquema de acesso a arquivo, um de TFTP, HTTP ou HTTPS, conforme obtido após a análise da nova sincronização ou da atualização da URL.

SERV

Nome do host do servidor de destino da solicitação, conforme obtido após a análise da URL de ressincronização ou atualização.

SERVIP

Endereço IP do servidor de destino da solicitação, conforme obtido após a análise da nova sincronização ou atualização da URL, possivelmente seguindo a pesquisa DNS.

PORTA

Porta UDP/TCP de destino da solicitação, conforme obtido após a análise da nova sincronização ou da atualização da URL.

CAMINHO

Caminho do arquivo de destino da solicitação, conforme obtido após a análise da nova sincronização ou da atualização do URL.

ERR

Mensagem de resultado da tentativa de ressincronização ou atualização. Útil apenas para gerar mensagens syslog de resultado. O valor é preservado na variável UPGERR no caso de tentativas de atualização.

UIDn

O conteúdo do parâmetro de configuração UserID da Linha n.

ISCUST

Se unidade for personalizada, valor = 1, caso 0.

O status de personalização pode ser visualizado na página de Informações da UI da Web.

INCOMINGNAMENome associado à primeira chamada conectada, tocando ou de entrada.
REMOTENUMBER

O número de telefone da primeira chamada conectada, tocando ou recebida. Se houver várias chamadas, os dados associados à primeira chamada encontrada serão fornecidos.

DISPLAYNAMEnO conteúdo do parâmetro de configuração do nome de exibição da linha N.
AUTHIDnO conteúdo do parâmetro de configuração linha N auth ID.