SMSPVAdevelopers
Private Email Rental
SMSPVA / DOCUMENTATION

Ampliar alquiler

GET /api/rent_email.php?method=prolong_order

SMSPVA API
GEThttps://smspva.com/api/rent_email.php?method=prolong_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

NombreUbicaciónTipoObligatorioEjemploDescripción
apikeyquerystringSíSMSPVA_API_KEYClave API de la cuenta. Para leer mensajes o gestionar un alquiler, usa la clave de su propietario.
methodquerystringSí"prolong_order"Método que se va a ejecutar.
orderidqueryintegerSí123456ID de Create Order, Active Orders o Archived Orders, según el método que vayas a usar.
dtypequerystringSí"week"Unidad de alquiler: day = 1 día, week = 7 días, month = 30 días.
dcountqueryintegerSí1Número positivo de unidades de alquiler.

Cómo usar este método

Amplía un alquiler con el ID de Pedidos activos. El coste se descuenta del saldo. dcount debe ser positivo; day, week y month equivalen a 1, 7 y 30 días por unidad.

Si está configurado, el descuento del servicio se aplica a ampliaciones de al menos 30 días. Actualiza los pedidos activos después para obtener el nuevo vencimiento: esta respuesta no lo incluye.

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=prolong_order" \
  --data-urlencode "apikey=$SMSPVA_API_KEY" \
  --data-urlencode "orderid=$SMSPVA_EMAIL_ORDER_ID" \
  --data-urlencode "dtype=${SMSPVA_EMAIL_DTYPE:-week}" \
  --data-urlencode "dcount=${SMSPVA_EMAIL_DCOUNT:-1}"

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": 123456,
    "email": "[email protected]",
    "service": "Twitter"
  }
}

Error

{
  "status": 0,
  "msg": "Incorrect apikey"
}

Correcto

NombreTipoDescripción
statusinteger(enum: [1])
dataobject
data.idintegerID del pedido.
data.emailstringDirección de correo.
data.servicestringNombre 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.

NombreTipoDescripción
statusinteger(enum: [0])
erroridintegerCódigo numérico de error, si se incluye.
errormsgstringDescripción del error, si se incluye.
msgstringMensaje de error.

Guías relacionadas

En esta página