Activation V2
SMSPVA / API REFERENCE
清除短信
清除当前短信，以接收下一条。
SMSPVA API
此请求可能修改订单或产生费用。 示例不会自动重试。即使使用 GET，读取新收到的短信也可能触发计费。
身份验证
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
apikey | header | string | 是 | 你的 API 密钥 |
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
orderid | path | integer | 是 | 订单 ID |
无需请求体。
使用说明
清除当前短信，以便同一订单接收下一条。保留返回的 orderExpireIn。HTTP 404 和 NO_SMS_TO_CLEAN 不表示已成功清除短信。
请求示例
运行环境及配置. cURL 使用 POSIX shell。JavaScript 示例也可用于 Node.js TypeScript 项目。Java 使用标准 HTTP 客户端并输出原始 JSON；请使用应用的 JSON 库读取响应字段。
SMSPVA_ORDER_ID:orderid(必填).
: "${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"响应
下方示例用于说明响应格式。价格、余量和账户数据仅为示例，实际数值请以 API 响应为准。
| HTTP | 说明 |
|---|---|
| 200 | 操作成功 |
| 404 | 尚未收到短信，或有待付费短信。 |
| 405 | 参数不正确 |
| 406 | 未找到订单。 |
| 501 | 服务器未能处理请求。 |
| 503 | 尚未收到短信，或有待付费短信。 |
HTTP 200
操作成功
响应示例
{
"statusCode": 200,
"data": {
"orderId": 123456,
"orderExpireIn": 599
}
}响应字段
| 名称 | 类型 | 说明 |
|---|---|---|
statusCode | integer | 结果状态码 |
data | object | 响应数据 |
data.orderId | integer | 订单 ID |
data.orderExpireIn | integer | 距订单到期的秒数 |
HTTP 404
尚未收到短信，或有待付费短信。
响应示例
{
"statusCode": 404,
"error": {
"type": "NO_SMS_TO_CLEAN",
"description": "SMS not yet received or paid."
}
}响应字段
| 名称 | 类型 | 说明 |
|---|---|---|
statusCode | integer | 结果状态码 |
error | object | 错误详情 |
error.type | string | 错误类型 |
error.description | string | 错误说明 |
HTTP 405
参数不正确
响应示例
{
"statusCode": 405,
"error": {
"type": "INVALID_PARAMS",
"description": "Invalid params."
}
}响应字段
| 名称 | 类型 | 说明 |
|---|---|---|
statusCode | integer | 结果状态码 |
error | object | 错误详情 |
error.type | string | 错误类型 |
error.description | string | 错误说明 |
HTTP 406
未找到订单。
响应示例
{
"statusCode": 406,
"error": {
"type": "ORDER_NOT_FOUND",
"description": "Order not found."
}
}响应字段
| 名称 | 类型 | 说明 |
|---|---|---|
statusCode | integer | 结果状态码 |
error | object | 错误详情 |
error.type | string | 错误类型 |
error.description | string | 错误说明 |
HTTP 501
服务器未能处理请求。
响应示例
{
"statusCode": 501,
"error": {
"type": "SERVER_FAIL",
"description": "Server failed to process request"
}
}响应字段
| 名称 | 类型 | 说明 |
|---|---|---|
statusCode | integer | 结果状态码 |
error | object | 响应数据 |
error.type | string | 错误类型 |
error.description | string | 错误说明 |
HTTP 503
尚未收到短信，或有待付费短信。
响应示例
{
"statusCode": 503,
"error": {
"type": "SERVER_BUSY",
"description": "Server overload, try later."
}
}响应字段
| 名称 | 类型 | 说明 |
|---|---|---|
statusCode | integer | 结果状态码 |
error | object | 错误详情 |
error.type | string | 错误类型 |
error.description | string | 错误说明 |
相关指南
修改订单的请求发生网络故障时，先检查订单状态，再决定是否重试。