Saltearse al contenido

Glosario

Los términos se definen tal como los usa la API. Cuando una palabra también tiene un significado cotidiano más laxo, se aplica el significado de la API.

TérminoSignificado
identificadorLa única cosa sobre la que trata una comprobación en tiempo real: un número de teléfono o una dirección de correo electrónico. Un envío masivo lleva una lista de ellos.
serieSi un identificador es phone o email. Los productos, los endpoints y las solicitudes son específicos de una serie, y una solicitud solo puede mezclar series en el sentido de que no debe mezclarlas en absoluto.
productoUn objetivo de detección — una plataforma, más el tipo de comprobación que se realiza contra ella. «WhatsApp Number Checker» y «WhatsApp Activity Details» son dos productos distintos, aunque ambos traten sobre WhatsApp.
producto en tiempo realUn producto que se usa a través de los endpoints síncronos. Se direcciona por su ID numérico.
producto masivoUn producto que se usa a través de los endpoints asíncronos. Se direcciona por su slug.
IDEl entero que identifica un producto en tiempo real, mostrado como #47 en el catálogo. Los ID son lo que acepta product_ids.
slugLa cadena que identifica un producto masivo, por ejemplo waValid. Los slugs son lo que acepta el campo product.
modorealtime o async. Un producto pertenece exactamente a uno, y el modo decide qué endpoints lo aceptan.
TérminoSignificado
registradoLo que la detección responde en realidad: ¿está este identificador registrado en esta plataforma? No es una afirmación sobre si el número o la dirección es sintácticamente válido, alcanzable o está en servicio.
validConfirmado como registrado. Cobrado.
invalidConfirmado como no registrado. Cobrado — una respuesta negativa sigue siendo una respuesta.
unknownEl proveedor no pudo resolverlo. No cobrado; reembolsado.
en cachéEl veredicto se sirvió desde un dato almacenado en lugar de preguntar a un proveedor. Un acierto de caché igualmente se cobra.
combinaciónUna solicitud en tiempo real, un identificador y los de uno a diez productos contra los que se comprobó. Una combinación puede tener éxito parcial — consulta partial_succeeded.
TérminoSignificado
reservarTomar el importe por adelantado antes de que se ejecute el trabajo. Todo envío se reserva contra el saldo de la cuenta.
liquidarDecidir el cobro final de un elemento individual una vez conocido su veredicto.
reembolsarDevolver el importe reservado de un elemento que no produjo ningún veredicto utilizable.
billing_statusCampo por elemento: charged o refunded. Lee esto en lugar de inferirlo del estado HTTP.
total_reservedReservado antes de que se ejecutara el trabajo. Siempre es igual a total_charged + total_refunded.
charged_amountCobro neto. refunded_amount es el reembolso neto.
TérminoSignificado
request_idUUID que identifica un envío en tiempo real. Cítalo en las solicitudes de soporte.
task_idEl token que identifica un envío masivo, devuelto al enviar. También es el parámetro de ruta {token} de los endpoints de tarea — un valor, dos nombres en la documentación.
Idempotency-KeyUn encabezado que aporta quien llama, obligatorio en las llamadas en tiempo real, que hace seguro un reintento: la misma clave con el mismo cuerpo devuelve el resultado almacenado en lugar de cobrar de nuevo.
repetidoLa respuesta provino de un resultado almacenado y no de trabajo nuevo. replayed en una respuesta en tiempo real, idempotent_replay en un envío masivo. Una repetición nunca mueve dinero.
recovery_pendingLa tarea masiva está en cola, pero su contabilidad todavía se está conciliando.
TérminoSignificado
submittedFilas que enviaste.
prefilteredFilas descartadas antes de la detección — líneas mal formadas, por ejemplo.
dedupedFilas duplicadas eliminadas.
totalFilas realmente comprobadas: submitted menos prefiltered menos deduped.
processedFilas que el canal de origen ha terminado hasta ahora.
unknown_unprocessedFilas que nunca se resolvieron. Estas son las que se reembolsan.
TérminoSignificado
límite por claveEl presupuesto asociado a tu clave API. Este es el que hay que tener en cuenta al planificar.
límite por IPUn techo más grueso compartido por todas las claves detrás de una misma dirección. No es un control de acceso.
retenciónCuánto tiempo sobrevive un registro. Registros en tiempo real y resultados de repetición: 30 días. Archivos de resultados masivos: 7 días.