API de Consulta de Status de Número de Telefone

​

Processo de Solicitação

​

Uso Básico

• 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.

• 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).

{
  "result": "0",
  "description": "Sucesso",
  "status_code": 0
}

• 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

curl -X POST 'https://api.acedata.cloud/identity/phone/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "mobile": "***"
}'

import requests

url = "https://api.acedata.cloud/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

• 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