Visão geral

A XML Services Interface (XSI) é um protocolo que permite a comunicação entre aplicativos e o sistema de telefonia. 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 para Configurações > Rede e serviço > Serviços Cisco XML . Os serviços XML da Cisco são o nome padrão. Você também pode alterar o nome. Para fornecer um acesso fácil aos usuários, você pode adicionar os aplicativos XML a teclas programáveis ou teclas de linha.

Os recursos suportados são:

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

Objetos XML compatíveis

  • CiscoIPPhoneMenu

  • CiscoIPPhoneText

  • CiscoIPPhoneInput

  • CiscoIPPhoneDirectory

  • CiscoIPPhoneImage

  • CiscoIPPhoneImageFile

  • CiscoIPPhoneIconMenu

  • CiscoIPPhoneIconFileMenu

  • CiscoIPPhoneStatus (exceto 9841)

  • CiscoIPPhoneStatusFile (exceto 9841)

  • CiscoIPPhoneExecute

URIs compatíveis

  • Dispositivo

  • Discar

  • EditDail

  • Init

  • Chave

  • Reproduzir (somente toques)

  • Tecla Programável

Para obter mais detalhes sobre a configuração do serviço XSI, consulte Notas de desenvolvimento de aplicativos de serviços de telefonia unificados da Cisco .

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

1

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

2

Selecione Voice > Phone .

3

Na seção XML Service , configure os parâmetros XML Application Service Name e XML Application Service conforme definido em Parâmetros para serviços XML .

4

(Opcional) Para adicionar autenticação para acessar o serviço de aplicativos, configure os campos teses: Nome de usuário XML , Senha XML , Ativar o CISCO XML EXE e Modo de autenticação do CISCO XML 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 do aplicativo XML na seção XML Service na guia Voice > Phone na interface da Web do telefone. Ele também define a sintaxe da string que é adicionada no arquivo de configuração do telefone (cfg.xml) com 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

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="na">Nome do APLICATIVO XML</XML_Application_Service_Name>

URL do serviço de aplicativos XML

Padrão: Vazio

A URL onde o aplicativo XML está localizado.

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="na">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 Variáveis de macro suportadas em URLs XML .

Apenas 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">nome de usuário</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 é mostrada no arquivo de configuração (cfg.xml) como o seguinte:

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

Ativação do CISCO XML EXE

Padrão: Não

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">Sim</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 estiver 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">Credencial local</CISCO_XML_EXE_Auth_Mode>

Adicionar um aplicativo XML a uma tecla programável

Adicione os aplicativos usados com frequência às teclas programáveis para que os usuários acessem o serviço facilmente.

Antes de você começar

O serviço de aplicativos XML foi configurado corretamente.

1

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

2

Selecione Voice > Phone .

3

Na seção Teclas de função programáveis , defina a Tecla de função programável Ativar para 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">Sim</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 aplicativo XML é 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 <código de configuração></PSK_n>

onde n é o número da tecla programável.

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 teclas de linha para que os usuários acessem os serviços facilmente.

Antes de você começar

O serviço de aplicativos XML foi configurado corretamente.

1

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

2

Selecione Voice > Phone .

3

Selecione uma tecla de linha.

4

Defina o parâmetro Extension como Desabled para desativar o ramal.

Se o recurso Configuração PLK direta estiver desativado, você deverá desativar o ramal para adicionar uma função estendida à tecla de linha. Se o recurso estiver ativado, você poderá pular esta etapa. Para obter detalhes, consulte Ativar configuração 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 aplicativo XML é 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 <código de configuração></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 de usuário — UID1, UID2 para UIDn

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

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

  • Proxy — PROXY1, PROXY2 para PROXYn

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

  • Nome do produto — PN

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

  • Número de série — SERIAL_NUMBER

Tabela 2. Macros suportadas
Nome da macroExpansão de 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 através de SDSubstituído por parâmetros de finalidade especial GPP_SA por GPP_SD. Esses parâmetros contêm chaves ou senhas usadas no provisionamento.
$SA a $SD são reconhecidos como argumentos para o qualificador de URL de ressincronização opcional, --key.
MÃEEndereço MAC usando dígitos hexadecimais minúsculos (000e08aabbcc).
MAUEndereço MAC usando dígitos hexadecimais de maiúsculas (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 do produto; por exemplo, 8875, 9841, 9861
SNString de 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

COLHEITA

String da 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. Repita a tentativa

PRÓXIMO

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.

CARREGAMENTO

Nome da macro herdada.

ESQUEMA

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 da 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 da 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.

ISCÊNCIA

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

O status de personalização é visível na página de Informações da IU da Web.

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

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

EXPLICAR NOMEAO conteúdo do parâmetro de configuração do nome de exibição da linha N.
AUTÍDEOO conteúdo do parâmetro de configuração da ID de autenticação da linha N.