VSPHONE

Manual de integração via

WebService

Belo Horizonte, 24 de Novembro de 2015.

 1. Introdução
Este manual tem como objetivo apresentar as especificações e critérios técnicos
necessários para utilização do WebService do VSPhone.
Utilizando o WebService as empresas poderão integrar seus próprios sistemas de
informações com o VSPhone. Desta forma, consegue-se automatizar o processo
discagem, bilhetagem e busca de audio.

2. Especificação
Os Clientes do VSPhone que optarem pela integração de sistemas podem utilizar o
WebService do VSPhone para importar as informações telefônicas para os seus
sistemas..

3. Conexão com o WebService

Para verificar os métodos disponíveis basta acessar a página: http://
http://<IP_VSPHONE>:8080/services/VSPhone.
Para carregar as informações dos métodos basta criar um client do WebService do
VSPhone acessando http://<IP_VSPHONE>:8080/services/VSPhone?wsdl.
Todos os métodos necessitam que sejam enviados após a autenticação pelo método
de login, onde deve ser informado o usuário e senha com permissão de webservice.
As chamadas necessitam da sessão autenticada ou retornarão usuário inválido.

4. Métodos do WebService

4.1 Discagem
A funcionalidade de discagem do VSPhone se responsabiliza por receber os dados
referentes a uma chamada e gravá-los na base do VSPhone, gerando chamada para
a origem e destino informados. Caso haja alguma inconsistência nos dados
informados durante o processo, a mensagem do problema é retornada ao requisitante.

Este é um processo síncrono.

Chamada do Método: originaChamada

Parâmetros de Envio: OriginaChamadaRequest (tns:OriginaChamadaRequest)

Parâmetros de Resposta: originaChamadaResponse(tns:originaChamadaResponse)

4.2 Procura de Chamadas

A funcionalidade de Procura de chamadas se responsabiliza por receber os dados
referentes a chamadas já efetuadas e retornar as informações da mesma. Caso haja
alguma inconsistência nos dados informados durante o processo, a mensagem do
problema é retornada ao requisitante.

Este é um processo síncrono.

 Chamada do Método: procuraChamada

Parâmetros de Envio: ProcuraChamadaRequest (tns:ProcuraChamadaRequest)

Parâmetros de Resposta: procuraChamadaResponse(tns:procuraChamadaResponse),

DetalhesChamada(tns:DetalhesChamada)

4.3 Busca Gravação (Base 64)

A funcionalidade de busca gravação retorna de uma gravação específica no formato
base64.

Este é um processo síncrono.

Chamada do Método: BuscaGravacaoBase64

Parâmetros de Envio: BuscaGravacaoRequest (tns: BuscaGravacaoRequest)

Parâmetros de Resposta: BuscaGravacaoBase64(tns:BuscaGravacaoBase64)

4.4 Busca Gravação (Array de Bytes)

A funcionalidade de busca gravação retorna de uma gravação específica no formato
base64.
Este é um processo síncrono.

Chamada do Método: BuscaGravacaoByteArray

Parâmetros de Envio: BuscaGravacaoRequest (tns: BuscaGravacaoRequest)

Parâmetros de Resposta: BuscaGravacaoByteArray (tns: BuscaGravacaoByteArray)

5. Estrutura de Dados
5.1 Estruturas de Envio
5.1.1 tns:OriginaChamadaRequest (Tipo Complexo)
Campo Formato Tipo Descrição Ocorrência
aplicacao xsd:string Simples Aplicação Asterisk Opcional.
a Ser executada
quando a
chamada for
completada
aplicacaoDados xsd:string Simples Dados da Opcional.
aplicação a ser
executada
contexto xsd:string Simples Contexto para Opcional.
chamadas
destino xsd:string Simples Telefone de Obrigatório.
Destino
identificacao xsd:string Simples Bina a Ser Opcional.
informada
monitorar xsd:boolean Simples Gerar Eventos Opcional
de
Monitoramento
origem xsd:string Simples Telefone de Obrigatório
Origem quando a
aplicação não é
preenchida
tempoLimite xsd:long Simples Tempo para tocar Opcional.
variaveis impl:ArrayOf_tns1_Variavel Complexo Variáveis para Opcional.
identificação
posterior da
chamada
5.1.2 tns: Variavel

Campo Formato Tipo Descrição

nome xsd:string Simples Nome da Variável
Valor xsd:string Simples Valor da Variável

5.1.3 tns: ProcuraChamadaRequest

Campo Formato Tipo Descrição

inicio xsd:dateTime Simples Data/Hora de Início
fim xsd:dateTime Simples Data/Hora de fim.
numeroOrigem xsd:string Simples Número de Origem (Opcional)
numeroDestino xsd:string Simples Número de Destino (Opcional)
procuraParcial xsd:boolean Simples Habilita o “LIKE” nos campos
numeroOrigem e numeroDestino

5.1.4 tns: BuscaGravacaoRequest

Campo Formato Tipo Descrição

id xsd:int Simples Código da Chamada

5.2 Estruturas de resposta

5.2.1 tns: OriginaChamadaResponse (Tipo Complexo)

Campo Formato Tipo Descrição

identificacaoChamada xsd:string Simples Identificação da Chamada
mensagem xsd:string Simples Mensagem de Resposta em Caso de
Erros
resposta xsd:string Simples Resposta do Asterisk.
sucesso xsd:boolean Simples Sucesso/Falha na execução
 5.2.2 tns: DetalhesChamada(Tipo Array)

Campo Formato Tipo Descrição

bilhetagem xsd:int Simples Código da Bilhetagem
codigoConta xsd:string Simples Código de Conta
datahoraChamada xsd:date Simples Data e Hora da Chamada
Time
duracao xsd:int Simples Duração da Chamada
id xsd:int Simples Identificação da Chamada
(BuscaGravacao)
identificacaoOrigem xsd:string Simples Bina
nomeArquivo xsd:string Simples Nome do Arquivo de Audio
numeroDestino xsd:string Simples Número do Destino
numeroOrigem xsd:string Simples Número da Origem
status xsd:string Simples Status da Chamada

5.2.3 tns: BuscaGravacaoBase64 (Tipo Complexo)

Campo Formato Tipo Descrição

arquivo xsd:string Simples Gravação encodada em Base64

5.2.4 tns: BuscaGravacaoByteArray (Tipo Complexo)

Campo Formato Tipo Descrição

arquivo xsd:base64Binary Complexo Array de Bytes da Chamada