Secciones de Documentación de la API
Resumen de la API
Introducción a la API Check This Phone
Resumen
La API Check This Phone es una herramienta poderosa diseñada para validar, formatear y estandarizar números telefónicos de todo el mundo. Ayuda a los desarrolladores a asegurar que los números telefónicos se almacenen correctamente, de manera limpia y consistente en sus bases de datos, previniendo errores causados por entradas incorrectas o mal formateadas.
Con soporte para 232+ países, la API utiliza un motor avanzado de procesamiento de números telefónicos para analizar con precisión números telefónicos, detectar su validez y devolverlos en un formato estructurado.
Características Clave
✔ Validación de Números Telefónicos - Verifica si un número es válido y correctamente formateado.
✔ Formateo Automático - Convierte números telefónicos a formatos E.164, nacional, internacional, y RFC3966.
✔ Detección de País - Identifica el país asociado a un número telefónico.
✔ Búsqueda de Operadora - Recupera información de la operadora cuando esté disponible.
✔ Manejo de Errores - Obtén mensajes de error precisos para números inválidos o mal formateados.
✔ Verificación Masiva - Procesa múltiples números telefónicos a la vez usando solicitudes por lotes.
✔ API RESTful - Fácil de usar y compatible con cualquier lenguaje de programación.
Cómo Funciona
1️⃣ Envía una solicitud con un número telefónico y código de país opcional.
2️⃣ Nuestro sistema analiza, verifica y formatea el número con precisión.
3️⃣ Recibe una respuesta estructurada con estado de validación, versiones formateadas y metadatos adicionales.
Casos de Uso
🔹 CRM & Bases de Datos de Clientes - Asegura que solo se almacenen números válidos.
🔹 E-commerce & Formularios Online - Previene que usuarios ingresen números incorrectos.
🔹 Marketing & Servicios de Mensajería - Valida números antes de enviar SMS o llamadas.
🔹 Procesamiento Masivo de Datos - Limpia y estandariza grandes conjuntos de números telefónicos.
Próximos Pasos
📌 Comienza Rápidamente - Consulta la Guía de Inicio Rápido.
📌 Aprende a Autenticarte - Ver Autenticación & Claves API.
📌 Explora los Endpoints de la API - Visualiza los Endpoints Principales de la API.
Para asistencia adicional, revisa la sección de Soporte & Contacto. 🚀
Autenticación
Autenticación & Claves API
Para acceder a la API Check This Phone, se requiere autenticación mediante un token API. Este token asegura comunicación segura e identifica tus solicitudes.
Obtención de un Token API
1. Regístrate Gratis - Crea una cuenta en nuestra plataforma.
2. Accede al Tablero - Inicia sesión y navega a la sección Token API.
3. Genera un Nuevo Token - Haz clic en el botón "Generar Token" para crear tu clave API única.
Usando el Token API
Hay dos formas de autenticar tus solicitudes usando el token API:
1. Para solicitudes POST - Incluye el token en el encabezado Authorization usando el esquema Bearer:
1
2 curl -X POST https://api.check-this-phone.com/phone/verify
3 -H "Authorization: Bearer YOUR_API_TOKEN"
4 -d "number=+123456789"
5
2. Para solicitudes GET - Añade el token como parámetro de consulta:
1
2 curl -X GET "https://api.check-this-phone.com/phone/verify?number=+123456789&api_key=YOUR_API_TOKEN"
3
Mantén tu token API seguro y no lo compartas. Si se ve comprometido, puedes revocarlo y generar uno nuevo desde tu tablero.
Guía de Inicio Rápido 🚀
¡Bienvenido a la API Check This Phone! Sigue estos pasos para comenzar rápidamente y verificar números telefónicos con facilidad.
1. Suscríbete Gratis 🎉
- Regístrate y obtén una clave API instantáneamente.
- Disfruta de 100 solicitudes gratis para probar el servicio.
2. Haz tu Primera Solicitud 🔍
Usa tu clave API para verificar un número telefónico.
1
2 curl -X GET "https://api.check-this-phone.com/phone/verify?api_key=YOUR_API_KEY&number=+33612345678"
3
Ejemplo de Respuesta
1
2 {
3 "is_valid": true,
4 "international_format": "+33 6 12 34 56 78",
5 "national_format": "06 12 34 56 78",
6 "E164_format": "+33612345678",
7 "RFC3966_format": "tel:+33-6-12-34-56-78",
8 "country_code": 33,
9 "region_code": "FR",
10 "type": "Mobile",
11 "carrier": "SFR",
12 "time_zones": [
13 "Europe/Paris"
14 ]
15 }
16
3. Actualiza para Más Solicitudes 🚀
¿Necesitas más de 100 solicitudes? Actualiza a un plan de pago para límites más altos y acceso prioritario.
4. Integra Fácilmente 🛠
- Usa nuestra referencia detallada de API para integración.
- Compatible con PHP, JavaScript, Python y más.
- Soporte para verificación por lotes via CSV.
5. ¡Empieza a Construir Ahora! 🚀
¡Estás listo! Comienza a verificar números telefónicos y mejora tus aplicaciones con datos telefónicos precisos.
💡 ¿Necesitas ayuda? Contacta a nuestro equipo de soporte en cualquier momento haciendo clic aquí.
Países Soportados
Países Soportados
Resumen
Nuestra API proporciona un endpoint para obtener una lista de países soportados. Adicionalmente, un campo de búsqueda permite a los usuarios verificar si un país específico está incluido.
Cobertura
- Soporta 243 países , asegurando disponibilidad global.
- Cubre más de 240 regiones , incluyendo varios códigos de marcación.
- Actualizado regularmente para mantener precisión.
¿Cómo Acceder a la Lista?
Endpoint API: Recupera la lista completa de países soportados.
1
2 curl -X GET "https://api.check-this-phone.com/phone/countries?api_key=YOUR_API_KEY" -H "Accept: application/json"
3
Campo de Selección: Verifica fácilmente un país usando el campo de selección abajo.
public.pages.documentation.core_endpoints.h2
Endpoints Principales de la API
1. Verificar un Número Telefónico (GET)
1GET /phone/verify
Permite a los usuarios validar y formatear un número telefónico usando parámetros de consulta.
2. Verificar un Número Telefónico (POST)
1POST /phone/verify
Acepta un payload JSON para validar y formatear un número telefónico.
3. Extraer Números Telefónicos de Texto
1POST /phone/extract-from-text
Extrae números telefónicos de un texto dado.
4. Obtener Países Soportados
1GET /phone/countries
Devuelve una lista de países soportados para validación telefónica.
Validación de Teléfono
Validando un número telefónico
Esta sección proporciona información sobre los endpoints de la API relacionados con la validación de números telefónicos. La API soporta verificación de números individuales, extracción de números telefónicos de texto y recuperación de la lista de países soportados para validación de números telefónicos.
1. Validación de Teléfono
a. Validando un Teléfono Individual (GET)
Descripción: Este endpoint permite validar un solo número telefónico usando una solicitud GET.
Para pasar el locale solo si el código de país del teléfono no está presente, puedes verificar si el número telefónico tiene un código de país (es decir, incluye el código de marcación internacional). Si falta el código de país, entonces puedes añadir el locale a los parámetros de consulta.
El parámetro locale puede usarse en cualquier situación, pero aumenta significativamente la precisión al verificar.
El parámetro locale sigue el estándar ISO 3166-1 alpha-2 para códigos de país para identificación de región.
Solicitud:
Método: GET
1https://api.check-this-phone.com/phone/verify?number=PHONE_NUMBER&locale=LOCALE
1
2 curl --location 'https://api.check-this-phone.com/phone/verify?api_key=__API_KEY__&number=+33987654321&locale=fr'
3
Parámetros de Consulta:
api_key: Tu clave API.
number: El número telefónico que deseas validar (ej: +34 91 876 54 32)..
locale: El locale para la validación del número telefónico (ej: es para España).
Respuesta:
1
2 {
3 "status": "success",
4 "phone": {
5 "is_valid": true,
6 "international_format": "+33 9 87 65 43 21",
7 "national_format": "09 87 65 43 21",
8 "E164_format": "+33987654321",
9 "RFC3966_format": "tel:+33-9-87-65-43-21",
10 "country_code": 33,
11 "region_code": "FR",
12 "type": "VoIP",
13 "carrier": "Unknown",
14 "time_zones": [
15 "Europe/Paris"
16 ]
17 }
18 }
19
Este endpoint devolverá el resultado de validación para el número telefónico proporcionado. La estructura de respuesta variará dependiendo del resultado de validación.
b. Validando un Teléfono Individual (POST)
Descripción: Este endpoint valida un solo número telefónico usando una solicitud POST. Puedes incluir el número telefónico y locale en el cuerpo de la solicitud.
Solicitud:
Método: POST
URL:
1https://api.check-this-phone.com/phone/verify
Autorización: Autenticación por token Bearer usando la clave API.
Cuerpo de Solicitud:
1
2 {
3 "locale": "fr",
4 "number": "+33 9 87 65 43 21"
5 }
6
Ejemplos de solicitud:
1
2 curl --location 'https://api.check-this-phone.com/phone/verify'
3 --header 'Content-Type: application/json'
4 --header 'Authorization: Bearer __YOUR_API_KEY__'
5 --data '{
6 "locale" : "fr",
7 "number" : "+33 9 87 65 43 21"
8 }'
9
Respuesta:
La respuesta contendrá el resultado de validación para el número telefónico proporcionado en el cuerpo de solicitud.
1
2 {
3 "status": "success",
4 "phone": {
5 "is_valid": true,
6 "international_format": "+33 9 87 65 43 21",
7 "national_format": "09 87 65 43 21",
8 "E164_format": "+33987654321",
9 "RFC3966_format": "tel:+33-9-87-65-43-21",
10 "country_code": 33,
11 "region_code": "FR",
12 "type": "VoIP",
13 "carrier": "Unknown",
14 "time_zones": [
15 "Europe/Paris"
16 ]
17 }
18 }
19
c. Extrayendo Teléfonos de Texto (POST)
Descripción: : Este endpoint permite extraer números telefónicos de un contenido de texto dado. Usa una solicitud POST con el texto en el cuerpo, y devolverá cualquier número telefónico detectado.
Solicitud:
Método: POST
1https://api.check-this-phone.com/phone/extract-from-text
Autorización: Autenticación por token Bearer usando la clave API.
Cuerpo de Solicitud:
1
2 {
3 "locale": "fr",
4 "content": "If you're planning to contact us, here are some important numbers:
5 n- Our customer service number: +33 1 23 45 67 89
6 n- Technical support: +33 6 12 34 56 78
7 n- For emergencies: +33 9 87 65 43 21
8 nFeel free to reach out during business hours!"
9 }
10
Ejemplos de solicitud:
1
2 curl --location 'https://api.check-this-phone.com/phone/extract-from-text'
3 --header 'Content-Type: application/json'
4 --header 'Authorization: Bearer __YOUR_API_KEY__'
5 --data '{
6 "locale": "fr",
7 "content": "If you re planning to contact us, here are some important numbers:
8 Our customer service number: +33 1 23 45 67 89
9 Technical support: +33 6 12 34 56 78
10 For emergencies: +33 9 87 65 43 21
11 Feel free to reach out during business hours!"
12 }
13'
14
Respuesta:
1
2 {
3 "status": "success",
4 "phone": [
5 {
6 "phone_number": "+33123456789",
7 "locale": "FR",
8 "is_valid": "Valid",
9 "E164_format": "+33123456789",
10 "RFC3966_format": "tel:+33-1-23-45-67-89",
11 "carrier": "Unknown",
12 "country_code": 33,
13 "international_format": "+33 1 23 45 67 89",
14 "national_format": "01 23 45 67 89",
15 "region_code": "FR",
16 "time_zones": "Europe/Paris",
17 "type": "Fixed Line"
18 },
19 {
20 "phone_number": "+33612345678",
21 "locale": "FR",
22 "is_valid": "Valid",
23 "E164_format": "+33612345678",
24 "RFC3966_format": "tel:+33-6-12-34-56-78",
25 "carrier": "SFR",
26 "country_code": 33,
27 "international_format": "+33 6 12 34 56 78",
28 "national_format": "06 12 34 56 78",
29 "region_code": "FR",
30 "time_zones": "Europe/Paris",
31 "type": "Mobile"
32 },
33 {
34 "phone_number": "+33987654321",
35 "locale": "FR",
36 "is_valid": "Valid",
37 "E164_format": "+33987654321",
38 "RFC3966_format": "tel:+33-9-87-65-43-21",
39 "carrier": "Unknown",
40 "country_code": 33,
41 "international_format": "+33 9 87 65 43 21",
42 "national_format": "09 87 65 43 21",
43 "region_code": "FR",
44 "time_zones": "Europe/Paris",
45 "type": "VoIP"
46 }
47 ]
48 }
49
La respuesta contendrá un array de números telefónicos detectados en el texto proporcionado.
2. Países Soportados
a. Recuperando Países Soportados (GET)
Descripción: Este endpoint recupera una lista de países soportados para validación de números telefónicos. Devuelve detalles sobre los países, incluyendo nombre, código de país y código telefónico.
Solicitud:
Método: GET
1https://api.check-this-phone.com/phone/countries?api_key=__YOUR_API_KEY__
Parámetros de Consulta:
api_key: Tu clave API.
Respuesta:
La respuesta incluirá una lista de países con sus detalles. Abajo hay un ejemplo de la estructura de respuesta:
1
2 {
3 "total": 243,
4 "countries": [
5 {
6 "id": 2,
7 "name": "Grenada",
8 "alpha2": "GD",
9 "phone_code": "+1473"
10 },
11 {
12 "id": 3,
13 "name": "France",
14 "alpha2": "FR",
15 "phone_code": "+33"
16 }
17 ]
18 }
19
Objeto de Respuesta
Esta sección provee información detallada sobre los campos en la respuesta de validación de números telefónicos.
Cuando validas un número telefónico, el sistema devuelve un conjunto completo de datos que te ayuda a entender varios aspectos de la validez, formato e información relacionada con el número.
Abajo, encontrarás una tabla que describe cada campo en la respuesta, ayudándote a interpretar la información correctamente.
Campo | Descripción |
---|---|
is_valid | Booleano: Indica si el número telefónico es válido según las reglas de formato y verificaciones de tipo de número. |
international_format | String: El número telefónico formateado en formato internacional (ej: +34 91 876 54 32). Incluye el código de país y el número nacional. |
national_format | String: El número telefónico formateado en formato nacional (ej: 91 876 54 32 para España), específico del país sin el código internacional. |
E164_format | String: El número telefónico en formato E.164 (ej: +34918765432), que incluye el código de país sin espacios, guiones o paréntesis. |
RFC3966_format | String: El número telefónico formateado según RFC3966 (ej: tel:+34-91-876-54-32). Este formato se usa comúnmente en aplicaciones web y basadas en URI. |
country_code | Entero: El código de marcación del país para el número telefónico (ej: 34 para España), usado para marcar al país desde el extranjero. |
region_code | String: El código de región (código de país ISO 3166-1 alpha-2) para el país del número telefónico (ej: ES para España). |
type | String: El tipo de número telefónico (ej: 'Móvil', 'Línea Fija', '0800', etc.), basado en la clasificación del número. |
carrier | String: El nombre de la operadora o proveedor de servicios para el número telefónico (ej: 'Movistar') o 'Desconocido' si no se detecta operadora. |
time_zones | Array: Una lista de zonas horarias (ej: ['Europe/Madrid']) asociadas con la región o país del número telefónico. |
Límites de Tasa
Límites de Tasa & Solicitudes Adicionales
Nuestra API aplica límites de tasa basados en el plan al que te suscribes. Cada plan viene con un número predefinido de solicitudes, y una vez alcanzado este límite, solicitudes adicionales no serán procesadas a menos que se compre un paquete extra.
Compra de Solicitudes Adicionales
Los clientes pueden comprar paquetes de solicitudes adicionales directamente mediante el tablero. Estos paquetes extra están disponibles en tres niveles:
1000 solicitudes extra
5000 solicitudes extra
10000 solicitudes extra
Detalles de precios para estos paquetes solo están disponibles dentro del tablero.
Notificaciones de Uso
Para ayudar a los clientes a gestionar sus límites de solicitudes efectivamente, enviamos una notificación por email cuando se ha usado el 70% de la cuota total de solicitudes.
Esto asegura que tengas tiempo suficiente para tomar acciones necesarias antes de alcanzar tu límite.
Período de Gracia para Planes Premium
Para todos los planes pagos, excepto el Plan Básico, proveemos una tolerancia de 100 solicitudes adicionales después de alcanzar el límite. Esto previene una interrupción inmediata del servicio y permite una transición suave mientras se gestionan solicitudes adicionales.
Soporte al Cliente & Soluciones Personalizadas
Nuestro equipo está comprometido a proveer servicio ininterrumpido y está abierto a discutir soluciones alternativas si es necesario. Si requieres un ajuste personalizado en tu límite de solicitudes, no dudes en contactarnos vía la sección de soporte en tu tablero.
Manejo de Errores
Códigos de Error y Descripciones
Esta sección describe los posibles códigos de error devueltos por la API, junto con sus significados y soluciones potenciales.
Error Code | Description | Explanation & Resolution |
---|---|---|
1001 | API key is missing. | La solicitud debe incluir una clave API en los parámetros. Asegúrate que el campo `api_key` está provisto. |
1002 | Invalid credentials (API key not found). | La clave API proporcionada no coincide con ninguna credencial válida. Verifica que estás usando la clave API correcta. |
1003 | Request limit exceeded. | El usuario ha alcanzado el número máximo de solicitudes API permitidas. Considera actualizar el plan o verificar la cuota de solicitudes. |
1004 | Error fetching request statistics. | Hubo un problema recuperando estadísticas de uso para la cuenta. Intenta nuevamente más tarde o contacta soporte si el problema persiste. |
1005 | Invalid token. | El token proporcionado no es válido o ha sido revocado. Asegúrate que el token está generado correctamente y activo. |
1006 | Phone number is missing or invalid. | La solicitud no contiene un número telefónico válido. Asegúrate que el campo `number` está incluido y formateado correctamente. |
1007 | Invalid JSON format. | El cuerpo de la solicitud contiene JSON mal formateado. Asegúrate que la estructura JSON es válida y correctamente codificada. |
1008 | Text content is missing. | La solicitud debe incluir un campo "text", pero estaba faltando o vacío. Asegúrate que el parámetro text está correctamente provisto. |
Soporte
Soporte & Asistencia
Estamos comprometidos a proveer soporte confiable para todos nuestros clientes para asegurar una experiencia fluida con nuestra API.
Cómo Obtener Soporte
Soporte está disponible a través de los siguientes canales:
Tablero: Todos los clientes pueden acceder a la sección de soporte en el tablero para enviar solicitudes.
Email: Puedes contactar a nuestro equipo de soporte en contact@check-this-phone.com.
Elegibilidad para Soporte
Todos los planes pagos tienen soporte completo.
El plan gratuito no incluye soporte. plan gratuito no incluye soporte.
Si requieres asistencia, por favor activa una solicitud de soporte vía el tablero en la sección de Soporte.
¡Nuestro equipo estará feliz de ayudarte!
Integración con Zapier
📌 Integrando la API de Verificación Telefónica con Zapier
Resumen
Zapier te permite automatizar flujos de trabajo integrando diferentes aplicaciones. Puedes usar Webhooks de Zapier para conectar la API de Verificación Telefónica con otras apps como Google Sheets, Slack o Email.
🔗 Pasos para Integrar
1. Crea un Zap
- Inicia sesión en Zapier.
- Haz clic en "Crear Zap". Crear Zap.
- Selecciona "Webhook por Zapier" como Disparador.
2. Elige Evento Disparador
- Selecciona Encuesta de Recuperación (para verificaciones programadas) o "Webhook Personalizado " (para solicitudes en tiempo real).
3. Configura URL del Webhook
- Elige GET como método de solicitud.
- Usa la siguiente URL de Webhook (reemplaza ( con tu clave API real __API_KEY__ con tu clave API real):
- Selecciona " Webhook por Zapier" como Disparador.URL
1https://api.check-this-phone.com/phone/verify?api_key=__API_KEY__&number=+33987654321&locale=fr
- Si es necesario, haz el número y locale dinámicos usando pasos previos del Zap.
4. Prueba el Webhook
- Haz clic en "Probar Disparador" para verificar que la solicitud API devuelve la respuesta correcta.
5. Usa la Respuesta de la API en Otra Acción
Elige un paso de acción, como:
- Guardar resultados en Google Sheets
- Enviar una notificación en Slack
- Disparar una alerta por email
6. ¡Activa tu Zap! 🚀
- Haz clic en "Publicar" y comienza a automatizar.
📌 Ejemplo: Usando un Paso de Código en Zapier (JavaScript)
Si necesitas más flexibilidad, puedes usar la acción "public.pages.documentation.zapier_integration.content.27.1" public.pages.documentation.zapier_integration.content.27.2
1
2 fetch("https://api.check-this-phone.com/phone/verify?api_key=__API_KEY__&number=+33987654321&locale=fr")
3 .then(response => response.json())
4 .then(data => console.log(data));
5
Este script obtiene datos de validación telefónica y puede usarse en automatizaciones personalizadas de Zapier.