SMSPVAdevelopers
Activation V2
SMSPVA / API REFERENCE

Borrar SMS

Borra el SMS actual para recibir otro.

SMSPVA API
PUThttps://api.smspva.com/activation/clearsms/{orderid}

Esta solicitud puede modificar un pedido o generar cargos. Los ejemplos no la repiten automáticamente. Leer un SMS recién recibido puede generar el cobro, aunque el método use GET.

Autenticación

NombreUbicaciónTipoObligatorioDescripción
apikeyheaderstringSíTu clave API

Parámetros

NombreUbicaciónTipoObligatorioDescripción
orderidpathintegerSíID del pedido

No requiere cuerpo de solicitud.

Cómo usar este método

Borra el SMS actual para recibir otro en el mismo pedido. Conserva el orderExpireIn devuelto. HTTP 404 con NO_SMS_TO_CLEAN no confirma que se haya borrado un SMS.

Ejemplos de solicitud

Requisitos y configuración del entorno. cURL usa un shell POSIX. El ejemplo JavaScript también es válido en TypeScript sobre Node.js. Java utiliza el cliente estándar y muestra JSON sin analizar; usa la biblioteca JSON de tu aplicación.

  • SMSPVA_ORDER_ID: orderid (obligatorio).
: "${SMSPVA_API_KEY:?Set SMSPVA_API_KEY}"
: "${SMSPVA_ORDER_ID:?Set SMSPVA_ORDER_ID to your orderid}"
curl --fail-with-body --max-time 30 --request PUT \
  --url "https://api.smspva.com/activation/clearsms/${SMSPVA_ORDER_ID}" \
  --header "apikey: $SMSPVA_API_KEY"

Respuestas

Los ejemplos muestran el formato de respuesta. Los precios, las cantidades y los datos de cuenta son orientativos; consulta la API para obtener valores actuales.

HTTPDescripción
200Operación completada
404No se ha recibido un SMS, o hay uno pendiente de pago.
405Parámetros no válidos
406No se encontró el pedido.
501El servidor no pudo procesar la solicitud.
503No se ha recibido un SMS, o hay uno pendiente de pago.
HTTP 200

Operación completada

Respuesta ilustrativa

{
  "statusCode": 200,
  "data": {
    "orderId": 123456,
    "orderExpireIn": 599
  }
}

Campos de respuesta

NombreTipoDescripción
statusCodeintegerCódigo de estado del resultado
dataobjectDatos de respuesta
data.orderIdintegerID del pedido
data.orderExpireInintegerTiempo hasta el vencimiento, en segundos
HTTP 404

No se ha recibido un SMS, o hay uno pendiente de pago.

Respuesta ilustrativa

{
  "statusCode": 404,
  "error": {
    "type": "NO_SMS_TO_CLEAN",
    "description": "SMS not yet received or paid."
  }
}

Campos de respuesta

NombreTipoDescripción
statusCodeintegerCódigo de estado del resultado
errorobjectDetalles del error
error.typestringTipo de error
error.descriptionstringDescripción del error
HTTP 405

Parámetros no válidos

Respuesta ilustrativa

{
  "statusCode": 405,
  "error": {
    "type": "INVALID_PARAMS",
    "description": "Invalid params."
  }
}

Campos de respuesta

NombreTipoDescripción
statusCodeintegerCódigo de estado del resultado
errorobjectDetalles del error
error.typestringTipo de error
error.descriptionstringDescripción del error
HTTP 406

No se encontró el pedido.

Respuesta ilustrativa

{
  "statusCode": 406,
  "error": {
    "type": "ORDER_NOT_FOUND",
    "description": "Order not found."
  }
}

Campos de respuesta

NombreTipoDescripción
statusCodeintegerCódigo de estado del resultado
errorobjectDetalles del error
error.typestringTipo de error
error.descriptionstringDescripción del error
HTTP 501

El servidor no pudo procesar la solicitud.

Respuesta ilustrativa

{
  "statusCode": 501,
  "error": {
    "type": "SERVER_FAIL",
    "description": "Server failed to process request"
  }
}

Campos de respuesta

NombreTipoDescripción
statusCodeintegerCódigo de estado del resultado
errorobjectDatos de respuesta
error.typestringTipo de error
error.descriptionstringDescripción del error
HTTP 503

No se ha recibido un SMS, o hay uno pendiente de pago.

Respuesta ilustrativa

{
  "statusCode": 503,
  "error": {
    "type": "SERVER_BUSY",
    "description": "Server overload, try later."
  }
}

Campos de respuesta

NombreTipoDescripción
statusCodeintegerCódigo de estado del resultado
errorobjectDetalles del error
error.typestringTipo de error
error.descriptionstringDescripción del error

Guías relacionadas

Si falla la conexión al modificar un pedido, comprueba su estado antes de repetir.

En esta página