Saltar al contenido principal
Este documento presentará una integración de API para la consulta de estado de número de teléfono, que se puede utilizar para verificar el estado de un número de teléfono móvil, puede ingresar el número de teléfono para realizar la consulta.

Proceso de solicitud

Para utilizar la API, primero debe ir a la página correspondiente de Consulta de estado de número de teléfono API para solicitar el servicio correspondiente, una vez en la página, haga clic en el botón “Acquire”, como se muestra en la imagen: Si aún no ha iniciado sesión o registrado, será redirigido automáticamente a la página de inicio de sesión que lo invita a registrarse e iniciar sesión, después de iniciar sesión o registrarse, volverá automáticamente a la página actual. En la primera solicitud, se otorgará un límite gratuito, que le permitirá utilizar la API de forma gratuita.

Uso básico

Primero, comprenda la forma básica de uso, que consiste en ingresar el número de teléfono móvil para obtener el resultado procesado, primero necesita pasar un campo mobile. A continuación, podemos completar el contenido correspondiente en la interfaz, como se muestra en la imagen:

Aquí podemos ver que hemos configurado los Request Headers, que incluyen:
  • accept: el formato de respuesta que desea recibir, aquí se establece como application/json, es decir, formato JSON.
  • authorization: la clave para llamar a la API, que se puede seleccionar directamente después de la solicitud.
Además, se ha configurado el Request Body, que incluye:
  • mobile: el número de teléfono móvil que necesita ser procesado, es un parámetro obligatorio.
  • encryption: opcional, parámetro de cifrado de campos sensibles (si se necesita enviar encriptado).
Después de seleccionar, se puede observar que también se ha generado el código correspondiente a la derecha, como se muestra en la imagen:

Haga clic en el botón “Try” para realizar la prueba, como se muestra en la imagen anterior, aquí hemos obtenido el siguiente resultado:
{
  "result": "0",
  "description": "Éxito",
  "status_code": 0
}
El resultado devuelto tiene varios campos, que se describen a continuación:
  • result, código de resultado de autenticación, la situación de cobro es la siguiente.
    • Códigos de resultado de cobro:
      • 0: Éxito
    • Códigos de resultado sin cobro:
      • -1: No se encontró resultado
      • -2: Formato de número de teléfono incorrecto
      • -3: Servicio del centro de verificación ocupado
  • description, descripción del resultado del negocio.
  • status_code, código de estado:
    • 0: Normal
    • 1: Apagado
    • 2: Número cancelado
    • 3: Número vacío
    • 4: No en la red
    • 99: Estado desconocido
Se puede ver que el estado de este número de teléfono ya ha sido consultado. Además, si desea generar el código de integración correspondiente, puede copiarlo directamente, por ejemplo, el código CURL es el siguiente:
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": "***"
}'
El código de integración en Python es el siguiente:
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)

Manejo de errores

Al llamar a la API, si se encuentra con un error, la API devolverá el código de error y la información correspondiente. Por ejemplo:
  • 400 token_mismatched: Solicitud incorrecta, posiblemente debido a parámetros faltantes o inválidos.
  • 400 api_not_implemented: Solicitud incorrecta, posiblemente debido a parámetros faltantes o inválidos.
  • 401 invalid_token: No autorizado, token de autorización inválido o faltante.
  • 429 too_many_requests: Demasiadas solicitudes, ha superado el límite de tasa.
  • 500 api_error: Error interno del servidor, algo salió mal en el servidor.

Ejemplo de respuesta de error

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "la recuperación falló"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

Conclusión

A través de este documento, ha aprendido cómo utilizar la API de consulta de estado de número de teléfono para verificar el estado de un número de teléfono móvil, puede ingresar el número de teléfono para realizar la consulta. Esperamos que este documento le ayude a integrar y utilizar mejor esta API. Si tiene alguna pregunta, no dude en ponerse en contacto con nuestro equipo de soporte técnico.