SMSPVAdevelopers
Activation V2
SMSPVA / API REFERENCE

取消订单

取消激活订单。

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

此请求可能修改订单或产生费用。 示例不会自动重试。即使使用 GET,读取新收到的短信也可能触发计费。

身份验证

名称位置类型必填说明
apikeyheaderstring是你的 API 密钥

参数

名称位置类型必填说明
orderidpathinteger是订单 ID

无需请求体。

使用说明

取消 orderid 指定的激活订单。请根据响应确认是否已取消。

请求示例

运行环境及配置. 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/cancelorder/${SMSPVA_ORDER_ID}" \
  --header "apikey: $SMSPVA_API_KEY"

响应

下方示例用于说明响应格式。价格、余量和账户数据仅为示例,实际数值请以 API 响应为准。

HTTP说明
200操作成功
405参数不正确
406订单 ID 格式不正确或未找到。
411karma 过低或请求过于频繁,API 访问受限。
501服务器未能处理请求。
503服务器负载过高,请稍后再试。
HTTP 200

操作成功

响应示例

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

响应字段

名称类型说明
statusCodeinteger结果状态码
dataobject响应数据
data.orderIdinteger订单 ID
HTTP 405

参数不正确

响应示例

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

响应字段

名称类型说明
statusCodeinteger结果状态码
errorobject错误详情
error.typestring错误类型
error.descriptionstring错误说明
HTTP 406

订单 ID 格式不正确或未找到。

响应示例

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

响应字段

名称类型说明
statusCodeinteger结果状态码
errorobject错误详情
error.typestring错误类型
error.descriptionstring错误说明
HTTP 411

karma 过低或请求过于频繁,API 访问受限。

响应示例

{
  "statusCode": 411,
  "error": {
    "type": "ACCESS_LIMITED",
    "description": "Access is temporary limited."
  }
}

响应字段

名称类型说明
statusCodeinteger结果状态码
errorobject错误详情
error.typestring错误类型
error.descriptionstring错误说明
HTTP 501

服务器未能处理请求。

响应示例

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

响应字段

名称类型说明
statusCodeinteger结果状态码
errorobject错误详情
error.typestring错误类型
error.descriptionstring错误说明
HTTP 503

服务器负载过高,请稍后再试。

响应示例

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

响应字段

名称类型说明
statusCodeinteger结果状态码
errorobject错误详情
error.typestring错误类型
error.descriptionstring错误说明

相关指南

修改订单的请求发生网络故障时,先检查订单状态,再决定是否重试。

本页内容