SMSPVAdevelopers
Private Email Rental
SMSPVA / DOCUMENTATION

别名邮件

GET /api/rent_email.php?method=get_mails_by_alias

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

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

身份验证

apikey 为必填查询参数。

参数

名称位置类型必填示例说明
apikeyquerystring是SMSPVA_API_KEY账户 API 密钥。读取邮件及管理租赁需要使用订单所属账户的密钥。
methodquerystring是"get_mails_by_alias"要调用的方法。
orderidqueryinteger是123456按所调用方法,从 Create Order、Active Orders 或 Archived Orders 获取订单 ID。
aliasidqueryinteger是88Active Orders 的 aliases 中已有的别名 ID;orderid 必须是父订单 ID。
tqueryinteger否50每页返回条数。
squeryinteger否0分页偏移量。
sqquerystring否"verification"搜索文本,需要 URL 编码。

使用说明

读取已有 Gmail 别名的邮件。两个 ID 都取自有效订单:orderid 是父租赁订单 ID,aliasid 是别名 ID。请先购买访问权。

t、s、sq 与邮件列表用法相同。读取正文时,将父订单 orderid 和邮件 ID(作为 emailid)传给邮件正文。

请求示例

运行环境及依赖. 示例会对查询参数编码,最多等待 30 秒。使用 data 前请检查 HTTP 和 JSON status。cURL 输出原始响应供你检查,Java 使用 Jackson 读取 JSON。

  • SMSPVA_EMAIL_ORDER_ID: orderid.
  • SMSPVA_EMAIL_ALIAS_ID: aliasid.
: "${SMSPVA_API_KEY:?Set SMSPVA_API_KEY}"
: "${SMSPVA_EMAIL_ORDER_ID:?Set SMSPVA_EMAIL_ORDER_ID}"
: "${SMSPVA_EMAIL_ALIAS_ID:?Set SMSPVA_EMAIL_ALIAS_ID}"
curl --get --fail-with-body --max-time 30 "https://smspva.com/api/rent_email.php" \
  --data-urlencode "method=get_mails_by_alias" \
  --data-urlencode "apikey=$SMSPVA_API_KEY" \
  --data-urlencode "orderid=$SMSPVA_EMAIL_ORDER_ID" \
  --data-urlencode "aliasid=$SMSPVA_EMAIL_ALIAS_ID" \
  --data-urlencode "t=${SMSPVA_EMAIL_T:-50}" \
  --data-urlencode "s=${SMSPVA_EMAIL_S:-0}" \
  --data-urlencode "sq=${SMSPVA_EMAIL_SQ:-verification}"

响应

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

HTTP 200

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

application/json

成功响应示例

{
  "status": 1,
  "data": [
    {
      "id": 6,
      "sender": "[email protected]",
      "subject": "Verification code",
      "preview": "Your code: 12345",
      "addedAt": "2026-10-22T10:00:00.000Z"
    }
  ]
}

错误

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

Empty result

{
  "status": 1,
  "data": []
}

成功

名称类型说明
statusinteger(enum: [1])
dataarray<object>
data[].idinteger邮件 ID,作为 emailid 传给 get_mail_body。
data[].senderstring发件人地址。
data[].subjectstring邮件主题。
data[].previewstring邮件预览。
data[].addedAtstring邮件时间。 (format: "date-time")

必填: status, data

错误

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

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

相关指南

本页内容