FAQAPI

Obtener el estado del alquiler del número

El método getRentStatus se utiliza para obtener el estado actual del número virtual alquilado a través de la API de SMS.online. Permite automatizar el proceso de verificación del estado del alquiler y seguir los códigos SMS recibidos en el número alquilado.

Este método está diseñado para sistemas que requieren un monitoreo regular del número alquilado, para recibir a tiempo los códigos de confirmación y otros datos que llegan durante el período de alquiler.

Una solicitud exitosa devuelve un objeto con información sobre el estado actual del alquiler, incluyendo el identificador único del alquiler, la lista de códigos SMS recibidos y el tiempo de finalización del alquiler. Esto permite controlar de manera efectiva el uso del número y la recepción de mensajes en tiempo real.

Ejemplo de solicitud:

Datos de entrada

ParámetroRequeridoNotaDescripción
SíVer en el perfil en la configuración Clave APILa clave API proporciona acceso a servicios pagados
SígetRentStatusNombre del método
SíValor numéricoID de activación, obtenido al solicitar el número
NoValor numéricoNúmero de página desde la que comienza la selección (la numeración de páginas comienza en 0, de nuevas a viejas; por defecto 0)
NoValor numéricoNúmero de páginas solicitadas (por defecto 10)

Respuesta del servidor

JSON
{
  "status": "success", 
  "quantity": "2", 
  "values": { 
    "0": { 
      "phoneFrom": "79180230628", 
      "text": "5", 
      "service": "ot", 
      "date": "2020-01-30 14:31:58" 
    }, 
    "1": { 
      "phoneFrom": "79180230628", 
      "text": "4", 
      "service": "ot", 
      "date": "2025-05-30 14:04:16" 
    } 
  } 
}

Ejemplo de código

const api_key = "API_KEY"; # Reemplace 'API_KEY' con su clave API real.
const id = 1; # Inserte el ID de activación obtenido al solicitar el número
try {
const response = await fetch(`https://api.sms.onlinestubs/handler_api.php?api_key=${api_key}&action=getRentStatus&id=${id}`);
# Realizamos una solicitud GET a la URL especificada
const data = await response.json();
# Mostramos el contenido de la respuesta del servidor
console.log(data);
} catch (err) {
# Si ocurrió un error, mostramos un mensaje de error
console.error(err);
}

Posibles errores

ParámetroDescripción
Acción incorrecta
Clave API incorrecta
Error en la consulta
Tiempo por el cual la cuenta está bloqueada
Cuenta inactiva
ID de alquiler no especificado
Número alquilado no por usted (ID de alquiler incorrecto)
Alquiler pagado y finalizado
Alquiler cancelado con reembolso
Esperando el primer SMS
Número bloqueado, se han devuelto los fondos