Borrar SMS
Borra el SMS actual para recibir otro.
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
| Nombre | Ubicación | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
apikey | header | string | Sí | Tu clave API |
Parámetros
| Nombre | Ubicación | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
orderid | path | integer | Sí | 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.
| HTTP | Descripción |
|---|---|
| 200 | Operación completada |
| 404 | No se ha recibido un SMS, o hay uno pendiente de pago. |
| 405 | Parámetros no válidos |
| 406 | No se encontró el pedido. |
| 501 | El servidor no pudo procesar la solicitud. |
| 503 | No 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
| Nombre | Tipo | Descripción |
|---|---|---|
statusCode | integer | Código de estado del resultado |
data | object | Datos de respuesta |
data.orderId | integer | ID del pedido |
data.orderExpireIn | integer | Tiempo 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
| Nombre | Tipo | Descripción |
|---|---|---|
statusCode | integer | Código de estado del resultado |
error | object | Detalles del error |
error.type | string | Tipo de error |
error.description | string | Descripción del error |
HTTP 405
Parámetros no válidos
Respuesta ilustrativa
{
"statusCode": 405,
"error": {
"type": "INVALID_PARAMS",
"description": "Invalid params."
}
}Campos de respuesta
| Nombre | Tipo | Descripción |
|---|---|---|
statusCode | integer | Código de estado del resultado |
error | object | Detalles del error |
error.type | string | Tipo de error |
error.description | string | Descripció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
| Nombre | Tipo | Descripción |
|---|---|---|
statusCode | integer | Código de estado del resultado |
error | object | Detalles del error |
error.type | string | Tipo de error |
error.description | string | Descripció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
| Nombre | Tipo | Descripción |
|---|---|---|
statusCode | integer | Código de estado del resultado |
error | object | Datos de respuesta |
error.type | string | Tipo de error |
error.description | string | Descripció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
| Nombre | Tipo | Descripción |
|---|---|---|
statusCode | integer | Código de estado del resultado |
error | object | Detalles del error |
error.type | string | Tipo de error |
error.description | string | Descripción del error |
Guías relacionadas
Si falla la conexión al modificar un pedido, comprueba su estado antes de repetir.