Listar mensajes
GET /api/rent_email.php?method=get_mails
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_mails" | 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. |
t | query | integer | No | 50 | Número de resultados por página. |
s | query | integer | No | 0 | Número de resultados que se omiten al paginar. |
sq | query | string | No | "verification" | Texto de búsqueda. Codifícalo para enviarlo en la URL. |
Cómo usar este método
Consulta las vistas previas de los mensajes de un alquiler tuyo. Obtén orderid en Pedidos activos. Usa t como tamaño de página, s como desplazamiento y codifica en URL el filtro opcional sq.
Para leer el mensaje completo, envía su id como emailid a Contenido del mensaje. Un array data vacío significa que la consulta funcionó, pero no encontró mensajes.
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=get_mails" \
--data-urlencode "apikey=$SMSPVA_API_KEY" \
--data-urlencode "orderid=$SMSPVA_EMAIL_ORDER_ID" \
--data-urlencode "t=${SMSPVA_EMAIL_T:-50}" \
--data-urlencode "s=${SMSPVA_EMAIL_S:-0}" \
--data-urlencode "sq=${SMSPVA_EMAIL_SQ:-verification}"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": 6,
"sender": "[email protected]",
"subject": "Verification code",
"preview": "Your code: 12345",
"addedAt": "2026-10-22T10:00:00.000Z"
}
]
}Error
{
"status": 0,
"msg": "Incorrect apikey"
}Empty result
{
"status": 1,
"data": []
}Correcto
| Nombre | Tipo | Descripción |
|---|---|---|
status | integer | (enum: [1]) |
data | array<object> | |
data[].id | integer | ID del mensaje; pásalo como emailid a get_mail_body. |
data[].sender | string | Dirección del remitente. |
data[].subject | string | Asunto del mensaje. |
data[].preview | string | Vista previa del mensaje. |
data[].addedAt | string | Fecha y hora del mensaje. (format: "date-time") |
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. |