SMSPVAdevelopers
Private Email Rental
SMSPVA / DOCUMENTATION

有效订单

GET /api/rent_email.php?method=get_orders

SMSPVA API
GEThttps://smspva.com/api/rent_email.php?method=get_orders

发送 GET 请求后,即使 HTTP 为 200,也请检查 status:1 成功,0 失败,创建租赁时的 2 表示暂无邮箱。错误详情可能在 msg、errormsg 和 errorid 中。

身份验证

apikey 为必填查询参数。

参数

名称位置类型必填示例说明
apikeyquerystring是SMSPVA_API_KEY账户 API 密钥。读取邮件及管理租赁需要使用订单所属账户的密钥。
methodquerystring是"get_orders"要调用的方法。

使用说明

查看有效邮箱租赁、邮件数量和可用别名。此响应的邮箱地址字段为 address,而创建租赁中叫 email。

用订单 ID 读取邮件或延期。Gmail 订单可能包含 aliases[].id,可用于购买别名访问权;Outlook 不支持别名。已结束的租赁见归档订单。

请求示例

运行环境及依赖. 示例会对查询参数编码,最多等待 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_email.php" \
  --data-urlencode "method=get_orders" \
  --data-urlencode "apikey=$SMSPVA_API_KEY"

响应

请查看与你的请求对应的响应。数值和日期仅供示例;可选字段可能因结果或所选响应格式而不同。

HTTP 200

HTTP 为 200 时仍需检查 status;示例数值仅供参考。

application/json

成功响应示例

{
  "status": 1,
  "data": [
    {
      "id": 123456,
      "address": "[email protected]",
      "scode": "twitter",
      "pcode": "outlookcom",
      "expireDate": 1855324800,
      "mesCount": 1,
      "aliases": [],
      "sname": "Twitter"
    },
    {
      "id": 123457,
      "address": "[email protected]",
      "scode": "twitter",
      "pcode": "gmailcom",
      "expireDate": 1855324800,
      "mesCount": 0,
      "aliases": [
        {
          "id": 88,
          "address": "[email protected]",
          "mesCount": 1,
          "isPaid": false
        }
      ],
      "sname": "Twitter"
    }
  ]
}

错误

{
  "status": 0,
  "msg": "Incorrect apikey"
}

成功

名称类型说明
statusinteger(enum: [1])
dataarray<object>
data[].idinteger订单 ID。
data[].addressstring邮箱地址,在 create_order 响应中此字段名为 email。
data[].scodestring服务代码。
data[].pcodestring供应商代码。
data[].expireDateinteger租赁到期时间,Unix 时间戳,单位为秒。
data[].mesCountinteger邮件数量。
data[].aliasesarray<object>
data[].aliases[].idinteger已有别名 ID,作为 aliasid 传入。
data[].aliases[].addressstring别名邮箱地址。
data[].aliases[].mesCountinteger该别名的邮件数量。
data[].aliases[].isPaidboolean该别名的访问权是否已付费。
data[].snamestring服务显示名称。

必填: status, data

错误

部分错误含 errorid 和 errormsg,其他错误仅有 msg。请检查响应中提供的全部错误字段。

名称类型说明
statusinteger(enum: [0])
erroridinteger可选的结构化错误代码。
errormsgstring可选的错误说明。
msgstring错误信息。

相关指南

本页内容