Skip to main content
Este documento apresentará uma API de consulta de status de número de telefone, que pode ser usada para verificar o status de um número de telefone, permitindo que você insira o número para consulta.

​
Processo de Solicitação

Para usar a API de consulta de status de número de telefone, primeiro acesse o Painel de Controle da Ace Data Cloud para obter seu Token de API, que deve ser guardado para uso futuro. Se você ainda não estiver logado ou registrado, será redirecionado automaticamente para a página de login, onde será convidado a se registrar e logar. Após a conclusão, você será redirecionado de volta para a página atual. Um Token de API é suficiente para acessar todos os serviços da plataforma, não sendo necessário solicitar um para cada serviço individualmente. A primeira solicitação oferece um crédito gratuito, permitindo uma experiência sem custo; quando o crédito estiver baixo, você pode recarregar o saldo geral no painel de controle.
📘 Documentação Completa: API de Consulta de Status de Número de Telefone →

​
Uso Básico

Primeiro, entenda a forma básica de uso, que é inserir o número de telefone para obter o resultado processado. É necessário passar um campo mobile. Em seguida, você pode preencher o conteúdo correspondente na interface, como mostrado na imagem:

Podemos ver que aqui configuramos os Cabeçalhos da Solicitação, incluindo:
  • accept: o formato de resposta desejado, que deve ser preenchido como application/json, ou seja, formato JSON.
  • authorization: a chave para chamar a API, que pode ser selecionada diretamente após a solicitação.
Além disso, configuramos o Corpo da Solicitação, incluindo:
  • mobile: o número de telefone a ser processado, é um parâmetro obrigatório.
  • encryption: opcional, parâmetro de criptografia para campos sensíveis (caso precise enviar dados criptografados).
Após a seleção, você pode notar que o código correspondente também foi gerado à direita, como mostrado na imagem:

Clique no botão “Try” para realizar o teste, como mostrado na imagem acima, e você receberá o seguinte resultado:
O resultado retornado contém vários campos, descritos a seguir:
  • result, código de resultado da autenticação, com as seguintes condições de cobrança.
    • Códigos de resultado com cobrança:
      • 0: Sucesso
    • Códigos de resultado sem cobrança:
      • -1: Nenhum resultado encontrado
      • -2: Formato de número de telefone incorreto
      • -3: Serviço do centro de validação ocupado
  • description, descrição do resultado do negócio.
  • status_code, código de status:
    • 0: Normal
    • 1: Desligado
    • 2: Número cancelado
    • 3: Número inexistente
    • 4: Fora da rede
    • 99: Status desconhecido
Pode-se ver que o status deste número de telefone já foi consultado. Além disso, se você quiser gerar o código de integração correspondente, pode copiá-lo diretamente, como o código CURL abaixo:
O código de integração em Python é o seguinte:

​
Tratamento de Erros

Ao chamar a API, se ocorrer um erro, a API retornará o código de erro e a mensagem correspondentes. Por exemplo:
  • 400 token_mismatched: Solicitação inválida, possivelmente devido a parâmetros ausentes ou inválidos.
  • 400 api_not_implemented: Solicitação inválida, possivelmente devido a parâmetros ausentes ou inválidos.
  • 401 invalid_token: Não autorizado, token de autorização inválido ou ausente.
  • 429 too_many_requests: Muitas solicitações, você excedeu o limite de taxa.
  • 500 api_error: Erro interno do servidor, algo deu errado no servidor.

​
Exemplo de Resposta de Erro

​
Conclusão

Através deste documento, você já entendeu como usar a API de consulta de status de número de telefone para verificar o status de um número de telefone, podendo inserir o número para consulta. Esperamos que este documento ajude você a integrar e usar melhor essa API. Se tiver alguma dúvida, entre em contato com nossa equipe de suporte técnico.