Lookup
Com este endpoint, você pode formatar e verificar números de telefone. Verifique a validade de um número, a qual rede móvel ele pertence, formate um número nos formatos nacional e internacional ou verifique se um número existe e está registrado na rede móvel.
Parâmetros
Todas as consultas mencionadas abaixo requerem apenas o número de telefone como parâmetro:
- Name
number- Type
- string
- Description
O número a ser consultado. Vários números devem ser separados por vírgula. O formato é quase irrestrito – nossa API formata o número automaticamente de forma correta.
Formato
Consulte o formato nacional e internacional de qualquer número de celular. Além disso, você receberá informações sobre a operadora associada ao número (sem informações de portabilidade).
Requisição
curl "https://gateway.seven.io/api/lookup/format?number=4917612345678" \
-H "X-Api-Key: SUA_CHAVE_API" \
-H "Accept: application/json"
Resposta
{
"success": true,
"national": "0176 12345678",
"international": "+4917612345678",
"international_formatted": "+49 176 12345678",
"country_name": "Germany",
"country_code": "49",
"country_iso": "DE",
"carrier": "O2",
"network_type": "mobile"
}
Capacidades RCS
Com este endpoint, você pode consultar a capacidade RCS de um número de telefone. Antes de enviar um RCS, você deve sempre consultar as capacidades de um número e, se necessário, armazenar o resultado em cache.
Parâmetros Opcionais
- Name
from- Type
- string
- Description
Para verificar as capacidades RCS de um número de telefone, é sempre necessário o respectivo identificador do agente. Por padrão, nossa API usa o primeiro identificador de remetente RCS em sua conta. Com este parâmetro, você pode usar um agente diferente.
Requisição
curl "https://gateway.seven.io/api/lookup/rcs?number=4917612345678" \
-H "X-Api-Key: SUA_CHAVE_API" \
-H "Accept: application/json"
Resposta
{
"success": true,
"national": "0176 12345679",
"international": "+49176123456789",
"international_formatted": "+49 179 123456789",
"country_name": "Germany",
"country_code": "49",
"country_iso": "DE",
"carrier": "O2",
"network_type": "mobile",
"rcs_capabilities": [
"RICHCARD_STANDALONE",
"ACTION_CREATE_CALENDAR_EVENT",
"ACTION_DIAL",
"ACTION_OPEN_URL",
"ACTION_SHARE_LOCATION",
"ACTION_VIEW_LOCATION",
"RICHCARD_CAROUSEL"
]
}
Übersicht aller Fähigkeiten
| Feature | Descrição |
|---|---|
FEATURE_UNSPECIFIED | Não especificado. |
REVOCATION | Se este recurso for suportado, você pode revogar uma mensagem enviada antes que ela seja entregue. |
RICHCARD_STANDALONE | Rich Cards independentes |
RICHCARD_CAROUSEL | Carrossel de Rich Cards |
ACTION_CREATE_CALENDAR_EVENT | Ação sugerida para criar um evento de calendário. |
ACTION_DIAL | Ação sugerida para discar um número. |
ACTION_OPEN_URL | Ação sugerida para abrir uma URL. |
ACTION_SHARE_LOCATION | Ação sugerida para compartilhar a localização. |
ACTION_VIEW_LOCATION | Ação sugerida para visualizar uma localização em um aplicativo de mapas. |
HLR
Obtenha informações detalhadas sobre um número de celular através de uma consulta no banco de dados HLR. A consulta é possível para números de quase todos os países/redes em todo o mundo.
Pode acontecer que a consulta de roaming resulte em "Sem Roaming", mesmo que o número esteja em roaming. Isso geralmente significa que o Home Routing foi ativado pela operadora. O Home Routing faz com que a rede reporte o número como estando em casa, independentemente de onde ele realmente esteja.
Requisição
curl "https://gateway.seven.io/api/lookup/hlr?number=4917612345678" \
-H "X-Api-Key: SUA_CHAVE_API" \
-H "Accept: application/json"
Resposta
{
"status": true,
"status_message": "success",
"lookup_outcome": true,
"lookup_outcome_message": "success",
"international_format_number": "4917612345678",
"international_formatted": "+49 176 12345678",
"national_format_number": "0176 12345678",
"country_code": "DE",
"country_name": "Germany",
"country_prefix": "49",
"current_carrier":
{
"network_code": "26207",
"name": "Telefonica Germany GmbH & Co. OHG",
"country": "DE",
"network_type": "mobile"
},
"original_carrier":
{
"network_code": "26207",
"name": "Telefonica Germany GmbH & Co. OHG",
"country": "DE",
"network_type": "mobile"
},
"valid_number": "valid",
"reachable": "unknown",
"ported": "assumed_not_ported",
"roaming": "not_roaming",
"gsm_code": null,
"gsm_message": null
}
MNP
Consulte a operadora de uma qualquer número internacional através da nossa API MNP (Mobile Number Ported).
Requisição
curl "https://gateway.seven.io/api/lookup/mnp?number=4917612345678" \
-H "X-Api-Key: SUA_CHAVE_API" \
-H "Accept: application/json"
Resposta
{
"success": true,
"code": 100,
"price": 0.005,
"mnp":
{
"country": "DE",
"number": "+4917612345678",
"national_format": "0176 12345678",
"international_formatted": "+49 176 12345678",
"network": "Telekom Deutschland GmbH",
"mccmnc": "26201",
"isPorted": true,
"network_type": "mobile"
}
}
CNAM
Com o CNAM Lookup, você pode consultar o nome do identificador de chamadas para qualquer número em todo o mundo. Por favor, note que nem todos os números têm uma entrada registrada. Como os dados são coletados de várias fontes, podem incluir localizações geográficas, nomes de empresas/nomes ou a operadora.
Requisição
curl "https://gateway.seven.io/api/lookup/cnam?number=4917612345678" \
-H "X-Api-Key: SUA_CHAVE_API" \
-H "Accept: application/json"
Resposta
{
"success": "true",
"code": "100",
"number": "4917612345678",
"name": "GERMANY"
}
Cobertura
O CNAM é originalmente um recurso de rede norte-americano. Para números dentro do NANP (código de país +1), as operadoras mantêm o nome do identificador de chamadas elas mesmas, portanto o name retornado costuma ser o titular real da linha - um nome de pessoa ou de empresa.
Fora do NANP não existe uma base de nomes equivalente no lado da rede. Os dados são coletados de várias fontes, por isso, em números internacionais, a resposta frequentemente contém uma designação geográfica (como no exemplo acima: GERMANY), um nome de empresa disponível publicamente ou a operadora. Uma consulta internacional quase sempre retorna um valor, mas esse valor não é necessariamente o nome do titular.
Não publicamos uma taxa de acerto fixa: ela depende fortemente da sua distribuição por país e do tipo de números
consultados (fixo, móvel, empresarial). Se a qualidade for decisiva para o seu caso de uso, consulte primeiro uma
amostra representativa da sua própria base de números e avalie os valores name retornados.
Comportamento sem entrada registrada
Se a fonte de dados não retornar nenhum resultado ou estiver indisponível, a entrada na resposta contém apenas o código de erro, sem success, number e name:
Resposta sem resultado
{
"code": "600"
}
Portanto, verifique sempre success em vez de contar com a presença do campo name.
| Código | Significado |
|---|---|
100 | Consulta bem-sucedida, name contém o nome do identificador de chamadas. |
202 | O número é inválido e não pôde ser consultado. Não é cobrado. |
500 | Saldo insuficiente. |
600 | A consulta não retornou resultado ou a fonte de dados estava indisponível. |
Cobrança e consultas em lote
Cada consulta de um número válido é cobrada, independentemente de um nome ser encontrado. Somente números
inválidos (código 202) são gratuitos.
Vários números em uma mesma requisição são consultados sequencialmente, e cada consulta individual tem um tempo limite de cinco segundos. Mantenha os lotes pequenos o suficiente para o seu próprio tempo limite HTTP e distribua grandes volumes em requisições paralelas em vez de uma lista longa. Números duplicados dentro de uma requisição são consultados - e cobrados - apenas uma vez.
Como os nomes do identificador de chamadas raramente mudam, recomendamos armazenar os resultados em cache do seu lado em vez de consultar o mesmo número repetidamente.