Pedidos archivados
GET /api/rent_email.php?method=get_archived_orders
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.
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í | "get_archived_orders" | Método que se va a ejecutar. |
Cómo usar este método
Consulta los alquileres archivados. Antes de restaurar uno, envía su id a Coste de restauración para comprobar el precio actual; después usa Restaurar 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_API_KEY:?Set SMSPVA_API_KEY}"
curl --get --fail-with-body --max-time 30 "https://smspva.com/api/rent_email.php" \
--data-urlencode "method=get_archived_orders" \
--data-urlencode "apikey=$SMSPVA_API_KEY"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,
"address": "[email protected]",
"scode": "twitter",
"pcode": "outlookcom",
"expireDate": 1767225600,
"sname": "Twitter"
}
]
}Error
{
"status": 0,
"msg": "Incorrect apikey"
}Correcto
| Nombre | Tipo | Descripción |
|---|---|---|
status | integer | (enum: [1]) |
data | array<object> | |
data[].id | integer | ID del pedido archivado que quieres restaurar. |
data[].address | string | Dirección de correo. |
data[].scode | string | Código del servicio. |
data[].pcode | string | Código del proveedor. |
data[].expireDate | integer | Vencimiento del alquiler, como timestamp Unix en segundos. |
data[].sname | string | Nombre visible del servicio. |
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. |