FastPVA
REST API · 完整文档

开发者 API

通过标准 REST API 将接码功能集成到任意平台。支持批量操作,文档完整,SDK 丰富。

推荐接入路径

先完成一次完整的取号流程

第 1 步用于查询项目 ID,已有 pid 时可跳过;之后按从左到右的顺序完成选渠道、取号和获取验证码,最后一步仅在不再需要号码时使用。

http://api.fastpva.com/pvapublic
  1. 01

    可选:查询项目 ID

    用于取得 pid;已有 pid 时可跳过。

  2. 02

    选择渠道

    按 pid 和国家代码取得 channelId。

  3. 03

    获取号码

    提交选择并保存返回的 orderId。

  4. 04

    轮询取码

    用 orderId 查询验证码。

  5. 05

    释放号码

    不再接收短信时释放订单。

按步骤阅读接口

展开当前步骤,再看它需要什么

先了解这一调用的作用,再查看对应参数说明;无需一次阅读所有接口细节。

可选:获取统一项目列表,用于查询项目 ID(pid)

步骤 01
本次调用的参数
参数描述示例
page页码。1
limit每页返回数量。20
keyword?可选搜索词。telegram

可选:该接口主要用于查询项目 ID(pid)。page=1 为页码;limit=20 为每页数量;keyword=telegram 为可选搜索词。

代码示例

示例已按完整取号与轮询流程排列,可直接从这里开始集成。

响应示例

先对照成功结果,异常或异步状态时再查看对应的返回示例。

GET /getNumber — 成功取号
{
  "code": 1,
  "data": {
    "orderId": "6a4497df5e1f4a5bf82681b1",
    "number": "79161234567"
  }
}
GET /sms/codes — 成功取码
{
  "code": 1,
  "data": {
    "orders": {
      "6a4497df5e1f4a5bf82681b1": {
        "number": "79161234567",
        "code": "84291",
        "content": "Telegram code 84291"
      },
      "6a4497bf50769b5bcf9e61f9": {
        "number": "221771234567",
        "code": "518204",
        "content": "Your verification code is 518204"
      }
    },
    "balance": 99.50
  }
}
GET /getNumber — 失败示例
{
  "code": -1,
  "data": "Insufficient balance, please recharge."
}
GET /getNumber — 异步处理中
{
  "code": 2,
  "data": "The number is getting..."
}
GET /sms/codes — 失败示例
{
  "code": -1,
  "data": "Not found orderId"
}

获取 API Key

注册账号后即可在控制台生成 API Key,立即开始集成。