Detalhes técnicos

A Number Insight API oferece uma única API para acessar uma ampla gama de atributos relacionados à operadora, ao assinante ou ao dispositivo associado a um número de telefone. Os desenvolvedores podem utilizar um único endpoint para recuperar diversos atributos que, normalmente, exigiriam vários fornecedores, CSPs e métodos de integração.

Os atributos são agrupados em Insights, cada um correspondendo a um conjunto específico de recursos. A disponibilidade pode variar de acordo com a região. O desenvolvedor simplesmente especifica qual(is) Insight(s) deseja recuperar em uma única solicitação.

Embora alguns Insights estejam disponíveis sem registro prévio, outros exigem aprovação das operadoras de celular. A tabela abaixo mostra quais Insights exigem aprovação. O acesso a esses Insights é gerenciado por meio do “Registro de Rede”. Para saber como solicitar acesso, siga este guia.

Perspectiva Descrição É necessária aprovação? Cobertura Status
Formato Validação do formato de um número de telefone e obtenção de informações a partir dele. Não Em todo o mundo Disponibilidade geral
Transportadora original As informações sobre a rede foram atribuídas inicialmente. Informações baseadas no prefixo do plano de numeração. Não Em todo o mundo Disponibilidade geral
Operadora atual Informações sobre a rede à qual o número está atribuído no momento. Não Em todo o mundo Disponibilidade geral
Troca de chip Informações sobre qualquer alteração recente no emparelhamento do chip (SIM) relacionada a uma conta de celular. Inscreva-se por meio de Registro de Rede Veja Recursos de rede Disponibilidade geral
Verificação de localização Verify se a localização de um usuário final está dentro de uma área especificada. Inscreva-se por meio de Registro de Rede Veja Recursos de rede Prévia para desenvolvedores
Correspondência de assinantes Comparar os dados do usuário final correspondentes a um número de telefone com os dados registrados na operadora de rede. Inscreva-se por meio de Registro de Rede Veja Recursos de rede Beta
Roaming Obter informações sobre o status de roaming de um dispositivo, incluindo se o dispositivo está em roaming e, em caso afirmativo, em qual país. Inscreva-se por meio de Registro de Rede Veja Recursos de rede Prévia para desenvolvedores
Acessibilidade Obter informações sobre o status de conectividade de um aparelho, incluindo a disponibilidade de dados e SMS. Inscreva-se por meio de Registro de Rede Veja Recursos de rede Prévia para desenvolvedores
Troca de dispositivo Informações sobre qualquer mudança recente de aparelho para um chip emparelhado a um celular. Inscreva-se por meio de Registro de Rede Veja Recursos de rede Prévia para desenvolvedores
Reciclagem de números Verifique se houve alguma alteração no usuário associado ao número de telefone após a data especificada. Inscreva-se por meio de Registro de Rede Veja Recursos de rede Prévia para desenvolvedores
Tempo de assinatura Verifique se o prazo de validade de um determinado número de telefone é maior do que uma data informada pelo cliente. Inscreva-se por meio de Registro de Rede Veja Recursos de rede Prévia para desenvolvedores
Verificação de idade Confirma a idade do assinante associado ao número de telefone consultado, com base em um limite de idade determinado. Inscreva-se por meio de Registro de Rede Veja Recursos de rede Prévia para desenvolvedores

Testes

Use o Registro de Rede, um ambiente de teste seguro e controlado, no qual as chamadas à API retornam dados reais apenas para um pequeno grupo de números de teste autorizados, para que você comece a usar a API do Identity Insights imediatamente. Ao contrário do ambiente de produção, isso não requer aprovação das operadoras.

Você também pode acessar o Operadora virtual, um operador simulado que gera respostas falsas, porém determinísticas, para números virtuais.

Referência da API

A especificação OpenAPI para a API do Identity Insights está disponível aqui.

Pontos finais regionais

Existem vários endpoints disponíveis para a API do Identity Insights que definem para onde a solicitação da API é enviada:

Ponto final Região
https://api-eu.vonage.com/identity-insights/v1/requests EU
https://api-us.vonage.com/identity-insights/v1/requests US

Introdução

Confira Introdução para um guia passo a passo sobre como começar a usar a API do Identity Insights.