08/01/2014

Sumrio
1. Funcionamento da Soluo .....................................................................................................2
2. WebService: consulta verso 1 .............................................................................................2
2.1 Especificao dos mtodos disponveis ........................................................................3
3. WebService: consulta verso 2 .............................................................................................4
3.1 Especificao dos mtodos disponveis ........................................................................4
4. WebService: consulta verso3 ..............................................................................................5
4.1 Especificao dos mtodos disponveis ........................................................................6
5. Consultas via URL ......................................................................................................................8
5.1 Consultando apenas um nmero ...................................................................................8
5.2 Consultando vrios nmeros ...........................................................................................8
5.3 Parmetros adicionais da consulta via URL ................................................................9

08/01/2014

1. Funcionamento da Soluo
Consulta Nmero via Web Service, uma integrao que informa a
operadora do numero mvel ou fixo do Brasil utilizando WebService.
Temos trs servidores disponveis na internet ou se preferir pode ser
instalado no cliente local. Ele ser atualizado diariamente com os
servidores da Telein (necessrio acesso Internet para
atualizaes).
O Cliente envia o nmero via Web Service (um ou vrios nmeros
por vez), ou via URL (um nmero por vez) no formato
DDD+Nmero para o Servidor em rede local dedicado para o cliente,
ou para um dos servidores disponveis via Internet.
O Consulta Nmero informar ao solicitante a operadora dos
nmeros enviados. Analisando a base da portabilidade, ele informa
caso o nmero seja portado ou no. Informa ainda, os prefixos
padres, se o nmero no for portado.
O Consulta Nmero responder ao solicitante os nmeros que foram
solicitados no seguinte formato: Cod.Operadora+#+DDD+ Nmero
Exemplo: 15#8199626363 - 15# referente a operadora Vivo.

2. WebService: consulta verso 1

Nesta verso o numero consultado ter como resposta o Id+numero, e
todas as consultas so realizadas atravs de chamadas ao WebService,
usando SOAP/XML, disponvel nas URLs:
http://consultanumero1.telein.com.br/webservices/v1/consulta.php?wsdl
http://consultanumero2.telein.com.br/webservices/v1/consulta.php?wsdl
http://consultanumero3.telein.com.br/webservices/v1/consulta.php?wsdl
O WebService utiliza um mecanismo de autenticao definido no tipo
complexo tns:Usuario, contendo o login, chave e hash gerados para
autenticao, devendo ser usado da seguinte forma:
login: login do usurio cadastrado no Sistema Consulta Numero;
chave: chave que o usurio dever gerar aleatoriamente. Ela
usada para criar o hash. ( recomendado mudar em cada requisio
por segurana);
senha: senha URL enviada aps cadastro no Sistema Consulta
Nmero
hash: aplicao do algoritmo SHA1 no conjunto chave + senha.
Exemplo(php): sha1($chave . $senha).
O login e senha para acesso nico para cada cliente do Servio.

08/01/2014

2.1 Especificao dos mtodos disponveis

autenticar (Autentica um usuario no WebService)

Parmetros: autenticarRequest (tns:Usuario)
Retorno: autenticarResponse
Propriedade

Tipo

Descrio

codigo

numerico

Cdigo do resultado (100 para sucesso)

descricao

string

Detalhes do resultado

listarOperadoras (Lista as operadoras)

Parmetros: listarOperadorasRequest (tns:Usuario)
Retorno: listarOperadorasResponse (tns:Operadoras)
Propriedade

Tipo

Descrio

id

numerico

ID da operadora

operadora

string

Nome da Operadora

consultarOperadoraNumero (Consulta a operadora atual do nmero

informado)
Parmetros: consultarOperadoraNumeroRequest (tns:Usuario,
xsd:string)
Retorno: consultarOperadoraNumeroResponse (tns:string)

Propriedade

Tipo

Descrio

return

string

Operadora + # + Numero informado

consultarOperadorasNumeros (Consulta as operadoras atuais dos

nmeros informados)
Parmetros:
consultarOperadorasNumerosRequest
(tns:Usuario, tns:Strings)
Retorno: consultarOperadorasNumerosResponse (tns:Strings)

Propriedade

Tipo

Descrio

return

string

Operadora + # + Numero informado

08/01/2014

3. WebService: consulta verso 2

Nesta verso acrescentado um parmetro resposta do nmero
consultado para checar se o mesmo portado ou no ficando o resultado
check+Id+numero, e todas as consultas so realizadas atravs de
chamadas ao WebService, usando SOAP/XML, disponveis nas URLs:
http://consultanumero1.telein.com.br/webservices/v2/consulta.php?wsdl
http://consultanumero2.telein.com.br/webservices/v2/consulta.php?wsdl
http://consultanumero3.telein.com.br/webservices/v2/consulta.php?wsdl
O WebService utiliza um mecanismo de autenticao definido no tipo
complexo tns:Usuario, contendo o login, chave e hash gerados para
autenticao, devendo ser usado da seguinte forma:
login: login do usurio cadastrado no Sistema Consulta Numero;
chave: chave que o usurio dever gerar aleatoriamente. Ela
usada para criar o hash. ( recomendado mudar em cada requisio
por segurana);
senha: senha URL enviada aps cadastro no Sistema Consulta
Nmero
hash: aplicao do algoritmo SHA1 no conjunto chave + senha.
Exemplo(php): sha1($chave . $senha).
O login e senha para acesso nico para cada cliente do Servio.
3.1 Especificao dos mtodos disponveis

autenticar (Autentica um usuario no WebService)

Parmetros: autenticarRequest (tns:Usuario)
Retorno: autenticarResponse
Propriedade

Tipo

Descrio

codigo

numerico

Cdigo do resultado (100 para sucesso)

descricao

string

Detalhes do resultado

listarOperadoras (Lista as operadoras)

Parmetros: listarOperadorasRequest (tns:Usuario)
Retorno: listarOperadorasResponse (tns:Operadoras)
Propriedade

Tipo

Descrio

id

numerico

ID da operadora

operadora

string

Nome da Operadora

08/01/2014

consultarOperadoraNumero (Consulta a operadora atual do nmero

informado)
Parmetros: consultarOperadoraNumeroRequest (tns:Usuario,
xsd:string)
Retorno: consultarOperadoraNumeroResponse (tns:string)

Propriedade

Tipo

Descrio

return

string

Portado + # + Operadora + # + Numero

consultarOperadorasNumeros (Consulta as operadoras atuais dos

nmeros informados)
Parmetros:
consultarOperadorasNumerosRequest
(tns:Usuario, tns:Strings)
Retorno: consultarOperadorasNumerosResponse (tns:Strings)

Propriedade

Tipo

Descrio

return

string

Portado + # + Operadora + # + Numero

4. WebService: consulta verso3

Nesta verso a consulta usar um parmetro timestamp que limitar o
tempo de consulta aumentando a segurana, as informaes passadas
adiante, e todas as consultas so realizadas atravs de chamadas ao
WebService, usando SOAP/XML, disponveis nas URLs:
http://consultanumero1.telein.com.br/webservices/v3/consulta.php?wsdl
http://consultanumero2.telein.com.br/webservices/v3/consulta.php?wsdl
http://consultanumero3.telein.com.br/webservices/v3/consulta.php?wsdl
O WebService utiliza um mecanismo de autenticao definido no tipo
complexo tns:Usuario, contendo o login, chave e hash gerados para
autenticao, devendo ser usado da seguinte forma:
login: login do usurio cadastrado no Sistema Consulta Numero;
chave: chave que o usurio dever gerar aleatoriamente. Ela
usada para criar o hash. ( recomendado mudar em cada requisio
por segurana);
senha: senha URL enviada aps cadastro no Sistema Consulta
Nmero
hash: aplicao do algoritmo SHA1 no conjunto data/hora + chave
+ senha.
Exemplo(php): sha1(date('Y-m-d H:i').$chave.$senha).

08/01/2014

Para sincronizar o timestamp com o do ServidorTelein basta acessar a

URL:
http://consultanumero1.telein.com.br/webservices/v3/timestamp.php
Que j traz a data no formato para ser utilizado no webservice.
O acrescimo do timestamp no verso 3 faz com que os hashs gerados
durem apenas 1 minuto forando a troca contnua e aumentando a
segurana.
O login e senha para acesso nico para cada cliente do Servio.
4.1 Especificao dos mtodos disponveis

autenticar (Autentica um usuario no WebService)

Parmetros: autenticarRequest (tns:Usuario)
Retorno: autenticarResponse
Propriedade

Tipo

Descrio

codigo

numerico

Cdigo do resultado (100 para sucesso)

descricao

string

Detalhes do resultado

listarOperadorasSimples (Padro de resposta resumido)

Parmetros: listarOperadorasRequest (tns:Usuario)
Retorno: listarOperadorasResponse (tns:Operadoras)
Propriedade

Tipo

Descrio

id

numerico

ID da operadora

operadora

string

Nome da Operadora

listarOperadorasCompletas (Padro de resposta detalhado)

Parmetros: listarOperadorasRequest (tns:Usuario)
Retorno: listarOperadorasResponse (tns:Operadoras)
Propriedade

Tipo

Descrio

id

numerico

ID da operadora

operadora

string

Nome da Operadora

08/01/2014

consultarNumero (Consulta no padro de resposta resumido)

Parmetros:
consultarNumeroRequest
(tns:Usuario,
xsd:string)

Retorno: consultarNumeroResponse (tns:string)

Propriedade

Tipo

Descrio

portado

boolean

Se o nmero portado ou no

operadora

integer

Cdigo da operadora

numero

integer

Nmero consultado

consultarNumeros (Vrias consultas resumidas)

Parmetros:
consultarNumerosRequest

(tns:Usuario,

tns:Strings)
Retorno: consultarNumerosResponse (tns:Numeros)

Propriedade

Tipo

Descrio

return

Numeros

Array de nmeros (portado, operadora e

numero)

consultarOperadora (Padro de resposta detalhado)

Parmetros:
consultarOperadoraRequest

(tns:Usuario,
xsd:string)
Retorno: consultarOperadoraResponse (tns:string)

Propriedade

Tipo

Descrio

portado

boolean

Se o nmero portado ou no

operadora

integer

Cdigo da operadora

numero

integer

Nmero consultado

consultarOperadoras (Vrias consultas detalhadas)

Parmetros:
consultarOperadorasRequest

(tns:Usuario,

tns:Strings)
Retorno: consultarOperadorasResponse (tns:Numeros)

Propriedade Tipo

Descrio

return

Array de nmeros (portado, operadora e numero)

Numeros

08/01/2014

5. Consultas via URL

As consultas podem tambm ser realizadas atravs de requisies HTTP
(Get ou Post), passando como parmetros a chave (senha) e o(s)
nmero(s) desejados, segue descrio de utilizao abaixo:

5.1 Consultando apenas um nmero

Os exemplos abaixo faz referencia aos trs servidores disponveis em
rede. Caso tenha um servidor local dever substituir pelo IP do servidor
interno.
http://consultanumero1.telein.com.br/sistema/consulta_numero.php?chav
e=<chave>&numero=<numero_desejado>
http://consultanumero2.telein.com.br/sistema/consulta_numero.php?chav
e=<chave>&numero=<numero_desejado>
http://consultanumero3.telein.com.br/sistema/consulta_numero.php?chav
e=<chave>&numero=<numero_desejado>
Onde:
<chave> a chave(senha URL) de validao do cliente , e
<numero_desejado> o nmero com ddd cuja operadora deseja-se
consultar.
5.2 Consultando vrios nmeros
http://consultanumero1.telein.com.br/sistema/consulta_numeros.php?cha
ve=<chave>&numeros=<numeros_desejados>
http://consultanumero2.telein.com.br/sistema/consulta_numeros.php?cha
ve=<chave>&numeros=<numeros_desejados>
http://consultanumero3.telein.com.br/sistema/consulta_numeros.php?cha
ve=<chave>&numeros=<numeros_desejados>
Onde:
<chave> a chave (senha URL) de validao do cliente, e
<numeros_desejados> a lista de nmeros com ddd separados por
vrgula. A resposta ser uma lista igualmente separada por vrgula.

08/01/2014

5.3 Parmetros adicionais da consulta via URL

A resposta apresentada pela consulta via URL pode ser personalizada
adicionando os seguintes parmetros na URL:

&socsp -> oculta o nmero consultado na resposta, apresentando apenas

o cdigo da operadora.
http://consultanumero.telein.com.br/sistema/consulta_numeros.php?chav
e=<chave>&numeros=<numeros_desejados>&socsp

&check -> informa se o nmero portado ou nao, adicionando 1# se o

nmero portado ou 0# caso contrrio.
http://consultanumero.telein.com.br/sistema/consulta_numeros.php?chav
e=<chave>&numeros=<numeros_desejados>&check