Cambiar el estado de alquiler

El método setRentStatus se utiliza para cambiar el estado actual de un número virtual alquilado a través de la API de SMS.online. Este método permite automatizar la gestión de los estados de alquiler, incluyendo la finalización del uso del número, la extensión del período de alquiler o su liberación.

El método está diseñado para sistemas que requieren un control en tiempo real del estado de los números alquilados. Con él, se pueden indicar la finalización del alquiler, la extensión u otros cambios de estado, manteniendo la información actualizada.

Una solicitud exitosa devuelve un objeto con la confirmación del cambio de estado del alquiler, incluyendo los parámetros actualizados del alquiler. Este método es especialmente útil en servicios donde se requiere una rápida actualización de la información sobre el uso de números alquilados.

Ejemplo de solicitud:

Datos de entrada

ParámetroRequeridoNotaDescripción
Ver en el perfil en la configuración Clave APILa clave API proporciona acceso a servicios pagados
setRentStatusNombre del método
Valor numéricoID de activación, obtenido al solicitar el número
Valor numéricoEstado del alquiler

El estado puede tomar los siguientes valores:

1 - Finalizar el uso del número

2 - Cancelar la compra

Respuesta del servidor

JSON
{ 
  "status": "success"
}

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
const status = 1; # Inserte el nuevo estado de la tabla anterior
try {
const response = await fetch(`https://api.sms.onlinestubs/handler_api.php?api_key=${api_key}&action=setRentStatus&id=${id}&status=${status}`);
# 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)
Falta o estado especificado incorrectamente
No se puede cancelar el alquiler (más de 20 min.)
El alquiler ya ha finalizado
El alquiler ya ha sido cancelado