Rental API
SMSPVA / DOCUMENTATION
租赁历史
GET /api/rent.php?method=get_rent_history
SMSPVA API
发送 GET 请求后,检查 JSON 中的 status:1 成功,0 失败,即使 HTTP 为 200 也一样。失败原因见 msg。
身份验证
apikey 为必填查询参数。
参数
| 名称 | 位置 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|---|
method | query | string | 是 | "get_rent_history" | 方法名称 |
apikey | query | string | 是 | SMSPVA_API_KEY | 你的 API 密钥 可在网站右上角菜单的 Profile and APIKEY 中找到。 |
skip | query | integer | 否 | 0 | 跳过的条目数 |
take | query | integer | 否 | 10 | 返回条目数 |
使用说明
查看已结束的租赁,用 isAvailForRestore 判断能否恢复。符合条件时,请先查询费用和时长,再恢复租赁。
请求示例
运行环境及依赖. 示例会对查询参数编码,最多等待 30 秒。使用 data 前请检查 HTTP 和 JSON status。cURL 输出原始响应供你检查,Java 使用 Jackson 读取 JSON。
: "${SMSPVA_API_KEY:?Set SMSPVA_API_KEY}"
curl --get --fail-with-body --max-time 30 "https://smspva.com/api/rent.php" \
--data-urlencode "method=get_rent_history" \
--data-urlencode "apikey=$SMSPVA_API_KEY" \
--data-urlencode "skip=0" \
--data-urlencode "take=10"响应
请查看与你的请求对应的响应。数值和日期仅供示例;可选字段可能因结果或所选响应格式而不同。
HTTP 200
Success
application/json
响应示例
{
"status": 1,
"data": [
{
"orderId": 857191,
"resourceCode": "opt9",
"number": "37067787324",
"branchId": 684,
"haveSms": false,
"isAvailForRestore": true,
"days": 30,
"country": "LT",
"begin": 1768902473,
"end": 1771494473,
"closed": 1768903921
}
]
}| 名称 | 类型 | 说明 |
|---|---|---|
status | integer | 响应状态:1 成功,0 失败。 |
data | array<object> | |
data[].orderId | integer | 订单 ID |
data[].resourceCode | string | 服务代码 服务列表 |
data[].number | string | 租赁号码,含国家区号,不带 +。 |
data[].branchId | integer | 订单内部业务分支 ID |
data[].haveSms | boolean | 租赁期间该号码是否收到过短信。 |
data[].isAvailForRestore | boolean | 是否可以恢复;为 true 时,可用 Restore 以新号码恢复租赁。 |
data[].days | integer | 订单原租赁天数 |
data[].country | string | 号码所属国家代码。 国家列表 |
data[].begin | integer | 开始时间(Unix 时间戳) |
data[].end | integer | 结束时间(Unix 时间戳) |
data[].closed | integer | 关闭时间(Unix 时间戳) |