Documentação Técnica

Telefones - Estendido

Descrição

O dataset de Telefones Estendido retorna, além das informações contidas no dataset de Telefones, uma série de informações adicionais sobre características gerais do próprio telefone, tais como quantas vezes o telefone foi visto (independente de ser junto com a entidade consultada ou não). Além disso, é retornado um objeto principal com uma série de informações agregadas sobre todos os telefone encontrados para a entidade, simplificando trabalhos de modelagem e análise de dados.

Origem da Informação

Todos os números de telefone disponibilizados pela BigData Corp. tem como origem algum conteúdo capturado do ambiente público da internet. Esse conteúdo pode ser o HTML de uma página (como um anúncio postado em um marketplace, ou uma mensagem postada em um fórum), um documento PDF (como um processo judicial ou um artigo acadêmico), ou qualquer outro elemento que contenha informações que possam ser extraídas. A evidência de origem da informação de contato e de sua associação com a entidade consultada está disponível mediante requisição para a equipe de atendimento.

Tabela de preços para esse dataset

Consultas Realizadas no MêsValor por consulta
1 - 10000R$ 0,050
10001 - 50000R$ 0,048
50001 - 100000R$ 0,046
100001 - 500000R$ 0,044
500001 - 1000000R$ 0,042
1000001 - 5000000R$ 34.000,00 (preço fixo)
5000001 e acimaEntre em contato

Parâmetros de consulta

A tabela abaixo detalha os campos aceitos na consulta a este dataset.

CampoDescriçãoValores PossíveisTipo de Campo
docDocumento de identificaçãoCPF🛑 Obrigatório
phonePermite um telefone adicional de entrada para a consulta. O propósito desse telefone adicional é a pesquisa pelas informações globais genéricas do telefone informado, independente de sua associação explícita com o número de documento específico consultado.Um número válido de telefoneℹ️  Opcional
returnonlydifferentphonesPermite que somente sejam retornados telefones diferentes daqueles que foram especificados na chamada, mas que sejam associados ao mesmo titular. O parâmetro quando passado como "true" é habilitado e quando não especificado assume como padrão o valor "false". Este parâmetro permite o controle sobre o retorno da sua chamada, evitando a cobrança caso não existam informações adicionais de outros telefones além dos que foram passados na busca. Para utilizar este campo, basta especificar o parâmetro como "returnonlydifferentphones{true}" e informar a lista de telefones no formato "phone[ xxxxx-xxxx, xxxxx-xxxx, ... ]" .true, falseℹ️  Opcional
withmatchrateEste campo permite que seja realizada uma comparação entre os números de telefones retornados e o informado através do parâmetro "phone". Para usar essa funcionalidade, um número de telefone deve ser informado no campo "phones", usando a notação de chaves. Ao habilitar este campo, passando o valor "true", será aplicado um algorítmo de distância de palavras para definir a semelhança do telefone informado com cada um dos números retornados na lista. O resultado da operação será atribuido ao campo "MatchRate". Um "MatchRate" de 100 indica que os números são idênticos, valores menores indicam menor similaridade. O valor padrão para esse campo é "false".true, falseℹ️  Opcional

Clique aqui para saber mais sobre os parâmetros de consulta da Plataforma de Dados.

Abaixo está um exemplo de como realizar a chamada apenas com os parâmetros obrigatórios:

{  
    "Datasets": "phones_extended",
    "q": "doc{CPF}"  
}  

Filtros

CampoDescrição do filtroTipo do filtroValores Possíveis do Filtro
typeTipo do telefoneIgualmobile, work, home
isactiveSe o telefone esta ativoIgualtrue, false
isrecentSe o telefone recenteIgualtrue, false
ismainSe o telefone principalIgualtrue, false
isindonotcalllistSe o telefone est na lista do PROCONIgualtrue, false
areacodeCódigo de areaIgual21, 11, 61, ...

Abaixo está um exemplo de como utilizar o parâmetro .filter(nome_do_campo=XXXX)

{  
    "Datasets": "phones_extended.filter(type=mobile)",
    "q": "doc{CPF}"  
}  

Limite

Para utilizar o campo de limite basta utilizar o parâmetro .limit(x)
Os telefones retornados estarão ordenados pelo campo priority, buscando sempre retornar os números mais relevantes.

{  
    "Datasets": "phones_extended.limit(10)",
    "q": "doc{CPF}"  
}  

Prioridade de Contato

Os retornos da nossa API te permitem identificar o que seria o melhor contato para falar com alguém de algumas formas diferentes. Primeiro, retornamos para todos os contatos um atributo de "Prioridade" (Priority), que indica, na nossa avaliação, qual seria o contato prioritário para o indivíduo. Quanto mais baixo o número, melhor.
Segundo, você pode olhar para as passagens relacionadas com os contatos. No geral, quanto mais passagens uma informação de contato tem com uma entidade, maior a relevância daquele contato para ela. Ao mesmo tempo, as passagens também entregam informações de recência (quanto tempo tem que vimos o contato para a entidade), e da quantidade de entidades associadas à um contato. Um telefone muito recente, mas que esteja associado com 50 outras pessoas, por exemplo, talvez não seja o telefone ideal para você contatar alguém.
Finalmente, os status de validação são bastante úteis para identificar contatos bons ou ruins. Um e-mail, mesmo que fortemente associado com uma entidade pelas passagens, que está marcado como inválido, com certeza não é um bom contato. Temos diferentes atributos de validação para os e-mails, telefones e endereços, e vale a pena olhar cada um dos datasets para entender quais são.
Vale ressaltar que você deve pensar no que é o melhor contato para o seu processo específico. Para alguns processos, o melhor contato pode ser o que existe a mais tempo, para outros, o mais novo, e assim por diante.

Language
Credentials
Click Try It! to start a request and see the response here!