Restaurar alquiler
GET /api/rent_email.php?method=restore_order
Envía una solicitud GET y comprueba status incluso con HTTP 200: 1 indica éxito, 0 fallo y 2 que no había buzones al crear el alquiler. Consulta los detalles en msg, errormsg y errorid.
Esta solicitud puede modificar un alquiler o generar cargos. Si pierdes la respuesta, comprueba los pedidos y el historial antes de repetir: el cambio puede haberse realizado. Los ejemplos no reintentan automáticamente.
Autenticación
Envía apikey como parámetro obligatorio de consulta.
Parámetros
| Nombre | Ubicación | Tipo | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|---|
apikey | query | string | Sí | SMSPVA_API_KEY | Clave API de la cuenta. Para leer mensajes o gestionar un alquiler, usa la clave de su propietario. |
method | query | string | Sí | "restore_order" | Método que se va a ejecutar. |
orderid | query | integer | Sí | 123456 | ID de Create Order, Active Orders o Archived Orders, según el método que vayas a usar. |
Cómo usar este método
Restaura un alquiler archivado. Obtén el ID en Pedidos archivados y consulta antes el coste; esta solicitud lo descuenta del saldo.
No se puede elegir una duración personalizada de restauración. Al terminar, actualiza Pedidos activos para ver los datos del alquiler.
Ejemplos de solicitud
Entorno y dependencias. Los ejemplos codifican los parámetros y esperan hasta 30 segundos. Comprueba HTTP y status antes de usar data. cURL muestra el JSON para que lo revises; Java usa Jackson para leerlo.
SMSPVA_EMAIL_ORDER_ID:orderid.
: "${SMSPVA_API_KEY:?Set SMSPVA_API_KEY}"
: "${SMSPVA_EMAIL_ORDER_ID:?Set SMSPVA_EMAIL_ORDER_ID}"
curl --get --fail-with-body --max-time 30 "https://smspva.com/api/rent_email.php" \
--data-urlencode "method=restore_order" \
--data-urlencode "apikey=$SMSPVA_API_KEY" \
--data-urlencode "orderid=$SMSPVA_EMAIL_ORDER_ID"Respuestas
Consulta la respuesta correspondiente a tu solicitud. Los valores y las fechas son orientativos. Los campos opcionales pueden variar según el resultado o el formato elegido.
HTTP 200
Comprueba status aunque HTTP sea 200. Los valores de los ejemplos son orientativos.
application/json
Ejemplo de respuesta correcta
{
"status": 1,
"data": {
"id": 123455,
"email": "[email protected]",
"service": "Twitter"
}
}Error
{
"status": 0,
"msg": "Incorrect apikey"
}Correcto
| Nombre | Tipo | Descripción |
|---|---|---|
status | integer | (enum: [1]) |
data | object | |
data.id | integer | ID del pedido. |
data.email | string | Dirección de correo. |
data.service | string | Nombre visible del servicio, distinto de su código. |
Obligatorios: status, data
Error
Algunos errores incluyen errorid y errormsg; otros solo msg. Comprueba todos los campos presentes.
| Nombre | Tipo | Descripción |
|---|---|---|
status | integer | (enum: [0]) |
errorid | integer | Código numérico de error, si se incluye. |
errormsg | string | Descripción del error, si se incluye. |
msg | string | Mensaje de error. |