Consulta Telefone

Informações e detalhes para consulta de telefones

Este serviço é destinado para encontrar o documento de uma pessoa física ou jurídica vinculado ao telefone utilizado na consulta.

Requisição

GET https://api-v3.smsfire.com.br/bigdata/phone/:input

Rate Limiter: Este serviço possui um limite global de 30 requisições por minuto a partir do mesmo IP.

Parâmetros de requisição

Parâmetro	Tipo	Descrição	Exemplo
input*	string	Telefone em formato internacional E.164	5511944556677

Exemplos de requisição

Node.JS

var axios = require("axios").default;

const input = "5511944556677";

var options = {
  method: 'GET',
  url: `https://api-v3.smsfire.com.br/bigdata/phone/${input}`,
  headers: {Username: 'seu_usuario', Api_Token: 'seu_token'}
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

Php

<?php

$endpoint = "https://api-v3.smsfire.com.br/bigdata/phone/";
$endpoint .= "5511944556677";

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $endpoint,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Api_Token: seu_token",
        "Username: seu_usuario",
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}

C-Sharp

using System.Net.Http;
using Microsoft.AspNetCore.WebUtilities; // precisa do pacote Microsoft.AspNetCore.WebUtilities

var client = new HttpClient();

var input = "phone";
var endpoint = $"https://api-v3.smsfire.com.br/bigdata/phone/{input}";

var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri(endpoint),
    Headers =
    {
        { "Api_Token", "seu_token" },
        { "Username", "seu_usuario" }
    }
};

using var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Shell/cURL

curl --request GET \
  --url 'https://api-v3.smsfire.com.br/bigdata/phone/5511944556677' \
  --header 'Api_Token: seu_token' \
  --header 'Username: seu_usuario'

Somente consultas com dados disponíveis serão tarifadas.

Response

O conjunto de dados retornados será em formato JSON com detalhes da pesquisa ou possível falha da requisição

200 - OK

{
	"id": "0199b9bf-a19e-7705-a08e-de7e221f9650",
	"ip": "127.0.0.1",
	"input": "5511944556677",
	"relations": [
		{
			"name": "empresa de sucesso ltda",
			"doc": "19100200000109"
		}
	]
}

404 - Not found

Esse código de erro será lançado quando a consulta não possuir dados disponíveis em nossas bases de dados.

{
	"id": "0199b9bf-a19e-7705-a08e-de7e221f9650",
	"ip": "127.0.0.1",
	"status": "NOT_FOUND"
}

4xx - Erro

Erros poderão ser facilmente filtrados a partir dos códigos HTTP retornados e adicionalmente detalhes do erro serão incluídos no JSON que seguirá o seguinte formato:

{
	"message": "Not Available Balance",
	"error": "Forbidden",
	"statusCode": 403
}

5xx - Erro

Requisições que tenham o retorno de algum código HTTP deste nível é devido a falhas internas da API ou servidor.

Neste tipo de situação, entre em contato com a equipe de suporte

Tabela de parâmetros

Parâmetro	Tipo	Descrição
id	string Padrão UUID	Identificador único da pesquisa
ip	string	Ip de onde se originou o request a API
input	string	Input utilizado na pesquisa
relations	array	Matriz com relação de documentos relacionados ao input
relations[].name	string	Nome completo ou Razão Social
relations[].doc	string	CNPJ ou CPF da pessoa relacionada