Saltar para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt

Use this file to discover all available pages before exploring further.

Este documento irá apresentar uma API de consulta de status de número de telefone, que pode ser utilizada 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, você precisa primeiro acessar a página correspondente da API de Consulta de Status de Número de Telefone e solicitar o serviço correspondente. Após acessar a página, clique no botão “Adquirir”, conforme mostrado na imagem: Se você ainda não estiver logado ou registrado, será redirecionado automaticamente para a página de login, convidando-o a se registrar e fazer login. Após o registro e login, você será redirecionado de volta para a página atual. Na primeira solicitação, haverá um limite gratuito disponível, permitindo que você use a API gratuitamente.

​
Uso Básico

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

Podemos ver que aqui configuramos os Headers da Requisição, incluindo:
  • accept: o formato de resposta desejado, aqui 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 Requisição, incluindo:
  • mobile: o número de telefone a ser processado, é um parâmetro obrigatório.
  • encryption: opcional, parâmetro de criptografia de 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, conforme mostrado na imagem:

Clique no botão “Tentar” para realizar o teste, como mostrado na imagem acima, e aqui obtivemos o seguinte resultado: 
{
  "result": "0",
  "description": "Sucesso",
  "status_code": 0
}
O resultado retornado possui vários campos, descritos a seguir:
  • result, código de resultado da autenticação, a situação de cobrança é a seguinte.
    • Códigos de resultado cobrados:
      • 0: Sucesso
    • Códigos de resultado não cobrados:
      • -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, por exemplo, o código CURL é o seguinte: 
curl -X POST 'https://api.xhuoapi.ai/v1/identity/phone/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "mobile": "***"
}'
O código de integração em Python é o seguinte: 
import requests

url = "https://api.xhuoapi.ai/v1/identity/phone/check-1e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "mobile": "***"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​
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

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "falha na busca"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
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 possa ajudá-lo a integrar e usar melhor a API. Se tiver alguma dúvida, entre em contato com nossa equipe de suporte técnico.