Modificar estado de alquiler
El método setRentStatus se utiliza para cambiar el estado actual de un número virtual alquilado mediante 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 de alquiler, incluyendo los parámetros de alquiler actualizados. Este método es especialmente útil en servicios donde se necesita una rápida actualización de la información sobre el uso de números alquilados.
Ejemplo de solicitud:
Datos de entrada
Parámetro | Requerido | Nota | Descripción |
---|---|---|---|
Sí | Ver en el perfil en la configuración Clave API | La clave API proporciona acceso a servicios pagos | |
Sí | setRentStatus | Nombre del método | |
Sí | Valor numérico | ID de activación, obtenido al solicitar el número | |
Sí | Valor numérico | Estado del alquiler |
El estado puede tomar los siguientes valores:
1 - Finalizar uso del número
2 - Cancelar compra
Respuesta del servidor
{ "status": "success" }
Ejemplo de código
const api_key = "API_KEY"; # Reemplaza 'API_KEY' con tu clave API real.const id = 1; # Inserta el ID de activación obtenido al solicitar el númeroconst status = 1; # Inserta el nuevo estado de la tabla anteriortry {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 especificadaconst data = await response.json();# Mostramos el contenido de la respuesta del servidorconsole.log(data);} catch (err) {# Si ocurre un error, mostramos un mensaje de errorconsole.error(err);}
Errores posibles
Parámetro | Descripción |
---|---|
Acción incorrecta | |
Clave API incorrecta | |
Error en la consulta | |
Tiempo por el cual la cuenta está bloqueada | |
Cuenta no activa | |
ID de alquiler no especificado | |
Número alquilado no por ti (ID de alquiler incorrecto) | |
Falta o estado indicado incorrectamente | |
No se puede cancelar el alquiler (más de 20 min.) | |
Alquiler ya finalizado | |
Alquiler ya cancelado |