Clear SMS

This request can change an order or incur charges. The examples do not retry it automatically. Reading a newly received SMS can trigger payment, even though the method uses GET.

AuthenticationCopy Anchor Link

ParametersCopy Anchor Link

No request body is required.

How to use this methodCopy Anchor Link

Clear the current SMS so the order can receive another one. Keep the returned orderExpireIn. HTTP 404 with NO_SMS_TO_CLEAN does not confirm that an SMS was cleared.

Request examplesCopy Anchor Link

Runtime requirements and environment setup. cURL uses a POSIX shell. JavaScript and TypeScript run in Node.js. Java uses the standard HTTP client and prints raw JSON; use your application’s JSON library to inspect the body.

• SMSPVA_ORDER_ID: orderid (required).

: "${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"

ResponsesCopy Anchor Link

The examples below show the response format. Prices, stock and account values are sample data; use the API response for current values.

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

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

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

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

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

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

Related guidesCopy Anchor Link

• Activation V2
• Reference data
• Activation workflow
• Errors and limits
• Download OpenAPI

If a connection fails during an order-changing request, check the order before trying again.